Application: gvSIG desktop » gvSIG raster

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 */

package org.gvsig.raster.impl.datastruct;

import java.io.File;

import java.net.URI;

import java.net.URISyntaxException;

import java.util.ArrayList;

import java.util.List;

import org.gvsig.fmap.dal.coverage.dataset.Buffer;

import org.gvsig.fmap.dal.coverage.datastruct.DatasetBand;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.dynobject.DynStruct;

import org.gvsig.tools.persistence.PersistenceManager;

import org.gvsig.tools.persistence.PersistentState;

import org.gvsig.tools.persistence.exception.PersistenceException;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

/**

 * Clase que representa a una banda de un fichero.

 * @author Nacho Brodin (nachobrodin@gmail.com)

 */

public class DatasetBandImpl implements DatasetBand {

        public static final String     PERSISTENT_NAME         = "DatasetBand_Persistent";

    public static final String     PERSISTENT_DESCRIPTION  = "DatasetBand Persistent";

    private final Logger           logger                  = LoggerFactory.getLogger(DatasetBandImpl.class);

        //Nombre del fichero al que pertenece la banda

        private String                            fileName                = "";

        //Lista de nombre de otros ficheros que forman la banda. Esto es util para CompositeDataset que est? compuesto por un mosaico de ficheros.

        private List<String>               additionalName          = new ArrayList<String>();

        //Posici?n en el fichero de la  banda

        private int                            position                = -1;

        //Tipo de dato de la banda

        private int                            dataType                = Buffer.TYPE_BYTE;

        //lista de bandas del buffer donde se dibuja esta banda de imagen. Cada elemento

        //del vector es un n?mero que corresponde con el n?mero de banda del buffer donde se escribe esta

        private int[]                           rasterBufBandToDrawList = null;

        //

        private int                    nBandsInThisProvider    = 0;

        /**

         * Constructor

         */

        public DatasetBandImpl() {

        }

        /**

         * Creates a new <code>DatasetBand</code>

         * @param fileName

         *                         File name

         * @param position

         *                         Position of this band inside the provider

         * @param dataType

         *                         Data type

         * @param nBands

         *                         Number of bands of the provider

         */

        public DatasetBandImpl(String fileName, int position, int dataType, int nBands){

                setFileName(fileName);

                setPosition(position);

                setDataType(dataType);

                nBandsInThisProvider = nBands;

        }

           /**

     * Creates a new <code>DatasetBand</code>

     * @param uri

     *          URI

     * @param position

     *          Position of this band inside the provider

     * @param dataType

     *          Data type

     * @param nBands

     *          Number of bands of the provider

     */

    public DatasetBandImpl(URI uri, int position, int dataType, int nBands){

        setFileName(uri.getPath());

        setPosition(position);

        setDataType(dataType);

        nBandsInThisProvider = nBands;

    }

        /*

         *  (non-Javadoc)

         * @see java.lang.Object#clone()

         */

        public Object clone() {

                DatasetBandImpl result = new DatasetBandImpl(fileName, position, dataType, nBandsInThisProvider);

                if(rasterBufBandToDrawList != null) {

                        int[] drawBands = new int[rasterBufBandToDrawList.length];

                        for (int i = 0; i < rasterBufBandToDrawList.length; i++)

                                drawBands[i] = rasterBufBandToDrawList[i];

                        result.rasterBufBandToDrawList = drawBands;

                }

                return result;

        }

        /**

         * Resetea la asignaci?n de dibujado de las bandas de la imagen

         * sobre el DataImage cuando se hace un update para esta banda.

         */

        public void clearDrawableBands(){

                rasterBufBandToDrawList = null;

        }

        //******************************

        //Setters and Getters

        //******************************

        /**

         * Obtiene las banda del RasterBuf sobre la que se pinta

         * este objeto banda

         * @return bandas del RasterBuf

         */

        public int[] getBufferBandListToDraw() {

                return rasterBufBandToDrawList;

        }

        /**

         * Obtiene las banda del RasterBuf sobre la que se pinta

         * este objeto banda

         * @return bandas del RasterBuf

         */

        public int[] getLocalBufferBandListToDraw() {

                return rasterBufBandToDrawList;

        }

        /**

         * Dice si la banda se est? dibujando en el buffers de salida.

         * @return true si la banda se est? dibujando y false si no se est? haciendo

         */

        public boolean isDrawing(){

                if(this.rasterBufBandToDrawList == null)

                        return false;

                return true;

        }

        /**

         * Adds a band of the output buffer where the input band is drawn. <code>rasterBufBandToDraw</code>

         * is the number of band of the output buffer. This number is added to the list of numbers.

         * @param rasterBufBandToDraw number of band of the <code>Buffer</code>

         */

