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 java.awt.Rectangle;

import org.gvsig.fmap.dal.DataQuery;

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

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

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

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

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

/**

 * Parameters to load data from a raster data source.

 * <P>Use cases:</P>

 * <UL>

 * <LI>Select a window of pixels</LI>

 * <LI>Select a window of pixels with resampling</LI>

 * <LI>Select a bounding box</LI>

 * <LI>Select a bounding box with resampling</LI>

 * <LI>Enable or disable supersampling in all request above described</LI>

 * <LI>Adjust the request to the source limits or builds a buffer with a frame filled with nodata values (In all request above described)</LI>

 * <LI>All data in a buffer of the same size that the source</LI>

 * <LI>Select a bounding box and tiled the request</LI>

 * <LI>Get one tile</LI>

 * <LI></LI>

 * </UL>

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

 */

public interface RasterQuery extends DataQuery {

        public void setAreaOfInterest();

        public void setAreaOfInterest(Rectangle pixelWindow);

        public void setAreaOfInterest(Rectangle pixelWindow, int bufWidth, int bufHeight);

        public void setAreaOfInterest(Extent boundingBox);

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

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

        public void setTileParameters(int level, int tileCol, int tileRow);

        /**

         * 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

         *        @deprecated 

         */

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

        /**

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

        /**

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

        /**

         * Sets the task status

         * @param taskStatus

         */

        public void setTaskStatus(TaskStatus taskStatus);

        /**

         * Giving a world coordinates, a buffer size and a original raster size. If the 

         * buffer is bigger than the window requested in the source raster (supersampling), 

         * then it means that each pixel of the raster will be written several times in 

         * the destination buffer.

         * 

         * This function calculates the shift in pixels en X and Y coordinate that 

         * correspond with the first pixel, due to this pixel won't be drawn entirely.

         * 

         * Dado unas coordenadas reales, un tama?o de buffer y un tama?o de raster.

         * Si el buffer es de mayor tama?o que el raster (supersampleo) quiere decir que

         * por cada pixel de buffer se repiten varios del raster. Esta funci?n calcula el

         * n?mero de pixels de desplazamiento en X e Y que corresponden al primer pixel del

         * buffer en la esquina superior izquierda. Esto es necesario porque la coordenada

         * solicitada es real y puede no caer sobre un pixel completo. Este calculo es

         * util cuando un cliente quiere supersamplear sobre un buffer y que no se lo haga

         * el driver autom?ticamente.

         */

        public double[] getStep();

        /**

         * Force that the built of the buffer be ARGB. Be careful with the renderBands. It 

         * will have four bands as maximum.

         */

        public void forceARGBRequest();

        /**

         * Force that the built of the buffer be RGB. Be careful with the renderBands. It 

         * will have three bands as maximum.

         */

        public void forceRGBRequest();

        public boolean isforcingRGBRequest();

        public boolean isforcingARGBRequest();

        /**

         * Buffer loaded by the provider. This buffer is created by the <code>RasterQuery</code>  

         * but in some cases can be useful to pass the buffer already created by parameter. 

         * In any case,  is advisable not to do it.

         * @return

         */

        public void setBufferForProviders(Buffer buffer) throws QueryException;

        /**

         * Clones this RasterQuery

         * @return

         */

        public RasterQuery clone();

}