Package org.geotools.gce.image

Class WorldImageWriter

Object

AbstractGridCoverageWriter

WorldImageWriter

All Implemented Interfaces:

GridCoverageWriter

public final class WorldImageWriter
extends AbstractGridCoverageWriter
implements GridCoverageWriter

Writes a GridCoverage to a raster image file and an accompanying world file. The destination specified must point to the location of the raster file to write to, as this is how the format is determined. The directory that file is located in must also already exist.

Author:

Simone Giannecchini, GeoSolutions, rgould, Alessio Fabiani, GeoSolutions

Field Summary

Fields inherited from class AbstractGridCoverageWriter

destination, hints, outStream

Constructor Summary

Constructors

Constructor	Description
WorldImageWriter(Object destination)	Destination must be a File.
WorldImageWriter(Object destination, Hints hints)	Destination must be a File.

Method Summary

Modifier and Type	Method	Description
Format	getFormat()	(non-Javadoc)
void	write(GridCoverage coverage, GeneralParameterValue[] parameters)	Takes a GridCoverage and writes the image to the destination file.

Methods inherited from class AbstractGridCoverageWriter

dispose, finalize, getDestination, getMetadataNames, setCurrentSubname, setMetadataValue

Methods inherited from class Object

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

Methods inherited from interface GridCoverageWriter

dispose, getDestination, getMetadataNames, setCurrentSubname, setMetadataValue

Constructor Detail

WorldImageWriter

public WorldImageWriter(Object destination)

Destination must be a File. The directory it resides in must already exist. It must point to where the raster image is to be located. The world image will be derived from there.

WorldImageWriter

public WorldImageWriter(Object destination,
                        Hints hints)

Destination must be a File. The directory it resides in must already exist. It must point to where the raster image is to be located. The world image will be derived from there.

Method Detail

getFormat

public Format getFormat()

(non-Javadoc)

Specified by:

getFormat in interface GridCoverageWriter

See Also:

GridCoverageWriter.getFormat()

write

public void write(GridCoverage coverage,
                  GeneralParameterValue[] parameters)
           throws IllegalArgumentException,
                  IOException

Takes a GridCoverage and writes the image to the destination file. It then reads the format of the file and writes an accompanying world file. It will throw a FileFormatNotCompatibleWithGridCoverageException if Destination is not a File (URL is a read-only format!).

Specified by:

write in interface GridCoverageWriter

Parameters:

coverage - the GridCoverage to write.

parameters - no parameters are accepted. Currently ignored.

Throws:

InvalidParameterNameException - if a parameter in parameters doesn't have a recognized name.

InvalidParameterValueException - if a parameter in parameters doesn't have a valid value.

ParameterNotFoundException - if a parameter was required for the operation but was not provided in the parameters list.

IOException - if the export failed for some other input/output reason, including IIOException if an error was thrown by the underlying image library.

IllegalArgumentException

See Also:

GridCoverageWriter.write(org.geotools.gc.GridCoverage, org.geotools.api.parameter.GeneralParameterValue[])