org.geotools.gc
Class GridCoverageExchange

java.lang.Object
  org.geotools.gc.GridCoverageExchange

public class GridCoverageExchange

extends java.lang.Object

Support for creation of grid coverages from persistent formats as well as exporting a grid coverage to a persistent formats.

Version:

$Id: GridCoverageExchange.java 17672 2006-01-19 00:25:55Z desruisseaux $

Author:

OpenGIS, Martin Desruisseaux

See Also:

GC_GridCoverageExchange

Constructor Summary

GridCoverageExchange()
Default constructor.

Method Summary

GridCoverage	createFromName(java.lang.String name, javax.imageio.ImageReadParam param) Create a new GridCoverage from a grid coverage file.
void	exportTo(GridCoverage gridCoverage, java.lang.String fileFormat, java.io.File fileName) Export a grid coverage to a persistent file format.
java.util.Locale	getLocale() Returns the currently set Locale, or null if none has been set.
void	setLocale(java.util.Locale locale) Sets the current Locale of this GridCoverageExchange to the given value.

Methods inherited from class java.lang.Object

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

Constructor Detail

GridCoverageExchange

public GridCoverageExchange()

Default constructor.

Method Detail

createFromName

public GridCoverage createFromName(java.lang.String name,
                                   javax.imageio.ImageReadParam param)
                            throws java.io.IOException

Create a new GridCoverage from a grid coverage file. This method is meant to allow implementations to create a GridCoverage from any file format.

Parameters:

name - File name (including path) from which to create a grid coverage. This file name can be any valid file name within the underlying operating system of the server or a valid string, such as a URL which specifics a grid coverage.

param - Parameters used to control the reading process, or null if none.

Returns:

The grid coverage.

Throws:

java.io.IOException - if an error occurs during reading.

javax.imageio.IIOException - if a grid coverage can't be create from the specified name.

See Also:

GC_GridCoverageExchange.createFromName(java.lang.String)

exportTo

public void exportTo(GridCoverage gridCoverage,
                     java.lang.String fileFormat,
                     java.io.File fileName)
              throws java.io.IOException

Export a grid coverage to a persistent file format. The file format types are implementation specific. Sample file formats include:

• "GeoTIFF" - GeoTIFF (not yet implemented)
• "PIX" - PCI Geomatics PIX (not yet implemented)
• "HDF-EOS" - NASA HDF-EOS (not yet implemented)
• "NITF" - National Image Transfer Format (not yet implemented)
• "STDS-DEM" - Standard Transfer Data Standard (not yet implemented)
• "PNG" - Portable Network Graphics
• "JPEG" - Joint Photographic Experts Group
• Any other format supported by the Java Image I/O API.

Parameters:

gridCoverage - Source grid coverage.

fileFormat - String which indicates exported file format.

fileName - File name to store grid coverage. This file name can be any valid file name within the underlying operating system of the server.

Throws:

java.io.IOException - if an input/output operation (including RMI) failed.

javax.imageio.IIOException - if the file format is not compatiable with the grid coverage.

See Also:

GC_GridCoverageExchange.exportTo(org.opengis.gc.GC_GridCoverage, java.lang.String, java.lang.String, org.opengis.gc.GC_Parameter[])

setLocale

public void setLocale(java.util.Locale locale)

Sets the current Locale of this GridCoverageExchange to the given value. A value of null removes any previous setting, and indicates that the reader should localize as it sees fit.

getLocale

public java.util.Locale getLocale()

Returns the currently set Locale, or null if none has been set.