org.geotools.coverage.grid.io
Class AbstractGridFormat

Object
  AbstractGridFormat

All Implemented Interfaces:

Format

Direct Known Subclasses:

ArcGridFormat, ArcSDERasterFormat, BaseGDALGridFormat, GeoTiffFormat, GrassCoverageFormat, GTopo30Format, ImageMosaicFormat, ImageMosaicJDBCFormat, ImagePyramidFormat, JP2KFormat, UnknownFormat, WorldImageFormat

public abstract class AbstractGridFormat
extends Object
implements Format

AbstractGridFormat is a convenience class so subclasses only need to populate a Map class and set the read and write parameter fields. For example the ArcGridFormat has the following method which sets up all the required information: private void setInfo(){ HashMap info=new HashMap(); info.put("name", "ArcGrid"); info.put("description", "Arc Grid Coverage Format"); info.put("vendor", "Geotools"); info.put("docURL", "http://gdal.velocet.ca/projects/aigrid/index.html"); info.put("version", "1.0"); mInfo=info; readParameters=new GeneralParameterDescriptor[2]; readParameters[0]=ArcGridOperationParameter.getGRASSReadParam(); readParameters[0]=ArcGridOperationParameter.getCompressReadParam(); writeParameters=new GeneralParameterDescriptor[2]; writeParameters[0]=ArcGridOperationParameter.getGRASSWriteParam(); writeParameters[0]=ArcGridOperationParameter.getCompressWriteParam(); }

Author:

jeichar, Simone Giannecchini, GeoSolutions

Field Summary

static ParameterDescriptor<Color>	BACKGROUND_COLOR Control the background color to be used where the input was transparent
static ParameterDescriptor<DecimationPolicy>	DECIMATION_POLICY This GeneralParameterValue can be provided to the GridCoverageReaders through the GridCoverageReader.read(GeneralParameterValue[]) method in order to specify the policy a reader should adopt when setting read parameters when evaluating a needed resolution.
static DefaultParameterDescriptor<GeoToolsWriteParams>	GEOTOOLS_WRITE_PARAMS This GeneralParameterValue cacn be provided to the GridCoverageWriters through the GridCoverageWriter.write(org.opengis.coverage.grid.GridCoverage, GeneralParameterValue[]) method in order to control the writing process in terms of compression, tiling, etc.GridGeometry2D
static ParameterDescriptor<Color>	INPUT_TRANSPARENT_COLOR Control the transparency of the input coverages.
protected Map<String,String>	mInfo The Map object is used by the information methods(such as getName()) as a data source.
static DefaultParameterDescriptor<OverviewPolicy>	OVERVIEW_POLICY This GeneralParameterValue can be provided to the GridCoverageReaders through the GridCoverageReader.read(GeneralParameterValue[]) method in order to specify the policy a reader should adopt when choosing the right overview during a read operation.
static DefaultParameterDescriptor<ProgressListener>	PROGRESS_LISTENER This GeneralParameterValue can be provided to the GridCoverageReaders through the GridCoverageReader#write(GeneralParameterValue[]) method in order to monitor a writing process
static DefaultParameterDescriptor<GridGeometry2D>	READ_GRIDGEOMETRY2D This GeneralParameterValue ccn be provided to the GridCoverageReaders through the GridCoverageReader.read(GeneralParameterValue[]) method in order to pick up the best matching resolution level and (soon) the best matching area.
protected ParameterValueGroup	readParameters ParameterValueGroup that controls the reading process for a GridCoverageReader through the GridCoverageReader.read(org.opengis.parameter.GeneralParameterValue[]) method.
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_JAI_IMAGEREAD This GeneralParameterValue can be provided to the GridCoverageReaders through the GridCoverageReader.read(GeneralParameterValue[]) method in order to specify the type of image read operation requested: using a JAI ImageRead operation (leveraging on Deferred Execution Model, Tile Caching,...), or the direct ImageReader's read methods.
protected ParameterValueGroup	writeParameters ParameterValueGroup that controls the writing process for a GridCoverageWriter through the GridCoverageWriter.write(org.opengis.coverage.grid.GridCoverage, org.opengis.parameter.GeneralParameterValue[]) method.

