Package org.geotools.tpk

Class TPKFormat

Object

AbstractGridFormat

TPKFormat

All Implemented Interfaces:

Format

public class TPKFormat
extends AbstractGridFormat

Field Summary

Fields inherited from class AbstractGridFormat

BACKGROUND_COLOR, BANDS, DECIMATION_POLICY, ELEVATION, FOOTPRINT_BEHAVIOR, GEOTOOLS_WRITE_PARAMS, INPUT_TRANSPARENT_COLOR, INTERPOLATION, mInfo, OVERVIEW_POLICY, PROGRESS_LISTENER, READ_GRIDGEOMETRY2D, readParameters, RESCALE_PIXELS, SUGGESTED_TILE_SIZE, TILE_SIZE_SEPARATOR, TIME, USE_JAI_IMAGEREAD, writeParameters

Constructor Summary

Constructors

Constructor	Description
TPKFormat()	Creates an instance and sets the metadata.

Method Summary

Modifier and Type	Method	Description
boolean	accepts(Object source, Hints hints)	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.geotools.api.coverage.grid.GridCoverage, org.geotools.api.parameter.GeneralParameterValue[]);
static File	getFileFromSource(Object source)
AbstractGridCoverage2DReader	getReader(Object source)	Gets a GridCoverageReader for this format able to create coverages out of the source object.
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.
GridCoverageWriter	getWriter(Object destination)	Retrieves a GridCoverageWriter suitable for writing to the provided destination with this format.
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 AbstractGridFormat

accepts, equals, getDefaultCRS, getDescription, getDocURL, getName, getReadParameters, getVendor, getVersion, getWriteParameters

Methods inherited from class Object

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

Constructor Detail

TPKFormat

public TPKFormat()

Creates an instance and sets the metadata.

Method Detail

getFileFromSource

public static File getFileFromSource(Object source)

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.

getReader

public AbstractGridCoverage2DReader getReader(Object source,
                                              Hints hints)

Description copied from class: AbstractGridFormat

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.

Specified by:

getReader in class AbstractGridFormat

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 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 available 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.

getWriter

public GridCoverageWriter getWriter(Object destination,
                                    Hints hints)

Description copied from class: AbstractGridFormat

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

Specified by:

getWriter in class AbstractGridFormat

Parameters:

destination - the destination object to write a WorldImage to

hints - Hints to control the internal machinery.

Returns:

a new WorldImageWriter for the destination

accepts

public boolean accepts(Object source,
                       Hints hints)

Description copied from class: AbstractGridFormat

Tells me if this Format can read the provided input.

Specified by:

accepts in class AbstractGridFormat

Parameters:

source - 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.

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.geotools.api.coverage.grid.GridCoverage, org.geotools.api.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.