Package org.geotools.gce.imagepyramid

Class ImagePyramidFormat

Object

AbstractGridFormat

ImagePyramidFormat

All Implemented Interfaces:

Format

public final class ImagePyramidFormat
extends AbstractGridFormat
implements Format

This class implements the basic format capabilities for a coverage format.

Author:

Simone Giannecchini (simboss), Stefan Alfons Krueger (alfonx), Wikisquare.de : Support for jar:file:foo.jar/bar.properties like URLs

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
ImagePyramidFormat()	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()	Throw an exception since this plugin is readonly.
ImagePyramidReader	getReader(Object source)	Retrieves a reader for this source object in case the provided source can be read using this plugin.
ImagePyramidReader	getReader(Object source, Hints hints)	Retrieves a reader for this source object in case the provided source can be read using this plugin.
GridCoverageWriter	getWriter(Object destination)	This methods throw an UnsupportedOperationException because this plugiin si read only.
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

Methods inherited from interface Format

getDescription, getDocURL, getName, getReadParameters, getVendor, getVersion, getWriteParameters

Constructor Detail

ImagePyramidFormat

public ImagePyramidFormat()

Creates an instance and sets the metadata.

Method Detail

getReader

public ImagePyramidReader getReader(Object source)

Retrieves a reader for this source object in case the provided source can be read using this plugin.

Specified by:

getReader in class AbstractGridFormat

Parameters:

source - Object

Returns:

An ImagePyramidReader if the provided object can be read using this plugin or null.

getWriter

public GridCoverageWriter getWriter(Object destination)

This methods throw an UnsupportedOperationException because this plugiin si read only.

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.

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.

See Also:

org.geotools.data.coverage.grid.AbstractGridFormat#accepts(Object input)

getReader

public ImagePyramidReader getReader(Object source,
                                    Hints hints)

Retrieves a reader for this source object in case the provided source can be read using this plugin.

Specified by:

getReader in class AbstractGridFormat

Parameters:

source - Object

hints - Hints to control the reader behaviour.

Returns:

An ImagePyramidReader if the provided object can be read using this plugin or null.

getDefaultImageIOWriteParameters

public GeoToolsWriteParams getDefaultImageIOWriteParameters()

Throw an exception since this plugin is readonly.

Specified by:

getDefaultImageIOWriteParameters in class AbstractGridFormat

Returns:

nothing.

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