org.geotools.coverageio.gdal
Class BaseGDALGridFormat

Object
  extended by AbstractGridFormat
      extended by BaseGDALGridFormat
All Implemented Interfaces:
Format
Direct Known Subclasses:
AIGFormat, DTEDFormat, ECWFormat, EnviHdrFormat, ErdasImgFormat, EsriHdrFormat, JP2ECWFormat, JP2KFormat, JP2MrSIDFormat, MrSIDFormat, NITFFormat

public abstract class BaseGDALGridFormat
extends AbstractGridFormat
implements Format

A Base abstract class implementing Format, to be extended by Formats leveraging on GDAL.

Author:
Daniele Romagnoli, GeoSolutions, Simone Giannecchini, GeoSolutions

Field Summary
static DefaultParameterDescriptor<String> SUGGESTED_TILE_SIZE
          This GeneralParameterValue can be provided to the GridCoverageReaders through the GridCoverageReader.read(GeneralParameterValue[]) method in order to specify the suggested size of tiles to avoid long time reading occurring with JAI ImageRead on striped images.
static String TILE_SIZE_SEPARATOR
           
static DefaultParameterDescriptor<Boolean> USE_MULTITHREADING
          This GeneralParameterValue can be provided to the GridCoverageReaders through the GridCoverageReader.read(GeneralParameterValue[]) method in order to specify to use multithreading when leveraging on a JAI ImageRead operation.
 
Fields inherited from class AbstractGridFormat
GEOTOOLS_WRITE_PARAMS, mInfo, OVERVIEW_POLICY, READ_GRIDGEOMETRY2D, readParameters, USE_JAI_IMAGEREAD, writeParameters
 
Constructor Summary
protected BaseGDALGridFormat(ImageReaderSpi spi)
          Constructor for the BaseGDALGridFormat.
 
Method Summary
 boolean accepts(Object input)
          Tells me if this Format can read the provided input.
 GeoToolsWriteParams getDefaultImageIOWriteParameters()
          Returns an instance of ImageWriteParam that can be used to control a subsequent GridCoverageWriter.write(org.opengis.coverage.grid.GridCoverage, org.opengis.parameter.GeneralParameterValue[]); Be careful with using the ImageWriteParam since their usage is still experimental.
protected static ParameterGroup getDefaultParameterGroup(Map<String,String> mInfo)
          Return a ParameterGroup with default General Parameter Descriptors.
 AbstractGridCoverage2DReader getReader(Object source)
          Gets a GridCoverageReader for this format able to create coverages out of the source object.
 GridCoverageWriter getWriter(Object destination)
          Retrieves a GridCoverageWriter suitable for writing to the provided destination with this format.
 GridCoverageWriter getWriter(Object destination, Hints hints)
           
protected abstract  void setInfo()
          Each plugin needs to implement this method defining format specific properties
 
Methods inherited from class AbstractGridFormat
equals, getDefaultCRS, getDescription, getDocURL, getName, getReader, getReadParameters, getVendor, getVersion, getWriteParameters
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface Format
getDescription, getDocURL, getName, getReadParameters, getVendor, getVersion, getWriteParameters
 

Field Detail

USE_MULTITHREADING

public static final DefaultParameterDescriptor<Boolean> USE_MULTITHREADING
This GeneralParameterValue can be provided to the GridCoverageReaders through the GridCoverageReader.read(GeneralParameterValue[]) method in order to specify to use multithreading when leveraging on a JAI ImageRead operation. This will be achieved with the use of the ImageReadMT operation of the ImageIO-Ext.


SUGGESTED_TILE_SIZE

public static final DefaultParameterDescriptor<String> SUGGESTED_TILE_SIZE
This GeneralParameterValue can be provided to the GridCoverageReaders through the GridCoverageReader.read(GeneralParameterValue[]) method in order to specify the suggested size of tiles to avoid long time reading occurring with JAI ImageRead on striped images. (Images with tiles Nx1) Value should be a String in the form of "W,H" (without quotes) where W is a number representing the suggested tileWidth and H is a number representing the suggested tileHeight.


TILE_SIZE_SEPARATOR

public static final String TILE_SIZE_SEPARATOR
See Also:
Constant Field Values
Constructor Detail

BaseGDALGridFormat

protected BaseGDALGridFormat(ImageReaderSpi spi)
Constructor for the BaseGDALGridFormat. It is invoked by the underlying implementations.

Parameters:
spi - the format specific ImageReaderSpi instance
Method Detail

setInfo

protected abstract void setInfo()
Each plugin needs to implement this method defining format specific properties


getReader

public AbstractGridCoverage2DReader getReader(Object source)
Description copied from class: AbstractGridFormat
Gets a GridCoverageReader for this format able to create coverages out of the source object.

In case this Format cannot reader the provided source object null is returned.

Specified by:
getReader in class AbstractGridFormat
Parameters:
source - The source object to parse.
Returns:
A reader for this Format or null.
See Also:
org.geotools.data.coverage.grid.AbstractGridFormat#getReader(Object source)

getWriter

public GridCoverageWriter getWriter(Object destination)
Description copied from class: AbstractGridFormat
Retrieves a GridCoverageWriter suitable for writing to the provided destination with this format.

In case no writers are availaible null is returned.

Specified by:
getWriter in class AbstractGridFormat
Parameters:
destination - The destinatin where to write.
Returns:
A GridCoverageWriter suitable for writing to the provided destination with this format.
See Also:
Actually, the plugin does not support write capabilities. The method throws an {@code UnsupportedOperationException}.

getDefaultImageIOWriteParameters

public GeoToolsWriteParams getDefaultImageIOWriteParameters()
Description copied from class: AbstractGridFormat
Returns an instance of ImageWriteParam that can be used to control a subsequent GridCoverageWriter.write(org.opengis.coverage.grid.GridCoverage, org.opengis.parameter.GeneralParameterValue[]);

Be careful with using the ImageWriteParam since their usage is still experimental.

Specified by:
getDefaultImageIOWriteParameters in class AbstractGridFormat
Returns:
an instance of ImageWriteParam.
See Also:
Actually, the plugin does not support write capabilities. The method throws an {@code UnsupportedOperationException}.

getWriter

public GridCoverageWriter getWriter(Object destination,
                                    Hints hints)
See Also:
Actually, the plugin does not support write capabilities. The method throws an {@code UnsupportedOperationException}.

accepts

public boolean accepts(Object input)
Description copied from class: AbstractGridFormat
Tells me if this Format can read the provided input.

Specified by:
accepts in class AbstractGridFormat
Parameters:
input - The input object to test for suitablilty.
Returns:
True if this format can read this object, False otherwise.
See Also:
org.geotools.data.coverage.grid.AbstractGridFormat#accepts(java.lang.Object input)

getDefaultParameterGroup

protected static ParameterGroup getDefaultParameterGroup(Map<String,String> mInfo)
Return a ParameterGroup with default General Parameter Descriptors.

Parameters:
mInfo - Set of properties info
Returns:
a ParameterGroup with Default GeneralParameterDescriptors.


Copyright © 1996-2010 Geotools. All Rights Reserved.