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.fmap.dal.coverage.datastruct;

import java.util.ArrayList;

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

/**

 * 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 interface BandList {

        /**

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

         * @param drawableBands

         */

        public void setDrawableBands(int[] drawableBands);

        /**

         * Asigna el array de bandas

         * @param bands

         */

        public void setBandArray(ArrayList<DatasetBand> bands);

        /**

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

         * @return

         */

        public int[] getDrawableBands();

        /**

         * 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);

        /**

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

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

         * del Buffer 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 Buffer.

         * <table border=1>

         * <tr><td>Elem (Buffer)</td><td>Valor (Banda de la imagen)</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 Buffer tendra en la banda 0 dibujada la banda 1 de este Provider, 

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

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

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

         */

        public int[] bandsToDrawList(int nBandsDataImage);

        /**

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

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

        //Setters and Getters

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

        /**

         * A?ade una banda a la lista.

         * @param b banda a a?adir.

         * @deprecated Use addBand without position. This call does not use this parameter.

         */

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

        /**

         * Adds a band to the list

         * @param b Band to add.

         */

        public void addBand(DatasetBand b)throws BandNotFoundInListException;

        /**

         * 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);

        /**

         * ELimina todas las bandas que tienen un nombre determinado.

         * @param name Nombre de las bandas a eliminar

         */

        public void removeBands(String name);

        /**

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

        /**

         * 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);

        /**

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

        /**

         * Obtiene la banda de la posici?n i.

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

         * @return Banda.

         */

        public DatasetBand getBand(int i);

        /**

         * Obtiene el n?mero de bandas.

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

         */

        public int getBandCount();

        /**

         * A partir de un nombre de fichero y un n?mero de banda obtiene la banda o bandas del buffer de salida 

         * donde se pinta.

         * @param fileName Nombre de fichero

         * @param band N?mero de banda de la imagen

         * @return banda o bandas del buffer de salida donde se dibuja.

         */

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

        /**

         * A partir de un nombre de fichero y un n?mero de banda obtiene la banda o bandas del buffer de salida 

         * donde se pinta. Esta llamada es igual a getBufferBandToDraw pero esta considera un buffer por cada

         * provider. Por ejemplo, si tenemos 3 providers de una banda cada uno el buffer de cada provider tendr? como

         * mucho una banda. En el caso anterior consideraria un buffer de 3 bandas

         * @param fileName Nombre de fichero

         * @param band N?mero de banda de la imagen

         * @return banda o bandas del buffer de salida donde se dibuja.

         */

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

        /**

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

         * @return lista de nombres de los ficheros del GeoRasterMultiFile

         */

        public String[] getBandStringList();

        /**

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

        /**

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

        /**

         * 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);

        /**

         * Limpia la lista de bandas

         */

        public void clear();

        public Object clone();

}