org.geotools.gce.geotiff
Class GeoTiffWriter

Object
  extended by AbstractGridCoverageWriter
      extended by GeoTiffWriter
All Implemented Interfaces:
GridCoverageWriter

public class GeoTiffWriter
extends AbstractGridCoverageWriter
implements GridCoverageWriter

AbstractGridCoverageWriter implementation for the geotiff format.

Author:
Simone Giannecchini, GeoSolutions SAS

Field Summary
 
Fields inherited from class AbstractGridCoverageWriter
destination, hints, outStream
 
Constructor Summary
GeoTiffWriter(Object destination)
          Constructor for a GeoTiffWriter.
GeoTiffWriter(Object destination, Hints hints)
          Constructor for a GeoTiffWriter.
 
Method Summary
static IIOMetadata createGeoTiffIIOMetadata(ImageWriter writer, ImageTypeSpecifier type, GeoTiffIIOMetadataEncoder geoTIFFMetadata, ImageWriteParam params)
          Creates image metadata which complies to the GeoTIFFWritingUtilities specification for the given image writer, image type and GeoTIFFWritingUtilities metadata.
 void dispose()
          Releases resources held by this AbstractGridCoverageWriter.
 Format getFormat()
          Returns the format handled by this GridCoverageWriter.
 void setMetadataValue(String name, String value)
          Allows to setup metadata by leveraging on Ascii TIFF Tags.
 void write(GridCoverage gc, GeneralParameterValue[] params)
          Writes the specified grid coverage.
 
Methods inherited from class AbstractGridCoverageWriter
finalize, getDestination, getMetadataNames, setCurrentSubname
 
Methods inherited from class Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface GridCoverageWriter
getDestination, getMetadataNames, setCurrentSubname
 

Constructor Detail

GeoTiffWriter

public GeoTiffWriter(Object destination)
              throws IOException
Constructor for a GeoTiffWriter.

Parameters:
destination -
Throws:
IOException

GeoTiffWriter

public GeoTiffWriter(Object destination,
                     Hints hints)
              throws IOException
Constructor for a GeoTiffWriter.

Parameters:
destination -
hints -
Throws:
IOException
Method Detail

setMetadataValue

public void setMetadataValue(String name,
                             String value)
                      throws IOException
Allows to setup metadata by leveraging on Ascii TIFF Tags.

Specified by:
setMetadataValue in interface GridCoverageWriter
Overrides:
setMetadataValue in class AbstractGridCoverageWriter
Parameters:
name - is the Ascii TIFF Tag identifier. It can be a String representing: 1) a simple Integer (referring to a tag ID) (in that case it will refer to the BaselineTIFFTagSet 2) OR an identifier in the form: TIFFTagSet:TIFFTagID. As an instance: "BaselineTIFFTagSet:305" in order to add the Copyright info.
value - is the value to be assigned to that tag.
Throws:
IOException - if an error occurs during writing.
See Also:
GeoTiffIIOMetadataEncoder.TagSet

getFormat

public Format getFormat()
Description copied from interface: GridCoverageWriter
Returns the format handled by this GridCoverageWriter.

Specified by:
getFormat in interface GridCoverageWriter

write

public void write(GridCoverage gc,
                  GeneralParameterValue[] params)
           throws IllegalArgumentException,
                  IOException,
                  IndexOutOfBoundsException
Description copied from interface: GridCoverageWriter
Writes the specified grid coverage.

Specified by:
write in interface GridCoverageWriter
Parameters:
gc - The grid coverage to write.
params - An optional set of parameters. Should be any or all of the parameters returned by Format.getWriteParameters().
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
IndexOutOfBoundsException

createGeoTiffIIOMetadata

public static final IIOMetadata createGeoTiffIIOMetadata(ImageWriter writer,
                                                         ImageTypeSpecifier type,
                                                         GeoTiffIIOMetadataEncoder geoTIFFMetadata,
                                                         ImageWriteParam params)
                                                  throws IIOException
Creates image metadata which complies to the GeoTIFFWritingUtilities specification for the given image writer, image type and GeoTIFFWritingUtilities metadata.

Parameters:
writer - the image writer, must not be null
type - the image type, must not be null
geoTIFFMetadata - the GeoTIFFWritingUtilities metadata, must not be null
params -
Returns:
the image metadata, never null
Throws:
IIOException - if the metadata cannot be created

dispose

public void dispose()
Description copied from class: AbstractGridCoverageWriter
Releases resources held by this AbstractGridCoverageWriter.

Specified by:
dispose in interface GridCoverageWriter
Overrides:
dispose in class AbstractGridCoverageWriter


Copyright © 1996-2014 Geotools. All Rights Reserved.