org.gvsig.fmap.dal.coverage.store

Interface RasterDataStore

All Superinterfaces:

ComplexObservable, ComplexWeakReferencingObservable, DataFactoryUnit, DataStore, Disposable, DynObject, DynObject_v2, Histogramable, Metadata, Observable, Persistent, PyramidRasterStore, RasterStoreProperties, Services, TRasterStore, Visitable, WeakReferencingObservable

All Known Implementing Classes:

AbstractRasterDataStore, DefaultRasterStore, DefaultRemoteRasterStore

public interface RasterDataStore
extends DataStore, TRasterStore, PyramidRasterStore, RasterStoreProperties, Histogramable

Interfaz que deben implementar los almacenes de datos raster.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALPHA_BAND
static int	BLUE_BAND
static int	FILE Tipos de raster dependiendo de su fuente
static int	GREEN_BAND
static int	MOSAIC
static int	POSTGIS
static int	RED_BAND
static int	REMOTE

Fields inherited from interface org.gvsig.fmap.dal.DataStore

CSV_PROVIDER_NAME, DBASE_PROVIDER_NAME, FEATURE_METADATA_DEFINITION_NAME, GEOPACKAGE_PROVIDER_NAME, H2SPATIAL_PROVIDER_NAME, MDB_PROVIDER_NAME, METADATA_CONTAINERNAME, METADATA_CRS, METADATA_DEFINITION_NAME, METADATA_ENVELOPE, METADATA_FEATURETYPE, METADATA_PROVIDER, SHAPE_PROVIDER_NAME, SPATIAL_METADATA_DEFINITION_NAME

Method Summary

