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.store;

import org.gvsig.fmap.dal.DataQuery;

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

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

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

import org.gvsig.raster.cache.tile.provider.CacheStruct;

import org.gvsig.raster.cache.tile.provider.TileListener;

import org.gvsig.timesupport.Time;

import org.gvsig.tools.task.Cancellable;

import org.gvsig.tools.task.TaskStatus;

/**

 * Interfaz que contiene las operaciones que debe soportar la carga de datos

 * raster en un buffer.

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

 */

public interface RasterQuery extends DataQuery {

        /**

         * Sets the frame width. This parameter is take into 

         * account only when the request is tiled and this characteristic is

         * supported.

         * @param n

         */

        public void setFrameWidth(int n);

        /**

         * Sets the number of the alpha band. This parameter is take into 

         * account only when the request is made using TileListener. In this case

         * the parameter transparencyBuffer in nextBuffer method will have the right

         * data.

         * @param bandNumber

         */

        public void setAlphaBand(int bandNumber);

        /**

         * The user can told if the buffer will be stored or not in the RasterDatasource.

         * @param store

         */

        public void storeLastBuffer(boolean store);

        /**

         * Asigna el flag que ajusta el extent de la petici?n al del raster. Si est? a

         * true en caso de que el extent de la petici?n sea mayor lo ajustar? a los limites

         * de este. Si est? a false no lo ajustar? rellenando los valores con NoData

         * @param adjustToExtent true para ajustar y false si no queremos que lo haga. Por defecto

         * estar? a true.

         */

        public void setAdjustToExtent(boolean adjustToExtent);

        /**

         * Obtiene el flag que ajusta el extent de la petici?n al del raster. Si est? a

         * true en caso de que el extent de la petici?n sea mayor lo ajustar? a los limites

         * de este. Si est? a false no lo ajustar? rellenando los valores con NoData. Por defecto

         * estar? a true.

         * @return true si ajusta y false si no lo hace

         */

        public boolean isAdjustToExtent();

        /**

         * Set the list of bands to write in a buffer when the call query be executed. 

         * Each position in the array represents a buffer band and the number inside 

         * of this position is the image band read which be write in the buffer 

         * @param drawableBands        Array with the list of bands to write

         */

        public void setDrawableBands(int[] drawableBands);

        /**

         * Gets a buffer of data with the same number of bands and the same order that

         * the original raster

         */

        public void setAllDrawableBands();

        /**

         * Gets the list of bands to write in a buffer when the call query be executed. 

         * Each position in the array represents a buffer band and the number inside 

         * of this position is the image band read which be write in the buffer 

         * @return Array with the list of bands

         */

        public int[] getDrawableBands();

        /**

         * Asigna el flag que dice si la carga del siguiente buffer es de solo lectura o lectura/escritura.

         * La asignaci?n del flag de solo lectura a true debe hacerse para cada consulta.

         * @param readOnly true si la siguiente carga de buffer se hace de solo lectura y false si es de lectura/escritura

         */

        public void setReadOnly(boolean readOnly);

        /**

         * Asigna el flag que dice si la carga del siguiente buffer es en memoria

         * @param memory true si la siguiente carga de buffer se hace en memoria y false se deja decidir al dataset 

         * el tipo de buffer

         */

        public void setMemoryBuffer(boolean readOnly);

        /**

         * Asigna el valor noData con el que se rellenan las celdas cuando se hace una petici?n

         * en la que no se quiere que se ajuste al ?rea del raster. Por defecto noData tendr? el valor

         * que aparece en IBuffer.

         * @param noData

         */

        public void setNoDataToFill(NoData noData);

        /**

         * Consulta el flag de supersampleo en la carga del buffer.

         * <P>

         * Si este flag es false

         * y pasamos un buffer de tama?o mayor que el n?mero de pixels del ?rea requerida en la

         * llamada setAreaOfInterest entonces se ajustar? este buffer al n?mero de pixeles contenidos

         * en el ?rea.

         * </P>

         * <P>

         * Por ejemplo, si solicitamos un ?rea de 5x4 pixels de un raster y pedimos que nos los grabe

         * en un buffer de 500x400, si esta variable es false el buffer lo generar? de 5x4. Si esta

         * variable es true el buffer lo generar? de 500x400.

         * </P>

         *

         * @return true si el supersampleo en la carga del buffer est? activado y false si no lo est?.

         */

        public boolean isSupersamplingLoadingBuffer();

        /**

         * Returns true if the buffer is not writable

         * @return

         */

        public boolean isReadOnly();

        /**

         * Gets the time information of the viewport requested

         * @return

         */

        public Time getTime();

        /**

         * Sets the time information of the viewport requested

         * @return

         */

        public void setTime(Time time);

        /**

         * Activa o desactiva el supersampling en la carga del buffer.

         * <P>

         * Si este flag es false

         * y pasamos un buffer de tama?o mayor que el n?mero de pixels del ?rea requerida en la

         * llamada setAreaOfInterest entonces se ajustar? este buffer al n?mero de pixeles contenidos

         * en el ?rea.

         * </P>

         * <P>

         * Por ejemplo, si solicitamos un ?rea de 5x4 pixels de un raster y pedimos que nos los grabe

         * en un buffer de 500x400, si esta variable es false el buffer lo generar? de 5x4. Si esta

         * variable es true el buffer lo generar? de 500x400.

         * </P>

         *

         * @param supersamplingLoadingBuffer true o false para activar o desactivar el supersampling en la

         * carga del buffer.

         */