Constructor Summary

AbstractGridFormat()

Method Summary

boolean	accepts(Object source) Tells me if this Format can read the provided input.
abstract boolean	accepts(Object source, Hints hints) Tells me if this Format can read the provided input.
boolean	equals(Format f)
static CoordinateReferenceSystem	getDefaultCRS() getDefaultCRS This method provides the user with a default crs WGS84
abstract 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.
String	getDescription() Description of the file format.
String	getDocURL() Documentation URL for the format.
String	getName() Name of the file format.
abstract AbstractGridCoverage2DReader	getReader(Object source) Gets a GridCoverageReader for this format able to create coverages out of the source object.
abstract AbstractGridCoverage2DReader	getReader(Object source, Hints hints) Gets a GridCoverageReader for this format able to create coverages out of the source object using the provided hints.
ParameterValueGroup	getReadParameters() Retrieve the parameter information for a read operation.
String	getVendor() Vendor or agency for the format.
String	getVersion() Version number of the format.
ParameterValueGroup	getWriteParameters() Retrieve the parameter information for a write operation.
abstract GridCoverageWriter	getWriter(Object destination) Retrieves a GridCoverageWriter suitable for writing to the provided destination with this format.
abstract GridCoverageWriter	getWriter(Object destination, Hints hints) Call the accepts() method before asking for a writer to determine if the current object is supported.

Methods inherited from class Object

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

Field Detail

mInfo

protected Map<String,String> mInfo

The Map object is used by the information methods(such as getName()) as a data source. The keys in the Map object (for the associated method) are as follows: getName() key = "name" value type=String getDescription() key = "description" value type=String getVendor() key = "vendor" value type=String getDocURL() key = "docURL" value type=String getVersion() key = "version" value type=String Naturally, any methods that are overridden need not have an entry in the Map

readParameters

protected ParameterValueGroup readParameters

ParameterValueGroup that controls the reading process for a GridCoverageReader through the GridCoverageReader.read(org.opengis.parameter.GeneralParameterValue[]) method.

writeParameters

protected ParameterValueGroup writeParameters

ParameterValueGroup that controls the writing process for a GridCoverageWriter through the GridCoverageWriter.write(org.opengis.coverage.grid.GridCoverage, org.opengis.parameter.GeneralParameterValue[]) method.

READ_GRIDGEOMETRY2D

public static final DefaultParameterDescriptor<GridGeometry2D> READ_GRIDGEOMETRY2D

This GeneralParameterValue ccn be provided to the GridCoverageReaders through the GridCoverageReader.read(GeneralParameterValue[]) method in order to pick up the best matching resolution level and (soon) the best matching area.

PROGRESS_LISTENER

public static final DefaultParameterDescriptor<ProgressListener> PROGRESS_LISTENER

This GeneralParameterValue can be provided to the GridCoverageReaders through the GridCoverageReader#write(GeneralParameterValue[]) method in order to monitor a writing process

GEOTOOLS_WRITE_PARAMS

public static final DefaultParameterDescriptor<GeoToolsWriteParams> GEOTOOLS_WRITE_PARAMS

This GeneralParameterValue cacn be provided to the GridCoverageWriters through the GridCoverageWriter.write(org.opengis.coverage.grid.GridCoverage, GeneralParameterValue[]) method in order to control the writing process in terms of compression, tiling, etc.GridGeometry2D

USE_JAI_IMAGEREAD

public static final DefaultParameterDescriptor<Boolean> USE_JAI_IMAGEREAD

This GeneralParameterValue can be provided to the GridCoverageReaders through the GridCoverageReader.read(GeneralParameterValue[]) method in order to specify the type of image read operation requested: using a JAI ImageRead operation (leveraging on Deferred Execution Model, Tile Caching,...), or the direct ImageReader's read methods.

OVERVIEW_POLICY

public static final DefaultParameterDescriptor<OverviewPolicy> OVERVIEW_POLICY