Modifier and Type	Method and Description
void	addFile(java.io.File file) Adds a new file.
RasterDataStore	cloneDataStore() Clones this object
void	close() Closes this data store
Vectorization	createVectorizeObject() Gets an object which vectorize a raster
void	deleteLayerFromCache() Deletes the cache of this layer composed by the files in the provider list
java.awt.geom.AffineTransform	getAffineTransform() Obtiene la transformación afin aplicada en las peticiones con coordenadas reales.
java.awt.geom.AffineTransform[]	getAffineTransformByProvider() Gets a list of affine transforms
int[]	getBandCountByProvider() Gets the number of bands by provider.
BandList	getBands() Returns the band list
java.lang.Object	getData(int x, int y, int band) Gets a pixel
RasterDataParameters[]	getDataParametersByProvider() Gets a list of data parameters.
BandList	getDefaultBandList() Gets a default band list for this provider
long	getFileSize() Obtiene el Tamaño de cada fichero de que consta el raster en bytes.
long[]	getFileSizeByProvider() Gets a list of sizes.
GeoPointList	getGeoPointList() Gets the list of geo points associated to this provider
double[]	getHeightByProvider() Gets the height by provider
java.lang.String	getInfoByPoint(double x, double y, Extent extent, int w, int h, ICancellable cancellable) Gets the information in a pixel point.
java.lang.String	getInfoByPoint(double x, double y, ICancellable cancellable) Gets the information in a real point
RasterDataParameters	getInternalParameters() This method will return the DataParameters if it has a simple provider behind.
Buffer	getLastBuffer() Returns the last buffer loaded if the flag storeLastBuffer in the query is true
Metadata[]	getMetadataByProvider() Gets a list of Metadata
int	getOverviewCount(int band) Obtiene el número de overviews de una banda
int[]	getOverviewCountByProvider(int band) Gets the number of overviews by provider
int	getOverviewHeight(int band, int overview) Obtiene el alto de una overview de una banda
java.lang.String[]	getOverviewSizeByProvider(int band, int overview) Gets the size of a overview in one band.
int	getOverviewWidth(int band, int overview) Obtiene el ancho de una overview de una banda
java.awt.geom.AffineTransform	getOwnAffineTransform() Obtiene la matriz de transformación del propio raster.
CoverageStoreProvider	getProvider() Gets a provider
int	getProviderCount() Returns the number of internal providers that it has
Render	getRender() Builds an render object using this RasterDataStore
java.util.List<java.io.File>	getROIFileListFromRmf() Gets the list of ROI files in the RMF
java.util.List<ROI>	getRois(IProjection defaultProjection) Gets the list of regions of interest
java.util.List<ROI>	getRois(java.lang.String epsg) Gets the list of regions of interest
int	getSourceType() Returns the source type (FILE, POSTGIS, REMOTE,...)
java.net.URI	getURIByBand(int band) Gets the URI of the source.
java.net.URI[]	getURIByProvider() Gets a list of file names or URI.
Extent	getView() Obtiene el extent asignado
double[]	getWidthByProvider() Gets the width by provider
boolean	isFileSupported(java.lang.String fName) Tipo de fichero soportado.
boolean	isGeoreferenced() Obtiene el flag que dice si el raster está o no georreferenciado
boolean	isInside(java.awt.geom.Point2D p) Metodo que obtiene si un punto cae dentro de los límites de la extensión de la fuente de datos raster o fuera de ellos.
boolean	isMosaic() Returns true if the source of data is a mosaic of images
boolean	isMultiFile() Returns true if the provider has several files and all of them has the same extension
boolean	isOpen() Returns true if this DataStore is open and false if not
boolean	isRasterEnclosed() Some sevices has neither limits nor pixel size.
boolean	isReproyectable() Returns true if this data store is reproyectable or false if not
boolean	isRotated() Consulta de si un raster tiene rotación o no.
boolean	isTiled() Returns true if the data source is tiled
boolean	needEnhanced() This function returns true if the image to be loaded needs a enhanced filter or doesn't.
RasterDataStore	newDataStore() Creates a new dataset which has the same source reference
RasterDataStore	newNotTiledDataStore() Creates a new dataset which has the same source reference but insure that the provider will be not tiled.
boolean	overviewsSupport() Informa de si el dataset soporta overviews o no.
Buffer	query(RasterQuery query) Makes a request to load a buffer of data.
java.lang.Object[]	queryArray(RasterQuery query) Makes a request to load a buffer of data.
java.awt.geom.Point2D	rasterToWorld(java.awt.geom.Point2D pt) Convierte un punto desde coordenadas pixel a coordenadas del mundo.
void	reload() Actions to reload the information of a layer such as, read rmf or tfw files
void	removeFile(java.io.File file) Removes a file.
void	saveColorTableToRmf(ColorTable table) Saves a color table
void	saveGeoPointListToRmf(GeoPointList pointList) Saves the geo point list to a RMF file
void	saveGeoreferencingToRmf() Saves georeferencing information in the rmf file
void	saveROIFileListToRmf(java.util.List<java.io.File> fileList) Saves a list of files in the RMF file
void	setAffineTransform(java.awt.geom.AffineTransform transf) Asigna una transformación al raster para que se tenga en cuenta en la asignación del setView.
void	setExplorer(RasterDataServerExplorer explorer) Sets the explorer
void	setGeoPointList(GeoPointList geoPointList) Sets the list of geo points associated to this provider
void	setNoDataValue(NoData value) Define el valor NoData asociado al raster.
void	setParameters(DataStoreParameters p) Sets the parameters
void	setProvider(CoverageStoreProvider prov) Sets a provider
void	setRender(Render render) Assigns a render object
void	setRois(java.util.List<ROI> rois) Sets the list of regions of interest
void	setTileServer(java.lang.Class<?> tileServer) Sets a tile server to create a second level of cache.
java.awt.geom.Point2D	worldToRaster(java.awt.geom.Point2D pt) Convierte un punto desde del mundo a coordenadas pixel.

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

accept, accept, createQuery, createSelection, getCache, getChildren, getDataSet, getDataSet, getDataSet, getDataSet, getExplorer, getFullName, getFullNameQuietly, getInterval, getName, getNameQuietly, getParameters, getProviderFactory, getProviderName, getResourcesStorage, getSelection, getStoresRepository, getTimes, getTimes, refresh, setSelection, useCache