        public void setSupersamplingLoadingBuffer(boolean supersamplingLoadingBuffer);

        /**

         * Asigna el ?rea de interes en coordenadas del mundo real. 

         * Si las coordenadas exceden del tama?o de la imagen estas coordenadas son ajustadas el extent.

         * @param x Coordenada X, esquina superior izquierda

         * @param y Coordenada Y, esquina superior izquierda

         * @param w Ancho del ?rea

         * @param h Alto del ?rea

         */

        public void setAreaOfInterest(double x, double y, double w, double h);

        /**

         * Asigna el ?rea de interes en coordenadas del mundo real. Si las coordenadas exceden del tama?o de la imagen

         * estas coordenadas son ajustadas el extent. Si la petici?n es tileada se har? una llamada al listener cada vez

         * que se reciba un tile.

         * @param x Coordenada X, esquina superior izquierda

         * @param y Coordenada Y, esquina superior izquierda

         * @param w Ancho del ?rea

         * @param h Alto del ?rea

         * @param bufWidth Ancho del buffer

         * @param bufHeight Alto del buffer

         * @param listener Este listener es usado para recibir tiles. Cada vez que se recibe uno se har? una llamada.

         * @return En caso de que el buffer sea mayor que el tama?o seleccionado de raster se produce supersampleo. La funci?n devuelve

         * un array de dos elementos que representan el desplazamiento en pixels de X e Y de la esquina superior izquierda.

         */

        public void setAreaOfInterest(Extent bbox, int bufWidth, int bufHeight, TileListener listener);

        /**

         * Asigna el ?rea de interes en coordenadas del mundo real. 

         * Si las coordenadas exceden del tama?o de la imagen estas coordenadas son ajustadas el extent.

         * Este es el m?todo que se gasta para dibujado. Aunque se ajusten las coordenadas reales el tama?o de buffer ser

         * respeta. Si el supersamplig est? desactivado entonces cuando el zoom es mayor que 1:1 modifica el tama?o de buffer

         * devolviendo un pixel buffer en un pixel de imagen. El buffer resultante ser? menor que el pedido. Esto es as? porque

         * hay proveedores que no supersamplean y porque el dibujado se encarga de supersamplear.  

         * @param x Coordenada X, esquina superior izquierda

         * @param y Coordenada Y, esquina superior izquierda

         * @param w Ancho del ?rea

         * @param h Alto del ?rea

         * @param bufWidth Ancho del buffer

         * @param bufHeight Alto del buffer

         * @return En caso de que el buffer sea mayor que el tama?o seleccionado de raster se produce supersampleo. La funci?n devuelve

         * un array de dos elementos que representan el desplazamiento en pixels de X e Y de la esquina superior izquierda.

         * @throws ArrayIndexOutOfBoundsException

         * @throws InvalidSetViewException 

         */

        public void setAreaOfInterest(Extent bbox, int bufWidth, int bufHeight);

        /**

         * Sets the area of interest in real coordinates

         * @param bbox

         */

        public void setAreaOfInterest(Extent bbox);

        /**

         * Asigna el ?rea de interes en coordenadas pixel. Si las coordenadas exceden del tama?o de la imagen

         * lanza una excepci?n.

         * @param x Coordenada X, esquina superior izquierda

         * @param y Coordenada Y, esquina superior izquierda

         * @param w Ancho del ?rea

         * @param h Alto del ?rea

         * @throws InvalidSetViewException  

         * @throws ArrayIndexOutOfBoundsException

         */

        public void setAreaOfInterest(int x, int y, int w, int h);

        /**

         * Asigna el ?rea de inter?s a toda la extensi?n del raster.

         */

        public void setAreaOfInterest();

        /**

         * Asigna el ?rea de interes en coordenadas pixel. Esta operaci?n cargar? un RasterBuffer con los datos solicitados por

         * lo que, si al acabar hacemos getRasterBuf obtendremos la matriz de datos. Si las coordenadas exceden del tama?o

         * de la imagen lanza una excepci?n.

         * @param x Coordenada X, esquina superior izquierda

         * @param y Coordenada Y, esquina superior izquierda

         * @param w Ancho del ?rea

         * @param h Alto del ?rea

         * @param bufWidth Ancho del buffer

         * @param bufHeight Alto del buffer

         * @throws ArrayIndexOutOfBoundsException

         */

        public void setAreaOfInterest(int x, int y, int w, int h, int bufWidth, int bufHeight);

        /**

         * Parameters to make a tile request.

         * @param level

         *        Resolution level 

         * @param tileCol 

         *        Tile column in the matrix of its level

         * @param tileRow

         *        Tile row in the matrix of its level

         * @param extent

         *        Bounding box of the requested tile

         * @param cacheStruct

         *        Cache structure force by the client

         */

        public void setTileParameters(int level, int tileCol, int tileRow, Extent extent, CacheStruct cacheStruct);

        /**

         * Sets the task status

         * @param taskStatus

         */

        public void setTaskStatus(TaskStatus taskStatus);

        /**

         * Cancelaci?n temporal solo para tiles hasta que est? disponible TaskStatus

         * @deprecated

         */

        public void setCancel(Cancellable cancel);

}