org.geotools.gce.imagepyramid
Class ImagePyramidFormat

Object
  extended by AbstractGridFormat
      extended by 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)

Field Summary
static DefaultParameterDescriptor FADING
          Control the type of the final mosaic.
static DefaultParameterDescriptor INPUT_IMAGE_THRESHOLD_VALUE
          Control the thresholding on the input coverage
static DefaultParameterDescriptor INPUT_TRANSPARENT_COLOR
          Control the transparency of the output coverage.
static DefaultParameterDescriptor OUTPUT_TRANSPARENT_COLOR
          Control the transparency of the output coverage.
 
Fields inherited from class AbstractGridFormat
GEOTOOLS_WRITE_PARAMS, mInfo, OVERVIEW_POLICY, READ_GRIDGEOMETRY2D, readParameters, USE_JAI_IMAGEREAD, writeParameters
 
Constructor Summary
ImagePyramidFormat()
          Creates an instance and sets the metadata.
 
Method Summary
 boolean accepts(Object source)
          Tells me if this Format can read the provided input.
 GeoToolsWriteParams getDefaultImageIOWriteParameters()
          Throw an exception since this plugin is readonly.
 GridCoverageReader getReader(Object source)
          Retrieves a reader for this source object in case the provided source can be read using this plugin.
 GridCoverageReader 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.
 
Methods inherited from class AbstractGridFormat
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
 

Field Detail

OUTPUT_TRANSPARENT_COLOR

public static final DefaultParameterDescriptor OUTPUT_TRANSPARENT_COLOR
Control the transparency of the output coverage.


FADING

public static final DefaultParameterDescriptor FADING
Control the type of the final mosaic.


INPUT_TRANSPARENT_COLOR

public static final DefaultParameterDescriptor INPUT_TRANSPARENT_COLOR
Control the transparency of the output coverage.


INPUT_IMAGE_THRESHOLD_VALUE

public static final DefaultParameterDescriptor INPUT_IMAGE_THRESHOLD_VALUE
Control the thresholding on the input coverage

Constructor Detail

ImagePyramidFormat

public ImagePyramidFormat()
Creates an instance and sets the metadata.

Method Detail

getReader

public GridCoverageReader 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)
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 suitablilty.
Returns:
True if this format can read this object, False otherwise.
See Also:
org.geotools.data.coverage.grid.AbstractGridFormat#accepts(Object input)

getReader

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


Copyright © 1996-2009 Geotools. All Rights Reserved.