Methods inherited from interface org.gvsig.tools.observer.ComplexObservable

beginComplexNotification, disableNotifications, enableNotifications, endComplexNotification

Methods inherited from interface org.gvsig.tools.observer.Observable

addObserver, deleteObserver, deleteObservers

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

loadFromState, saveToState

Methods inherited from interface org.gvsig.metadata.Metadata

getMetadataChildren, getMetadataID, getMetadataName

Methods inherited from interface org.gvsig.tools.dispose.Disposable

dispose

Methods inherited from interface org.gvsig.tools.visitor.Visitable

accept

Methods inherited from interface org.gvsig.tools.dynobject.DynObject_v2

hasDynMethod

Methods inherited from interface org.gvsig.tools.dynobject.DynObject

clear, clone, delegate, getDynClass, getDynValue, hasDynValue, implement, invokeDynMethod, invokeDynMethod, setDynValue

Methods inherited from interface org.gvsig.fmap.dal.coverage.store.TRasterStore

getTimeSerials, goTo, selectNext, selectPrev, setTime, setTimeSerials

Methods inherited from interface org.gvsig.fmap.dal.coverage.store.PyramidRasterStore

getCoordsInLevel, getCoordsInTheNearestLevel, getNearestLevel, getZoomLevels

Methods inherited from interface org.gvsig.fmap.dal.coverage.store.RasterStoreProperties

getBandCount, getCellSize, getColorInterpretation, getColorTable, getDataType, getExtent, getExtentWithoutRot, getHeight, getHistogramComputer, getImageLegend, getMetadata, getName, getNoDataValue, getPixelSizeX, getPixelSizeY, getProjection, getStatistics, getTransparency, getWidth, getWktProjection, setColorInterpretation, setProjection, setStatistics

Methods inherited from interface org.gvsig.fmap.dal.coverage.store.props.Histogramable

getHistogramComputer

Field Detail

RED_BAND

static final int RED_BAND

See Also:

Constant Field Values

GREEN_BAND

static final int GREEN_BAND

See Also:

Constant Field Values

BLUE_BAND

static final int BLUE_BAND

See Also:

Constant Field Values

ALPHA_BAND

static final int ALPHA_BAND

See Also:

Constant Field Values

FILE

static final int FILE

Tipos de raster dependiendo de su fuente

See Also:

Constant Field Values

POSTGIS

static final int POSTGIS

See Also:

Constant Field Values

REMOTE

static final int REMOTE

See Also:

Constant Field Values

MOSAIC

static final int MOSAIC

See Also:

Constant Field Values

Method Detail

reload

void reload()

Actions to reload the information of a layer such as, read rmf or tfw files

getDefaultBandList

BandList getDefaultBandList()

Gets a default band list for this provider

Returns:

getDataParametersByProvider

RasterDataParameters[] getDataParametersByProvider()

Gets a list of data parameters. If it doesn't have internal providers this method will return only one DataParameter

Returns:

getFileSizeByProvider

long[] getFileSizeByProvider()

Gets a list of sizes. If the provider doesn't have files it will return null. If the provider has one file it will return an array of one element with the size of this file. If the provider contains others with one file each one.

Returns:

getURIByProvider

java.net.URI[] getURIByProvider()

Gets a list of file names or URI. Each element of this array is the name of a provider

Returns:

getBandCountByProvider

int[] getBandCountByProvider()

Gets the number of bands by provider.

Returns:

getMetadataByProvider

Metadata[] getMetadataByProvider()

Gets a list of Metadata

Returns:

getOverviewCountByProvider

int[] getOverviewCountByProvider(int band)
                          throws BandAccessException

Gets the number of overviews by provider

Parameters:

number - of band

Returns:

Throws:

BandAccessException

getOverviewSizeByProvider

java.lang.String[] getOverviewSizeByProvider(int band,
                                             int overview)
                                      throws BandAccessException

Gets the size of a overview in one band. The result is a list of strings (WidthXHeight)