        public void addPositionToDrawInBuffer(int rasterBufBandToDraw) {

                if (rasterBufBandToDrawList == null) {

                        rasterBufBandToDrawList = new int[1];

                        rasterBufBandToDrawList[0] = rasterBufBandToDraw;

                } else {

                        int[] auxList = new int[rasterBufBandToDrawList.length + 1];

                        for (int i = 0; i < rasterBufBandToDrawList.length; i++)

                                auxList[i] = rasterBufBandToDrawList[i];

                        auxList[rasterBufBandToDrawList.length] = rasterBufBandToDraw;

                        rasterBufBandToDrawList = auxList;

                }

        }

        /**

         * Obtiene el nombre del fichero al que pertenece la banda

         * @return String con el nombre del fichero al

         * que pertenece la banda

         */

        public String getFileName() {

                return fileName;

        }

        /**

         * Asigna el nombre del fichero al que pertenece la banda

         * @param fileName String con el nombre del fichero al

         * que pertenece la banda

         */

        public void setFileName(String fileName) {

                this.fileName = fileName;

        }

        /**

         * Obtiene la posici?n de la banda en el fichero

         * @return entero con la posici?n de la banda en el fichero

         */

        public int getPosition() {

                return position;

        }

        /**

         * Asigna la posici?n de la banda en el fichero

         * @param position Posici?n de la banda en el fichero

         */

        public void setPosition(int position) {

                this.position = position;

        }

        /**

         * Obtiene el tipo de dato de la banda

         * @return entero con el tipo de dato

         */

        public int getDataType() {

                return dataType;

        }

        /**

         * Asigna el tipo de dato de la banda

         * @param datatype entero con el tipo de dato de la banda

         */

        public void setDataType(int dataType) {

                this.dataType = dataType;

        }

        /**

         * Asigna un nombre de fichero adicional al principal. Esto es util para

         * mosaicos de raster donde una banda est? compuesta por multiples ficheros.

         */

        public void setAdditionalName(String fileName) {

                additionalName.add(fileName);

        }

        /**

         * Obtiene la lista de nombres de fichero adicionales.

         * @return String[]

         */

        public String[] getAdditionalName() {

                return (String[]) additionalName.toArray();

        }

        @SuppressWarnings("unchecked")

        public void loadFromState(PersistentState state)

                        throws PersistenceException {

                List<String> aux = state.getList("additionalName");

                this.additionalName = new ArrayList<String>();

                this.additionalName.addAll(aux);

                try {

                        URI uri = state.getURI("fileName");

                        if(uri != null) {

                            fileName = uri.toString();

                if (uri.getScheme() != null && "FILE".equalsIgnoreCase(uri.getScheme())) {

                    File file = new File(uri);

                    if (file.isFile() && file.exists()) {

                        fileName = file.getAbsolutePath();

                    } else {

                        fileName = uri.getPath();

                    }

                }

                        }

                } catch(ClassCastException e) {

                        fileName = state.getString("fileName");

                }

                this.position = state.getInt("position");

                this.dataType = state.getInt("dataType");

                this.nBandsInThisProvider = state.getInt("nBandsInThisProvider");

                this.rasterBufBandToDrawList = (int[])state.getIntArray("rasterBufBandToDrawList");

        }

        public void saveToState(PersistentState state) throws PersistenceException {

                try {

                        File file = new File(fileName);

                        if(file.exists())

                                state.set("fileName", file.toURI());

                        else

                                state.set("fileName", new URI(fileName));

                } catch (URISyntaxException e) {

                        logger.debug("Error saving the URI " + fileName);

                        //Es mejor no propagar la excepci?n.

                        //Mejor que solo afecte al fichero que a todo el proyecto

                        //throw new PersistenceException(e);

                }

                state.set("position", position);

                state.set("dataType", dataType);

                state.set("nBandsInThisProvider", nBandsInThisProvider);

                state.set("additionalName", additionalName);

                state.set("rasterBufBandToDrawList", rasterBufBandToDrawList);

        }

        /**

         * Register persistence

         */

        public static void registerPersistence() {

                PersistenceManager manager = ToolsLocator.getPersistenceManager();

                DynStruct definition = manager.getDefinition(PERSISTENT_NAME);

                if( definition == null ) {

                        definition = manager.addDefinition(

                                        DatasetBandImpl.class,

                                        PERSISTENT_NAME,

                                        PERSISTENT_DESCRIPTION,

                                        null,

                                        null

                        );

                        definition.addDynFieldURI("fileName").setMandatory(false);

                        definition.addDynFieldInt("position").setMandatory(false);

                        definition.addDynFieldList("additionalName").setClassOfItems(String.class).setMandatory(false);

                        definition.addDynFieldList("rasterBufBandToDrawList").setClassOfItems(int.class).setMandatory(false);

                        definition.addDynFieldInt("dataType").setMandatory(false);

                        definition.addDynFieldInt("nBandsInThisProvider").setMandatory(false);

                }

        }

}