org.geotools.gce.arcgrid
Class ArcGridFormat

Object
  extended by AbstractGridFormat
      extended by ArcGridFormat
All Implemented Interfaces:
Format

public final class ArcGridFormat
extends AbstractGridFormat
implements Format

An implementation a Format for the ASCII grid ESRI and GRASS format.

Author:
Daniele Romagnoli, Simone Giannecchini (simboss)

Field Summary
static DefaultParameterDescriptor<Boolean> FORCE_CELLSIZE
          Indicates whether we ask the plugin to resample the coverage to have dx==dy
static DefaultParameterDescriptor<Boolean> GRASS
          Indicates whether the arcgrid data must be written in GRASS format
 
Fields inherited from class AbstractGridFormat
BACKGROUND_COLOR, DECIMATION_POLICY, ELEVATION, GEOTOOLS_WRITE_PARAMS, INPUT_TRANSPARENT_COLOR, mInfo, OVERVIEW_POLICY, PROGRESS_LISTENER, READ_GRIDGEOMETRY2D, readParameters, SUGGESTED_TILE_SIZE, TILE_SIZE_SEPARATOR, TIME, USE_JAI_IMAGEREAD, writeParameters
 
Constructor Summary
ArcGridFormat()
          Creates an instance and sets the metadata.
 
Method Summary
 boolean accepts(Object input, Hints hints)
          Tells me if this Format can read the provided input.
 GeoToolsWriteParams getDefaultImageIOWriteParameters()
          Retrieves the default instance for the ArcGridFormat of the GeoToolsWriteParams to control the writing process.
 ArcGridReader getReader(Object source)
          Gets a GridCoverageReader for this format able to create coverages out of the source object.
 ArcGridReader 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
 
Methods inherited from interface Format
getDescription, getDocURL, getName, getReadParameters, getVendor, getVersion, getWriteParameters
 

Field Detail

GRASS

public static final DefaultParameterDescriptor<Boolean> GRASS
Indicates whether the arcgrid data must be written in GRASS format


FORCE_CELLSIZE

public static final DefaultParameterDescriptor<Boolean> FORCE_CELLSIZE
Indicates whether we ask the plugin to resample the coverage to have dx==dy

Constructor Detail

ArcGridFormat

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

Method Detail

getReader

public ArcGridReader 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:
org.geotools.data.coverage.grid.AbstractGridFormat#createWriter(java.lang.Object destination)

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
See Also:
org.geotools.data.coverage.grid.AbstractGridFormat#createWriter(java.lang.Object destination,Hints hints)

accepts

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

Specified by:
accepts in class AbstractGridFormat
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 ArcGridReader 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.
See Also:
org.geotools.data.coverage.grid.AbstractGridFormat#getReader(Object, Hints)

getDefaultImageIOWriteParameters

public GeoToolsWriteParams getDefaultImageIOWriteParameters()
Retrieves the default instance for the ArcGridFormat of the GeoToolsWriteParams to control the writing process.

Specified by:
getDefaultImageIOWriteParameters in class AbstractGridFormat
Returns:
a default instance for the ArcGridFormat of the GeoToolsWriteParams to control the writing process.


Copyright © 1996-2014 Geotools. All Rights Reserved.