Parameters:

band -

Returns:

Throws:

BandAccessException

getAffineTransformByProvider

java.awt.geom.AffineTransform[] getAffineTransformByProvider()

Gets a list of affine transforms

Returns:

getHeightByProvider

double[] getHeightByProvider()

Gets the height by provider

Returns:

getWidthByProvider

double[] getWidthByProvider()

Gets the width by provider

Returns:

getURIByBand

java.net.URI getURIByBand(int band)

Gets the URI of the source. If the provider has only one band the result will be the URI. If it is multifile will have to choose among several sources.

Parameters:

band -

Returns:

getProviderCount

int getProviderCount()

Returns the number of internal providers that it has

Returns:

addFile

void addFile(java.io.File file)
      throws InvalidSourceException

Adds a new file. The behavior of this function depends on the kind of provider and its implementation.

Parameters:

file -

Throws:

InvalidSourceException

removeFile

void removeFile(java.io.File file)

Removes a file. The behavior of this function depends on the kind of provider and its implementation.

Parameters:

file -

setNoDataValue

void setNoDataValue(NoData value)

Define el valor NoData asociado al raster.

getView

Extent getView()

Obtiene el extent asignado

Returns:

Extent

newDataStore

RasterDataStore newDataStore()

Creates a new dataset which has the same source reference

Returns:

RasterDataStore

newNotTiledDataStore

RasterDataStore newNotTiledDataStore()

Creates a new dataset which has the same source reference but insure that the provider will be not tiled. Most of processes has to be applied over not tiled providers

Returns:

RasterDataStore

getFileSize

long getFileSize()

Obtiene el Tamaño de cada fichero de que consta el raster en bytes.

Returns:

long que representa el tamaño

rasterToWorld

java.awt.geom.Point2D rasterToWorld(java.awt.geom.Point2D pt)

Convierte un punto desde coordenadas pixel a coordenadas del mundo.

Parameters:

pt - Punto a transformar

Returns:

punto transformado en coordenadas del mundo

worldToRaster

java.awt.geom.Point2D worldToRaster(java.awt.geom.Point2D pt)

Convierte un punto desde del mundo a coordenadas pixel.

Parameters:

pt - Punto a transformar

Returns:

punto transformado en coordenadas pixel

isInside

boolean isInside(java.awt.geom.Point2D p)

Metodo que obtiene si un punto cae dentro de los límites de la extensión de la fuente de datos raster o fuera de ellos.

Parameters:

p - Punto a calcular

Returns:

true si está dentro de los límites y false si está fuera

isTiled

boolean isTiled()

Returns true if the data source is tiled

Returns:

isMultiFile

boolean isMultiFile()

Returns true if the provider has several files and all of them has the same extension

Returns:

isMosaic

boolean isMosaic()

Returns true if the source of data is a mosaic of images

Returns:

getOwnAffineTransform

java.awt.geom.AffineTransform getOwnAffineTransform()

Obtiene la matriz de transformación del propio raster. Esta matriz es la encargada de convertir las coordenadas de la petición en coordenadas a las que se pide a la libreria. En gdal, por ejemplo, se piden las coordenadas a la libreria en coordenadas pixel por lo que esta matriz tendrá la georreferenciación asociada en el worldfile o cabecera. Otras librerias como ermapper la petición a la libreria se hace en coordenadas geograficas que son las mismas en las que pide el usuario de gvSIG por lo que esta matriz en este caso se inicializa con la identidad.

Returns:

getAffineTransform

java.awt.geom.AffineTransform getAffineTransform()

Obtiene la transformación afin aplicada en las peticiones con coordenadas reales. Esta corresponde al producto matricial entre la transformación de la propia georreferenciación del raster (ownTransformation) y la transformación que se le aplique de forma externa. Si esta última no existe será la matriz identidad.

Returns:

Matriz de la transformación afín.

setAffineTransform

void setAffineTransform(java.awt.geom.AffineTransform transf)

