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.util.ArrayList;

import java.util.List;

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

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

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

import org.gvsig.fmap.dal.coverage.exception.BandNotFoundInListException;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.dynobject.DynStruct;

import org.gvsig.tools.persistence.PersistenceManager;

import org.gvsig.tools.persistence.Persistent;

import org.gvsig.tools.persistence.PersistentState;

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

/**

 * Esta clase gestiona una lista de bandas que puede pertenecer

 * a un fichero (la tiene un Dataset) o puede ser una lista 

 * de bandas de multiples ficheros. Las bandas son

 * almacenadas en un array donde la posici?n en este es el n?mero de banda.  

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

 *

 */

public class BandListImpl implements BandList, Persistent {

        public static final String      PERSISTENT_NAME        = "BandListImpl_Persistent";

    public static final String      PERSISTENT_DESCRIPTION = "BandListImpl Persistent";

        //Band array

        private ArrayList<DatasetBand> bands         = new ArrayList<DatasetBand>();

        private int[]                       drawableBands = null;

        public BandListImpl() {

        }

        public BandListImpl(String fName, int bandCount, int dataType) {

                int[] drawBands = new int[bandCount];

                for (int i = 0; i < bandCount; i++) {

                        try {

                                addBand(new DatasetBandImpl(fName, i, dataType, bandCount), i);

                        } catch (BandNotFoundInListException e1) {

                        }

                        drawBands[i] = i;

                }

                setDrawableBands(drawBands);

        }

        /*

         *  (non-Javadoc)

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

         */

        public Object clone() {

                BandListImpl result = new BandListImpl();

                ArrayList<DatasetBand> b = new ArrayList<DatasetBand>();

                for (int i = 0; i < bands.size(); i++) 

                        b.add((DatasetBand)((DatasetBandImpl)bands.get(i)).clone());

                result.setBandArray(b);

                if(drawableBands != null) {

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

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

                                drawBands[i] = drawableBands[i];

                        result.setDrawableBands(drawBands);

                }

                return result;

        }

        /**

         * Asigna el ?ltimo array de bandas a escribir solicitadas.

         * @param drawableBands

         */

