org.gvsig.raster.gdal.io

Class GdalProvider

java.lang.Object

org.gvsig.tools.dispose.impl.AbstractDisposable

org.gvsig.fmap.dal.raster.spi.AbstractCoverageStoreProvider

org.gvsig.raster.impl.provider.AbstractRasterProvider

org.gvsig.raster.gdal.io.GdalProvider

All Implemented Interfaces:

Histogramable, DataStoreProvider, CoverageStoreProvider, RasterProvider, Disposable, DynObject

Direct Known Subclasses:

PostGISRasterProvider

public class GdalProvider
extends AbstractRasterProvider

This class represents the data access for gdal formats.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BAND_HEIGHT
static String	DESCRIPTION
protected GdalDataSource	file
static String	FORMAT_ADRG
static String	FORMAT_BMP
static String	FORMAT_BT
static String	FORMAT_EHDR
static String	FORMAT_ELAS
static String	FORMAT_ENVI
static String	FORMAT_ERS
static String	FORMAT_GRD
static String	FORMAT_GSAG
static String	FORMAT_GSBG
static String	FORMAT_GTiff
static String	FORMAT_HDF4
static String	FORMAT_HFA
static String	FORMAT_IDA
static String	FORMAT_ILWIS
static String	FORMAT_INGR
static String	FORMAT_JP2
static String	FORMAT_LEVELLER
static String	FORMAT_MEM
static String	FORMAT_MFF
static String	FORMAT_MFF2
static String	FORMAT_NITF
static String	FORMAT_PAUX
static String	FORMAT_PCIDSK
static String	FORMAT_PNM
static String	FORMAT_RMF
static String	FORMAT_RST
static String	FORMAT_TERRAGEN
static String	FORMAT_VRT
protected static String[][]	formatList
static String	METADATA_DEFINITION_NAME
static String	NAME

Fields inherited from class org.gvsig.raster.impl.provider.AbstractRasterProvider

ALPHA_BAND, bandCount, BLUE_BAND, bytesReaded, colorTable, externalTransformation, fileSize, fileUtil, geoPointList, GREEN_BAND, histogram, lineCnt, noData, ownTransformation, param, proj, rasterUtil, RED_BAND, rmfBlocksManager, selectedSubdatasetID, serialInfo, stats, storeServices, tileServer, transparency, uri

Fields inherited from class org.gvsig.fmap.dal.raster.spi.AbstractCoverageStoreProvider

metadata, parameters, store

Constructor Summary

Constructors

Constructor and Description
GdalProvider() Mandatory constructor to instantiate an empty provider
GdalProvider(AbstractRasterDataParameters params, DataStoreProviderServices storeServices, DynObject metadata)
GdalProvider(GdalDataParameters params, DataStoreProviderServices storeServices)
GdalProvider(String params) Deprecated. use GdalProvider(URI), this constructor will be removed in gvSIG 2.5
GdalProvider(URI uri) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addFile(File file) Adds a new file.
void	close() Request to close de source
protected void	finalize()
int	getBlockSize()
Object	getData(int x, int y, int band) Obtiene el valor del raster en la coordenada que se le pasa.
String[]	getFormatList() Gets the list of supported formats
double	getHeight() Obtiene el ancho de la imagen
DataStoreMetadata	getMetadata() Gets a DatasetMetadata object
String	getMimeType()
protected GdalDataSource	getNative()
int	getOverviewCount(int band) Obtiene el número de overviews de una banda
int	getOverviewHeight(int band, int overview) Obtiene el alto de una overview de una banda
int	getOverviewWidth(int band, int overview) Obtiene el ancho de una overview de una banda
String	getProviderName() Return the name of the provider.
TileServer	getTileServer() Gets the tile cache data server
Transparency	getTransparency() Obtiene el estado de transparencia a partir de los estados de transparencia de todos los ficheros que lo componen.
Extent	getView() Obtiene el extent asignado
double	getWidth() Obtiene el ancho de la imagen
void	init(AbstractRasterDataParameters params, DataStoreProviderServices storeServices) Creates file references and loads structures with the information and metadata
boolean	isExtensionSupported(String ext) Returns true if the extension is supported and false if doesn't
boolean	isGeoreferenced() Dice si el fichero tiene georreferenciación o no.
boolean	isOpen() Returns true if this provider is open and false if don't
boolean	isOverviewsSupported() Informa de si el dataset soporta overviews o no.
boolean	isReproyectable() Devuelve si el Dataset es reproyectable
boolean	isSupersampling() Informa de si el driver ha supersampleado en el último dibujado.
RasterProvider	load() Carga un fichero raster.
void	loadBuffer(SpiRasterQuery q) Load a buffer with the parameters.
boolean	needEnhanced() This function returns true if the image to be loaded needs a enhanced filter or doesn't.
Object	readBlock(int pos, int blockHeight, double scale) Reads a complete block of data and returns an tridimensional array of the right type.
Object	readCompleteLine(int line, int band) Read a line from the file
static void	register()
void	removeFile(File file) Removes a file.
void	setAffineTransform(AffineTransform t) Asigna una transformación al raster para que se tenga en cuenta en la asignación del setView.
void	setStatus(RasterProvider provider) Sets the status information using other provider of the same type.
void	setView(Extent e) Asigna el extent de la vista actual. existe un fichero .rmf debemos hacer una transformación de la vista asignada ya que la petición viene en coordenadas del fichero .rmf y la vista (v) ha de estar en coordenadas del fichero.
URI	translateURI(URI uri) Traduce el nombre del fichero por un alias asignado por el propio driver.