Asigna una transformación al raster para que se tenga en cuenta en la asignación del setView. Esta asignación recalcula el extent, el requestExtent y asigna el AffineTransform que se usará para la transformación. Esta transformación será considerada como si la imagen tuviera asociado un rmf.

Parameters:

t - Transformación afín a aplicar

createVectorizeObject

Vectorization createVectorizeObject()
                             throws QueryException,
                                    ProcessInterruptedException

Gets an object which vectorize a raster

Returns:

Throws:

RasterDriverException

ProcessInterruptedException - When the object Vectorization is built the raster data buffer is loaded. This operation can be interrupted

QueryException

getRender

Render getRender()

Builds an render object using this RasterDataStore

Returns:

Render

setRender

void setRender(Render render)

Assigns a render object

Parameters:

render -

saveGeoreferencingToRmf

void saveGeoreferencingToRmf()
                      throws RmfSerializerException

Saves georeferencing information in the rmf file

Throws:

RmfSerializerException

saveColorTableToRmf

void saveColorTableToRmf(ColorTable table)
                  throws RmfSerializerException

Saves a color table

Parameters:

table -

Throws:

RmfSerializerException

saveGeoPointListToRmf

void saveGeoPointListToRmf(GeoPointList pointList)
                    throws RmfSerializerException

Saves the geo point list to a RMF file

Parameters:

pointList -

Throws:

RmfSerializerException

saveROIFileListToRmf

void saveROIFileListToRmf(java.util.List<java.io.File> fileList)
                   throws RmfSerializerException

Saves a list of files in the RMF file

Parameters:

fileList -

Throws:

RmfSerializerException

getROIFileListFromRmf

java.util.List<java.io.File> getROIFileListFromRmf()

Gets the list of ROI files in the RMF

Returns:

Throws:

RmfSerializerException

isFileSupported

boolean isFileSupported(java.lang.String fName)

Tipo de fichero soportado. Devuelve true si el tipo de fichero (extension) está soportado, si no devuelve false.

Parameters:

fName - Fichero raster

Returns:

true si está soportado, si no false.

isOpen

boolean isOpen()

Returns true if this DataStore is open and false if not

Returns:

isGeoreferenced

boolean isGeoreferenced()

Obtiene el flag que dice si el raster está o no georreferenciado

Returns:

true si está georreferenciado y false si no lo está.

isReproyectable

boolean isReproyectable()

Returns true if this data store is reproyectable or false if not

Returns:

isRotated

boolean isRotated()

Consulta de si un raster tiene rotación o no.

Returns:

true si tiene rotación y false si no la tiene.

getOverviewCount

int getOverviewCount(int band)
              throws BandAccessException,
                     RasterDriverException

Obtiene el número de overviews de una banda

Returns:

Número de overviews del raster.

Throws:

BandAccessException

RasterDriverException

overviewsSupport

boolean overviewsSupport()

Informa de si el dataset soporta overviews o no.

Returns:

true si soporta overviews y false si no las soporta.

getOverviewWidth

int getOverviewWidth(int band,
                     int overview)
              throws BandAccessException,
                     RasterDriverException

Obtiene el ancho de una overview de una banda

Returns:

Throws:

BandAccessException

RasterDriverException

getOverviewHeight

int getOverviewHeight(int band,
                      int overview)
               throws BandAccessException,
                      RasterDriverException

Obtiene el alto de una overview de una banda

Returns:

Throws:

BandAccessException

RasterDriverException

getBands

BandList getBands()

Returns the band list

Returns:

cloneDataStore

RasterDataStore cloneDataStore()
                        throws CloneException

Clones this object

Returns:

RasterDataStore

Throws:

CloneException

getProvider

CoverageStoreProvider getProvider()

Gets a provider

Returns:

setProvider

void setProvider(CoverageStoreProvider prov)

Sets a provider

deleteLayerFromCache

void deleteLayerFromCache()

Deletes the cache of this layer composed by the files in the provider list

setParameters

void setParameters(DataStoreParameters p)

Sets the parameters

Parameters:

p -