This GeneralParameterValue can be provided to the GridCoverageReaders through the GridCoverageReader.read(GeneralParameterValue[]) method in order to specify the policy a reader should adopt when choosing the right overview during a read operation.

DECIMATION_POLICY

public static final ParameterDescriptor<DecimationPolicy> DECIMATION_POLICY

This GeneralParameterValue can be provided to the GridCoverageReaders through the GridCoverageReader.read(GeneralParameterValue[]) method in order to specify the policy a reader should adopt when setting read parameters when evaluating a needed resolution.

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

INPUT_TRANSPARENT_COLOR

public static final ParameterDescriptor<Color> INPUT_TRANSPARENT_COLOR

Control the transparency of the input coverages.

BACKGROUND_COLOR

public static final ParameterDescriptor<Color> BACKGROUND_COLOR

Control the background color to be used where the input was transparent

Constructor Detail

AbstractGridFormat

public AbstractGridFormat()

Method Detail

getName

public String getName()

Description copied from interface: Format

Name of the file format.

Specified by:

getName in interface Format

See Also:

Format.getName()

getDescription

public String getDescription()

Description copied from interface: Format

Description of the file format. If no description, the value will be null.

Specified by:

getDescription in interface Format

See Also:

Format.getDescription()

getVendor

public String getVendor()

Description copied from interface: Format

Vendor or agency for the format.

Specified by:

getVendor in interface Format

See Also:

Format.getVendor()

getDocURL

public String getDocURL()

Description copied from interface: Format

Documentation URL for the format.

Specified by:

getDocURL in interface Format

See Also:

Format.getDocURL()

getVersion

public String getVersion()

Description copied from interface: Format

Version number of the format.

Specified by:

getVersion in interface Format

See Also:

Format.getVersion()

getReader

public abstract AbstractGridCoverage2DReader getReader(Object source)

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.

Parameters:

source - The source object to parse.

Returns:

A reader for this Format or null.

getReader

public abstract AbstractGridCoverage2DReader getReader(Object source,
                                                       Hints hints)

Gets a GridCoverageReader for this format able to create coverages out of the source object using the provided hints.

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

Parameters:

source - The source object to parse. *

hints - The Hints to use when trying to instantiate this reader.

Returns:

A reader for this Format or null.

getWriter

public abstract GridCoverageWriter getWriter(Object destination)

Retrieves a GridCoverageWriter suitable for writing to the provided destination with this format.

In case no writers are availaible null is returned.

Parameters:

destination - The destinatin where to write.

Returns:

A GridCoverageWriter suitable for writing to the provided destination with this format.

accepts

public boolean accepts(Object source)

Tells me if this Format can read the provided input.

Parameters:

input - The input object to test for suitability.

Returns:

True if this format can read this object, False otherwise.

accepts

public abstract boolean accepts(Object source,
                                Hints hints)

Tells me if this Format can read the provided input.

Parameters:

input - The input object to test for suitability.

hints - Hints to control the accepts internal machinery.

Returns:

True if this format can read this object, False otherwise.

equals

public boolean equals(Format f)

See Also:

org.geotools.data.coverage.grid.Format#equals(org.geotools.data.coverage.grid.Format)

getReadParameters

public ParameterValueGroup getReadParameters()

Description copied from interface: Format

Retrieve the parameter information for a read operation.

Specified by:

getReadParameters in interface Format

getWriteParameters

public ParameterValueGroup getWriteParameters()

Description copied from interface: Format

Retrieve the parameter information for a write operation.

Specified by:

getWriteParameters in interface Format

getDefaultCRS

public static CoordinateReferenceSystem getDefaultCRS()

getDefaultCRS This method provides the user with a default crs WGS84

getDefaultImageIOWriteParameters

public abstract 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.

Returns:

an instance of ImageWriteParam.

getWriter

public abstract GridCoverageWriter getWriter(Object destination,
                                             Hints hints)

Call the accepts() method before asking for a writer to determine if the current object is supported.

Parameters:

destination - the destination object to write a WorldImage to

hints - Hints to control the internal machinery.

Returns:

a new WorldImageWriter for the destination