Methods inherited from class org.gvsig.raster.impl.provider.AbstractRasterProvider

cloneProvider, deleteLayerFromCache, doDispose, getAffineTransform, getBandCount, getBandCountByProvider, getBandPositionByProvider, getCellSize, getChilds, getColorInterpretation, getColorTable, getDataParameters, getDataSet, getDataType, getDefaultBandList, getExplorer, getExtent, getExtentWithoutRot, getFileSize, getFileSizeByProvider, getFileSuffix, getFullName, getGeoPointList, getHistogramComputer, getImageLegend, getInfoByPoint, getInfoByPoint, getInternalProvider, getInternalProviderCount, getInterval, getName, getNoDataValue, getOwnAffineTransform, getPixelSizeX, getPixelSizeY, getProjection, getResource, getRmfBlocksManager, getRMFFile, getRMFFileForRemoteServices, getSourceId, getSourceType, getStatistics, getSubdatasetCount, getTileSize, getTime, getTimes, getTimes, getTimeSerials, getURI, getURIByBand, getURIByProvider, getURIOfFirstProvider, getWktProjection, init, isARGB, isInside, isMosaic, isMultiFile, isRasterEnclosed, isRGB, isRotated, isTiled, isTimeSupported, loadFromRmf, loadObjectFromRmf, loadObjectFromRmf, loadObjectFromRmfFile, newProvider, open, rasterToWorld, reload, resetAffineTransform, saveObjectToRmf, saveObjectToRmf, selectSubdataset, selectSubdataset, setColorInterpretation, setColorTable, setDataType, setFileSize, setFName, setGeoPointList, setNoDataValue, setParam, setProjection, setStatistics, setTileServer, setTimeSerials, singleDatasetInstance, translateFileName, worldToRaster

Methods inherited from class org.gvsig.fmap.dal.raster.spi.AbstractCoverageStoreProvider

allowWrite, clear, createCoverageSelection, createResource, delegate, getClassName, getDataStoreParameters, getDynClass, getDynValue, getEnvelope, getStoreServices, hasDynValue, implement, init, invokeDynMethod, invokeDynMethod, refresh, setDynValue, setMetadata

Methods inherited from class org.gvsig.tools.dispose.impl.AbstractDisposable

dispose, dispose

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.gvsig.fmap.dal.raster.spi.CoverageStoreProvider

allowWrite, getStoreServices

Methods inherited from interface org.gvsig.fmap.dal.spi.DataStoreProvider

refresh

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

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

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

dispose

Field Detail

NAME

public static String NAME

DESCRIPTION

public static String DESCRIPTION

METADATA_DEFINITION_NAME

public static final String METADATA_DEFINITION_NAME

See Also:

Constant Field Values

FORMAT_GTiff

public static final String FORMAT_GTiff

See Also:

Constant Field Values

FORMAT_VRT

public static final String FORMAT_VRT

See Also:

Constant Field Values

FORMAT_NITF

public static final String FORMAT_NITF

See Also:

Constant Field Values

FORMAT_HFA

public static final String FORMAT_HFA

See Also:

Constant Field Values

FORMAT_ELAS

public static final String FORMAT_ELAS

See Also:

Constant Field Values

FORMAT_MEM

public static final String FORMAT_MEM

See Also:

Constant Field Values

FORMAT_BMP

public static final String FORMAT_BMP

See Also:

Constant Field Values

FORMAT_PCIDSK

public static final String FORMAT_PCIDSK

See Also:

Constant Field Values

FORMAT_ILWIS

public static final String FORMAT_ILWIS

See Also:

Constant Field Values

FORMAT_HDF4

public static final String FORMAT_HDF4

See Also:

Constant Field Values

FORMAT_PNM

public static final String FORMAT_PNM

See Also:

Constant Field Values

FORMAT_ENVI

public static final String FORMAT_ENVI

See Also:

Constant Field Values

FORMAT_EHDR

public static final String FORMAT_EHDR

See Also:

Constant Field Values

FORMAT_PAUX

public static final String FORMAT_PAUX

See Also:

Constant Field Values

FORMAT_MFF

public static final String FORMAT_MFF

See Also:

Constant Field Values

FORMAT_MFF2

public static final String FORMAT_MFF2

See Also:

Constant Field Values

FORMAT_BT

public static final String FORMAT_BT

See Also:

Constant Field Values

FORMAT_IDA

public static final String FORMAT_IDA

See Also:

Constant Field Values

FORMAT_RMF

public static final String FORMAT_RMF

See Also:

Constant Field Values

FORMAT_RST

public static final String FORMAT_RST

See Also:

Constant Field Values

FORMAT_LEVELLER

public static final String FORMAT_LEVELLER

See Also:

Constant Field Values

FORMAT_TERRAGEN

public static final String FORMAT_TERRAGEN

See Also:

Constant Field Values

FORMAT_ERS

public static final String FORMAT_ERS

See Also:

Constant Field Values

FORMAT_INGR

public static final String FORMAT_INGR

See Also:

Constant Field Values

FORMAT_GSAG

public static final String FORMAT_GSAG

See Also:

Constant Field Values

FORMAT_GSBG

public static final String FORMAT_GSBG

See Also:

Constant Field Values

FORMAT_ADRG

public static final String FORMAT_ADRG

See Also:

Constant Field Values

FORMAT_JP2

public static final String FORMAT_JP2

See Also:

Constant Field Values

FORMAT_GRD

public static final String FORMAT_GRD

See Also:

Constant Field Values

BAND_HEIGHT

public static final int BAND_HEIGHT

See Also:

Constant Field Values

file

protected GdalDataSource file

formatList

protected static String[][] formatList

Constructor Detail

GdalProvider

public GdalProvider()

Mandatory constructor to instantiate an empty provider

GdalProvider

public GdalProvider(String params)
             throws NotSupportedExtensionException,
                    OpenException

Deprecated. use GdalProvider(URI), this constructor will be removed in gvSIG 2.5

Constructor. Abre el dataset.

Parameters:

params -

Throws:

NotSupportedExtensionException

OpenException

GdalProvider

public GdalProvider(URI uri)
             throws NotSupportedExtensionException

Constructor. Abre el dataset.

Parameters:

uri -

Throws:

NotSupportedExtensionException

GdalProvider

public GdalProvider(GdalDataParameters params,
            DataStoreProviderServices storeServices)
             throws NotSupportedExtensionException

Throws:

NotSupportedExtensionException

GdalProvider

public GdalProvider(AbstractRasterDataParameters params,
            DataStoreProviderServices storeServices,
            DynObject metadata)

Method Detail

register

public static void register()

getFormatList

public String[] getFormatList()

Description copied from interface: RasterProvider

Gets the list of supported formats

Specified by:

getFormatList in interface RasterProvider

Overrides:

getFormatList in class AbstractRasterProvider

Returns:

isExtensionSupported

public boolean isExtensionSupported(String ext)

Returns true if the extension is supported and false if doesn't

Parameters:

ext -

Returns:

init

public void init(AbstractRasterDataParameters params,
        DataStoreProviderServices storeServices)
          throws NotSupportedExtensionException

Creates file references and loads structures with the information and metadata

Parameters:

params - load parameters

storeServices -

Throws:

NotSupportedExtensionException

getMimeType

public String getMimeType()

load

public RasterProvider load()

Description copied from class: AbstractRasterProvider

Carga un fichero raster. Puede usarse para calcular el extent e instanciar un objeto de este tipo.

Specified by:

load in class AbstractRasterProvider

Returns:

RasterProvider

isOpen

public boolean isOpen()

Description copied from interface: RasterProvider

Returns true if this provider is open and false if don't

Returns:

translateURI

public URI translateURI(URI uri)

Description copied from class: AbstractRasterProvider

Traduce el nombre del fichero por un alias asignado por el propio driver. Cuando es traducido por un alias el driver intentar� abrir el alias y no el fichero. Esto es util porque algunos formatos tienen la extensi�n en el fichero de cabecera pero lo que se abre realmente es el fichero de datos.

Overrides:

translateURI in class AbstractRasterProvider

Returns:

uri

setView

public void setView(Extent e)

Asigna el extent de la vista actual. existe un fichero .rmf debemos hacer una transformación de la vista asignada ya que la petición viene en coordenadas del fichero .rmf y la vista (v) ha de estar en coordenadas del fichero.

Specified by:

setView in class AbstractRasterProvider

Parameters:

e -

getView

public Extent getView()

Description copied from class: AbstractRasterProvider

Obtiene el extent asignado

Specified by:

getView in interface RasterProvider

Specified by:

getView in class AbstractRasterProvider

Returns:

Extent

getWidth

public double getWidth()

Description copied from class: AbstractRasterProvider

Obtiene el ancho de la imagen

Specified by:

getWidth in interface RasterProvider

Specified by:

getWidth in class AbstractRasterProvider

Returns:

Ancho de la imagen

getHeight

public double getHeight()

Description copied from class: AbstractRasterProvider

Obtiene el ancho de la imagen

Specified by:

getHeight in interface RasterProvider

Specified by:

getHeight in class AbstractRasterProvider

Returns:

Ancho de la imagen

readCompleteLine

public Object readCompleteLine(int line,
                      int band)
                        throws InvalidSetViewException,
                               FileNotOpenException,
                               RasterDriverException

Read a line from the file

Parameters:

line -

band -

Returns:

Throws:

InvalidSetViewException

FileNotOpenException

RasterDriverException

readBlock

public Object readBlock(int pos,
               int blockHeight,
               double scale)
                 throws InvalidSetViewException,
                        FileNotOpenException,
                        RasterDriverException,
                        ProcessInterruptedException

Description copied from interface: RasterProvider

Reads a complete block of data and returns an tridimensional array of the right type. This function is useful to read a file very fast without setting a view.

Throws:

InvalidSetViewException

FileNotOpenException

RasterDriverException

ProcessInterruptedException

getData

public Object getData(int x,
             int y,
             int band)
               throws InvalidSetViewException,
                      FileNotOpenException,
                      RasterDriverException

Description copied from class: AbstractRasterProvider

Obtiene el valor del raster en la coordenada que se le pasa. El valor será Double, Int, Byte, etc. dependiendo del tipo de raster.

Specified by:

getData in interface RasterProvider

Specified by:

getData in class AbstractRasterProvider

Parameters:

x - coordenada X

y - coordenada Y

Returns:

data

Throws:

InvalidSetViewException

FileNotOpenException

RasterDriverException

loadBuffer

public void loadBuffer(SpiRasterQuery q)
                throws ProcessInterruptedException,
                       RasterDriverException

Description copied from class: AbstractRasterProvider

Load a buffer with the parameters. The buffer should already have been created inside the query structure SpiRasterQuery by the RasterDataStore. The other parameters have been calculated too, all of them adjusted to the raster limits. The provider only have to read the parameters and load the buffer.

Specified by:

loadBuffer in class AbstractRasterProvider

Throws:

ProcessInterruptedException

RasterDriverException

getBlockSize

public int getBlockSize()

Specified by:

getBlockSize in class AbstractRasterProvider

getMetadata

public DataStoreMetadata getMetadata()

Description copied from interface: RasterProvider

Gets a DatasetMetadata object

Specified by:

getMetadata in interface RasterProvider

Overrides:

getMetadata in class AbstractRasterProvider

Returns:

getTransparency

public Transparency getTransparency()

Description copied from interface: RasterProvider

Obtiene el estado de transparencia a partir de los estados de transparencia de todos los ficheros que lo componen. Si varios de los ficheros que lo componen tienen banda de transparencia estas tendrán que ser mezcladas sobre una banda de transparencia única.

Specified by:

getTransparency in interface RasterProvider

Overrides:

getTransparency in class AbstractRasterProvider

Returns:

Objeto FileTransparency con el estado de transparencia

isGeoreferenced

public boolean isGeoreferenced()

Description copied from class: AbstractRasterProvider

Dice si el fichero tiene georreferenciación o no.

Specified by:

isGeoreferenced in interface RasterProvider

Overrides:

isGeoreferenced in class AbstractRasterProvider

Returns:

true si tiene georreferenciación y false si no la tiene

isSupersampling

public boolean isSupersampling()

Informa de si el driver ha supersampleado en el último dibujado. Es el driver el que colocará el valor de esta variable cada vez que dibuja.

Returns:

true si se ha supersampleado y false si no se ha hecho.

getNative

protected GdalDataSource getNative()

setAffineTransform

public void setAffineTransform(AffineTransform t)

Description copied from interface: RasterProvider

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.

Specified by:

setAffineTransform in interface RasterProvider

Overrides:

setAffineTransform in class AbstractRasterProvider

Parameters:

t - Transformación afín a aplicar

getOverviewCount

public int getOverviewCount(int band)
                     throws BandAccessException,
                            RasterDriverException

Description copied from interface: RasterProvider

Obtiene el número de overviews de una banda

Returns:

Throws:

BandAccessException

RasterDriverException

getOverviewWidth

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

Description copied from interface: RasterProvider

Obtiene el ancho de una overview de una banda

Specified by:

getOverviewWidth in interface RasterProvider

Specified by:

getOverviewWidth in class AbstractRasterProvider

Returns:

Throws:

BandAccessException

RasterDriverException

getOverviewHeight

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

Description copied from interface: RasterProvider

Obtiene el alto de una overview de una banda

Specified by:

getOverviewHeight in interface RasterProvider

Specified by:

getOverviewHeight in class AbstractRasterProvider

Returns:

Throws:

BandAccessException

RasterDriverException

isOverviewsSupported

public boolean isOverviewsSupported()

Description copied from class: AbstractRasterProvider

Informa de si el dataset soporta overviews o no.

Specified by:

isOverviewsSupported in interface RasterProvider

Specified by:

isOverviewsSupported in class AbstractRasterProvider

Returns:

true si soporta overviews y false si no las soporta.

isReproyectable

public boolean isReproyectable()

Description copied from class: AbstractRasterProvider

Devuelve si el Dataset es reproyectable

Specified by:

isReproyectable in interface RasterProvider

Overrides:

isReproyectable in class AbstractRasterProvider

Returns:

true if Dataset is reproyectable

needEnhanced

public boolean needEnhanced()

Description copied from interface: RasterProvider

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.

Specified by:

needEnhanced in interface RasterProvider

Overrides:

needEnhanced in class AbstractRasterProvider

Returns:

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

getProviderName

public String getProviderName()

Description copied from interface: DataStoreProvider

Return the name of the provider. Examples: dbf, shp, jdbc, postgresql, wfs, gml

Returns:

setStatus

public void setStatus(RasterProvider provider)

Description copied from interface: RasterProvider

Sets the status information using other provider of the same type. The first action of this method should be to check the type of the parameter.

getTileServer

public TileServer getTileServer()

Description copied from interface: RasterProvider

Gets the tile cache data server

Returns:

close

public void close()

Description copied from interface: DataStoreProvider

Request to close de source

Specified by:

close in interface RasterProvider

Overrides:

close in class AbstractRasterProvider

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class AbstractRasterProvider

Throws:

Throwable

addFile

public void addFile(File file)
             throws InvalidSourceException

Description copied from interface: RasterProvider

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

Throws:

InvalidSourceException

removeFile

public void removeFile(File file)

Description copied from interface: RasterProvider

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