getSourceType

int getSourceType()

Returns the source type (FILE, POSTGIS, REMOTE,...)

Returns:

getInternalParameters

RasterDataParameters getInternalParameters()

This method will return the DataParameters if it has a simple provider behind. If it has a TileProvider this method will return the DataParameters used by the TileProvider.

Returns:

setExplorer

void setExplorer(RasterDataServerExplorer explorer)

Sets the explorer

Parameters:

explorer -

close

void close()
    throws CloseException

Closes this data store

Throws:

CloseException

getLastBuffer

Buffer getLastBuffer()

Returns the last buffer loaded if the flag storeLastBuffer in the query is true

Returns:

getData

java.lang.Object getData(int x,
                         int y,
                         int band)
                  throws InvalidSetViewException,
                         FileNotOpenException,
                         RasterDriverException

Gets a pixel

Parameters:

x -

y -

band -

Returns:

Throws:

InvalidSetViewException

FileNotOpenException

RasterDriverException

queryArray

java.lang.Object[] queryArray(RasterQuery query)
                       throws ProcessInterruptedException,
                              QueryException

Makes a request to load a buffer of data. This call returns an array of results. The first element in the array is the buffer and the other elements are the transparency buffer, the legend and so on. This funtion is mainly used by the getTile call. This array contains all visualization properties.

Parameters:

query -

Returns:

Object[]

Throws:

ProcessInterruptedException

QueryException

query

Buffer query(RasterQuery query)
      throws ProcessInterruptedException,
             QueryException

Makes a request to load a buffer of data. This call returns only a buffer. This call is used by most functions because the properties are read from the datastore.

Parameters:

query -

Returns:

Buffer

Throws:

ProcessInterruptedException

QueryException

setTileServer

void setTileServer(java.lang.Class<?> tileServer)
            throws InitializeException

Sets a tile server to create a second level of cache. This second level will be created if the cache structure is different to the current.

Parameters:

tileServer -

Throws:

InitializeException

isRasterEnclosed

boolean isRasterEnclosed()

Some sevices has neither limits nor pixel size. For instance, WebMapService is a service of this type if the size is not fixed. Other services, like WMTS are enclosed too but in this case it will have resolution by level. This method returns true if the data source is enclosed.

Returns:

needEnhanced

boolean needEnhanced()

This function returns true if the image to be loaded needs a enhanced filter or doesn't. It depends on the format, number of bands, type of data and so on.

Returns:

The default value is false but each driver can change this value.

getInfoByPoint

java.lang.String getInfoByPoint(double x,
                                double y,
                                ICancellable cancellable)
                         throws InfoByPointException

Gets the information in a real point

Parameters:

x - X Pixel position

y - Y pixel position

Returns:

Throws:

InfoByPointException

getInfoByPoint

java.lang.String getInfoByPoint(double x,
                                double y,
                                Extent extent,
                                int w,
                                int h,
                                ICancellable cancellable)
                         throws InfoByPointException

Gets the information in a pixel point. Some services need additional information as the window where the request is done

Parameters:

x - X Pixel position

y - Y pixel position

bbox - Bounding box of the window

w - Width in pixels of the window

h - Height in pixels of the window

cancellable -

Returns:

Throws:

RemoteServiceException

InfoByPointException

getGeoPointList

GeoPointList getGeoPointList()

Gets the list of geo points associated to this provider

Returns:

setGeoPointList

void setGeoPointList(GeoPointList geoPointList)

Sets the list of geo points associated to this provider

getRois

java.util.List<ROI> getRois(IProjection defaultProjection)
                     throws ROIException

Gets the list of regions of interest

Parameters:

defaultProjection -

Returns:

Throws:

ROIException

getRois

java.util.List<ROI> getRois(java.lang.String epsg)
                     throws ROIException

Gets the list of regions of interest

Parameters:

defaultProjection -

Returns:

Throws:

ROIException

setRois

void setRois(java.util.List<ROI> rois)

Sets the list of regions of interest

Parameters:

rois -