        public void setDrawableBands(int[] drawableBands) {

                clearDrawableBands();

                this.drawableBands = drawableBands;

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

                        if(drawableBands[i] < 0 || drawableBands[i] >= getBandCount())

                                continue;

                        addDrawableBand(i, drawableBands[i]);

                }

        }

        /**

         * Asigna el array de bandas

         * @param bands

         */

        public void setBandArray(ArrayList<DatasetBand> bands) {

                this.bands = bands;

        }

        /**

         * Obtiene el ?ltimo array de bandas a escribir solicitadas.

         * @return

         */

        public int[] getDrawableBands() {        

                return drawableBands;

        }

        /**

         * Encuentra una banda en la lista.

         * @param file Fichero al que pertenece la banda buscada.

         * @param pos Posici?n que ocupa en el fichero.

         * @return true si se ha hallado la banda y false si no se 

         * ha encontrado

         */

        public boolean findBand(DatasetBand band) {

                for(int i = 0; i < bands.size(); i++) {

                        DatasetBand b = (DatasetBand)bands.get(i); 

                        if(        b.getFileName().equals(band.getFileName()) &&

                                b.getPosition() == band.getPosition())

                                return true;

                }

                return false;

        }

        /**

         * Obtiene la lista de bandas a pintar sobre el buffer de 

         * salida en forma de array. Cada elemento del array es una banda

         * del RasterBuf de salida que ha de dibujarse y el valor que contiene

         * ese elemento es la banda de la imagen que va pintada en esa banda 

         * del RasterBuf.

         * <table border=1>

         * <tr><td>Elem</td><td>Valor</td></tr>

         * <tr><td>0</td><td>1</td></tr>

         * <tr><td>1</td><td>0</td></tr>

         * <tr><td>2</td><td>-1</td></tr>

         * <tr><td>3</td><td>0</td></tr>

         * <tr><td>4</td><td>2</td></tr>

         * </table>

         * El RasterBuf tendra en la banda 0 dibujada la banda 1 de este GeoRasterFile, 

         * en la banda 1 la 0 del dataset, en la banda 2 no habr? ninguna de este dataset,

         * en la 3 la 0 y en la 4 la 2 de este GeoRasterFile.

         * @return lista de bandas a dibujar o un array de un elemento con valor -1.

         */

        public int[] bandsToDrawList(int nBandsDataImage) {

                int[] bandsToRead = new int[nBandsDataImage];

                for(int dataImageBand = 0;dataImageBand < nBandsDataImage;dataImageBand++) {

                        bandsToRead[dataImageBand] = -1;

                        for(int band = 0;band < bands.size();band++) {

                                if(        ((DatasetBand)bands.get(band)) != null &&

                                        ((DatasetBand)bands.get(band)).getBufferBandListToDraw() != null) {

                                        for(int dest=0;dest<((DatasetBand)bands.get(band)).getBufferBandListToDraw().length;dest++) {

                                                if(dataImageBand == ((DatasetBand)bands.get(band)).getBufferBandListToDraw()[dest])

                                                        bandsToRead[dataImageBand] = band;

                                        }

                                }

                        }

                }

                return bandsToRead;

        }

        /**

         * Checkea si alguna banda de la lista se est?a dibujando en el buffer de salida.

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

         */

        public boolean isDrawingAnyBand() {

                for(int band = 0;band < bands.size();band++) {

                        if(((DatasetBand)bands.get(band)).isDrawing())

                                return true;

                }

                return false;

        }

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

        //Setters and Getters

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

        public void addBand(DatasetBand b, int pos)throws BandNotFoundInListException {

                bands.add(b);

        }

        public void addBand(DatasetBand b)throws BandNotFoundInListException {

                bands.add(b);

        }

        /**

         * A?ade la lista de bandas pasada por par?metro a la lista

         * actual. Si alguna banda ya existe no la a?ade y continua.

         * @param bl Lista de bandas

         */

        public void addBandList(BandList bl) {

                for(int i = 0; i < bl.getBandCount(); i++) {

                        if(!findBand(bl.getBand(i)))

                                bands.add(bl.getBand(i));

                }

        }

        /**

         * ELimina todas las bandas que tienen un nombre determinado.

         * @param name Nombre de las bandas a eliminar

         */

        public void removeBands(String name) {

                for(int i = 0; i < getBandCount(); i++) {

                        DatasetBand band = getBand(i);

                        if(band.getFileName().equals(name))

                                bands.remove(i);

                }

        }

        /**

         * 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() {

                drawableBands = null;

                for(int i = 0; i < getBandCount(); i++)

                        ((DatasetBand)bands.get(i)).clearDrawableBands();

        }

        /**

         * Para este GeoRasterFile asigna que bandas se pintaran

         * sobre el RasterBuf cuando se haga un update. Especificamos a 

         * trav?s de los par?metros para que posici?n del RasterBuf ir? 

         * dibujada con que banda del fichero de imagen.

         * @param posRasterBuf        Posici?n del RasterBuf que queremos pintar.

         * @param imageBand        Banda de la imagen que se pintar?

         */

        public void addDrawableBand(int posRasterBuf, int imageBand) {

                try {

                        ((DatasetBand)bands.get(imageBand)).addPositionToDrawInBuffer(posRasterBuf);

                } catch(IndexOutOfBoundsException exc) {

                        //No hacemos nada simplemente no inserta la banda.

                }

        }

        /**

         * Obtiene el n?mero de bandas de un RasterBuf sobre las que se pintara

         * alguna banda de este fichero cuando se llama a un updateBuffer. 

         * @return N?mero de bandas. Cero en caso de no tener ninguna asignada. 

         */

        public int getDrawableBandsCount() {

                int nbands = 0;

                for(int i = 0;i < bands.size();i++) {

                        DatasetBand b = (DatasetBand)bands.get(i);

                        if(b.getBufferBandListToDraw() != null)

                                nbands += b.getBufferBandListToDraw().length;

                }

                return nbands;

        }

        /**

         * Obtiene la banda de la posici?n i.

         * @param i Posici?n de la banda a obtener.

         * @return Banda.

         */

        public DatasetBand getBand(int i) {

                if(i < 0 || i >= bands.size())

                        return null;

                return (DatasetBand)bands.get(i);

        }

        /**

         * Obtiene el n?mero de bandas.

         * @return entero con el n?mero de bandas.

         */

        public int getBandCount() {

                return bands.size();

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.fmap.dal.coverage.datastruct.BandList#getBufferBandToDraw(java.lang.String, int)

         */

        public int[] getBufferBandToDraw(String fileName, int band) {

                for(int i = 0; i < bands.size(); i++) {

                        if(((DatasetBand)bands.get(i)).getFileName().equals(fileName))

                                if(((DatasetBand)bands.get(i)).getPosition() == band)

                                        return ((DatasetBand)bands.get(i)).getBufferBandListToDraw();

                }

                int[] r = {-1};

                return r;

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.fmap.dal.coverage.datastruct.BandList#getLocalBufferBandToDraw(java.lang.String, int)

         */

        public int[] getLocalBufferBandToDraw(String fileName, int band) {

                for(int i = 0; i < bands.size(); i++) {

                        if(((DatasetBand)bands.get(i)).getFileName().equals(fileName))

                                if(((DatasetBand)bands.get(i)).getPosition() == band)

                                        return ((DatasetBand)bands.get(i)).getLocalBufferBandListToDraw();

                }

                int[] r = {-1};

                return r;

        }

        /**

         * Obtiene en un array de String la lista de nombres de ficheros

         * @return lista de nombres de los ficheros del GeoRasterMultiFile

         */

        public String[] getBandStringList() {

                String[] list = new String[bands.size()];

                for(int i = 0; i < bands.size(); i++)

                        list[i] = ((DatasetBand)bands.get(i)).getFileName();

                return list;

        }

        /**

         * Obtiene en un array de enteros con la lista de la posici?n de bandas

         * @return lista de la posici?n de bandas

         */

        public int[] getBandPositionList() {

                int[] list = new int[bands.size()];

                for(int i = 0; i < bands.size(); i++)

                        list[i] = ((DatasetBand)bands.get(i)).getPosition();

                return list;

        }

        /**

         * Obtiene el tipo de dato de las bandas. Esta llamada supone que todos los tipos de dato

         * de las bandas son igual por lo que devolver? el primero. 

         * @return Entero que representa el tipo de datos de las bandas

         */

        public int getBandsDataType() {

                if(bands.size() <= 0)

                        return Buffer.TYPE_UNDEFINED;

                return ((DatasetBand)bands.get(0)).getDataType();

        }

        /**

         * Obtiene la posici?n del fichero en la lista a partir del nombre 

         * @param fileName Nombre del fichero

         * @return Posici?n del fichero o -1 si no existe. 

         */

        public int getFileNumber(String fileName) {

                if(fileName == null)

                        return -1;

                String aux = "";

                int count = -1;

                for(int i = 0; i < bands.size(); i++) {

                        if(((DatasetBand)bands.get(i)).getFileName().indexOf(aux) != 0) {

                                count ++;

                                aux = ((DatasetBand)bands.get(i)).getFileName();

                        }

                        if(((DatasetBand)bands.get(i)).getFileName().indexOf(fileName) == 0)

                                return count;

                }

                return -1;

        }

        /**

         * Limpia la lista de bandas

         */

        public void clear() {

                bands.clear();

                drawableBands = null;

        }

        /**

         *Muestra la lista de bandas en modo texto

         */

        public void show() {

                System.out.println("BandCount: " + getBandCount());

                System.out.println("DrawableBandsCount: " + getDrawableBandsCount());

                for (int i = 0; i < getBandCount(); i++) {

                        System.out.println("");

                        System.out.println("***********************");

                        System.out.println("Band: " + i);

                        System.out.println("DataType: " + ((DatasetBand)getBand(i)).getDataType());

                        System.out.println("FileName: " + ((DatasetBand)getBand(i)).getFileName());

                        System.out.println("Position: " + ((DatasetBand)getBand(i)).getPosition());

                        if(((DatasetBand)getBand(i)).getBufferBandListToDraw() != null) {

                                System.out.print("Band Dst: ");

                                for (int j = 0; j < ((DatasetBand)getBand(i)).getBufferBandListToDraw().length; j++)

                                        System.out.print(((DatasetBand)getBand(i)).getBufferBandListToDraw()[j] + " ");

                        }

                        System.out.println();

                }

        }

        @SuppressWarnings("unchecked")

        public void loadFromState(PersistentState state)

                        throws PersistenceException {

                List<DatasetBand> rois = state.getList("bands");

                this.bands = new ArrayList<DatasetBand>();

                this.bands.addAll(rois);

                drawableBands = (int[])state.getIntArray("drawableBands");

        }

        public void saveToState(PersistentState state) throws PersistenceException {

                state.set("bands", bands);                

                state.set("drawableBands", drawableBands);

        }        

        public static void registerPersistence() {

                PersistenceManager manager = ToolsLocator.getPersistenceManager();

                DynStruct definition = manager.getDefinition(PERSISTENT_NAME);

                if( definition == null ) {

                        definition = manager.addDefinition(

                                        BandListImpl.class,

                                        PERSISTENT_NAME,

                                        PERSISTENT_DESCRIPTION,

                                        null, 

                                        null

                        );

                        definition.addDynFieldList("bands").setClassOfItems(DatasetBand.class).setMandatory(true);

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

                }

        }

}