org.gvsig.fmap.dal.coverage.store

Interface RasterQuery

All Superinterfaces:

DataQuery, Persistent

All Known Implementing Classes:

DefaultRasterQuery

public interface RasterQuery
extends DataQuery

Parameters to load data from a raster data source.

Use cases:

• Select a window of pixels
• Select a window of pixels with resampling
• Select a bounding box
• Select a bounding box with resampling
• Enable or disable supersampling in all request above described
• Adjust the request to the source limits or builds a buffer with a frame filled with nodata values (In all request above described)
• All data in a buffer of the same size that the source
• Select a bounding box and tiled the request
• Get one tile

Method Summary

Methods

Modifier and Type	Method and Description
RasterQuery	clone() Clones this RasterQuery
void	forceARGBRequest() Force that the built of the buffer be ARGB.
void	forceRGBRequest() Force that the built of the buffer be RGB.
int[]	getDrawableBands() Gets the list of bands to write in a buffer when the call query be executed.
double[]	getStep() Giving a world coordinates, a buffer size and a original raster size.
Time	getTime() Gets the time information of the viewport requested
boolean	isAdjustToExtent() Obtiene el flag que ajusta el extent de la petición al del raster.
boolean	isforcingARGBRequest()
boolean	isforcingRGBRequest()
boolean	isReadOnly() Returns true if the buffer is not writable
boolean	isSupersamplingOptionActive() Consulta el flag de supersampleo en la carga del buffer.
void	setAdjustToExtent(boolean adjustToExtent) Asigna el flag que ajusta el extent de la petición al del raster.
void	setAllDrawableBands() Gets a buffer of data with the same number of bands and the same order that the original raster
void	setAlphaBand(int bandNumber) Sets the number of the alpha band.
void	setAreaOfInterest()
void	setAreaOfInterest(Extent boundingBox)
void	setAreaOfInterest(Extent boundingBox, int bufWidth, int bufHeight)
void	setAreaOfInterest(Extent requestBoundingBox, int bufWidth, int bufHeight, TileListener listener)
void	setAreaOfInterest(Rectangle pixelWindow)
void	setAreaOfInterest(Rectangle pixelWindow, int bufWidth, int bufHeight)
void	setBufferForProviders(Buffer buffer) Buffer loaded by the provider.
void	setDrawableBands(int[] drawableBands) Set the list of bands to write in a buffer when the call query be executed.
void	setMemoryBuffer(boolean readOnly) Asigna el flag que dice si la carga del siguiente buffer es en memoria
void	setNoDataToFill(NoData noData) 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.
void	setReadOnly(boolean readOnly) Asigna el flag que dice si la carga del siguiente buffer es de solo lectura o lectura/escritura.
void	setSupersamplingOption(boolean supersamplingLoadingBuffer) Activa o desactiva el supersampling en la carga del buffer.
void	setTaskStatus(TaskStatus taskStatus) Sets the task status
void	setTileParameters(int level, int tileCol, int tileRow)
void	setTileParameters(int level, int tileCol, int tileRow, Extent extent, CacheStruct cacheStruct) Deprecated.
void	setTime(Time time) Sets the time information of the viewport requested
void	storeLastBuffer(boolean store) The user can told if the buffer will be stored or not in the RasterDatasource.

Methods inherited from interface org.gvsig.fmap.dal.DataQuery

getQueryParameter, getScale, setQueryParameter, setScale

Methods inherited from interface org.gvsig.tools.persistence.Persistent

loadFromState, saveToState

Method Detail

setAreaOfInterest

void setAreaOfInterest()

setAreaOfInterest

void setAreaOfInterest(Rectangle pixelWindow)

setAreaOfInterest

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

setAreaOfInterest

void setAreaOfInterest(Extent boundingBox)

setAreaOfInterest

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

setAreaOfInterest

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

setTileParameters

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

setTileParameters

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

Deprecated.

Parameters to make a tile request.

Parameters:

level - Resolution level

tileCol - Tile column in the matrix of its level

tileRow - Tile row in the matrix of its level

extent - Bounding box of the requested tile

cacheStruct - Cache structure force by the client

setAlphaBand

void setAlphaBand(int bandNumber)

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.

Parameters:

bandNumber -

storeLastBuffer

void storeLastBuffer(boolean store)

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

Parameters:

store -

setAdjustToExtent

void setAdjustToExtent(boolean adjustToExtent)

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

Parameters:

adjustToExtent - true para ajustar y false si no queremos que lo haga. Por defecto estará a true.

isAdjustToExtent

boolean isAdjustToExtent()

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.

Returns:

true si ajusta y false si no lo hace

setDrawableBands

void setDrawableBands(int[] drawableBands)

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

Parameters:

drawableBands - Array with the list of bands to write

setAllDrawableBands

void setAllDrawableBands()

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

getDrawableBands

int[] getDrawableBands()

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

Returns:

Array with the list of bands

setReadOnly

void setReadOnly(boolean readOnly)

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.

Parameters:

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

setMemoryBuffer

void setMemoryBuffer(boolean readOnly)

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

Parameters:

memory - true si la siguiente carga de buffer se hace en memoria y false se deja decidir al dataset el tipo de buffer

setNoDataToFill

void setNoDataToFill(NoData noData)

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.

Parameters:

noData -

isSupersamplingOptionActive

boolean isSupersamplingOptionActive()

Consulta el flag de supersampleo en la carga del buffer.

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.

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.

Returns:

true si el supersampleo en la carga del buffer está activado y false si no lo está.

isReadOnly

boolean isReadOnly()

Returns true if the buffer is not writable

Returns:

getTime

Time getTime()

Gets the time information of the viewport requested

Returns:

setTime

void setTime(Time time)

Sets the time information of the viewport requested

setSupersamplingOption

void setSupersamplingOption(boolean supersamplingLoadingBuffer)

Activa o desactiva el supersampling en la carga del buffer.

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.

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.

Parameters:

supersamplingLoadingBuffer - true o false para activar o desactivar el supersampling en la carga del buffer.

setTaskStatus

void setTaskStatus(TaskStatus taskStatus)

Sets the task status

Parameters:

taskStatus -

getStep

double[] getStep()

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.

forceARGBRequest

void forceARGBRequest()

Force that the built of the buffer be ARGB. Be careful with the renderBands. It will have four bands as maximum.

forceRGBRequest

void forceRGBRequest()

Force that the built of the buffer be RGB. Be careful with the renderBands. It will have three bands as maximum.

isforcingRGBRequest

boolean isforcingRGBRequest()

isforcingARGBRequest

boolean isforcingARGBRequest()

setBufferForProviders

void setBufferForProviders(Buffer buffer)
                           throws QueryException

Buffer loaded by the provider. This buffer is created by the RasterQuery but in some cases can be useful to pass the buffer already created by parameter. In any case, is advisable not to do it.

Throws:

QueryException

clone

RasterQuery clone()

Clones this RasterQuery

Returns: