it.geosolutions.imageio.plugins.arcgrid
Class AsciiGridsImageMetadata

Object
  extended by IIOMetadata
      extended by AsciiGridsImageMetadata

public final class AsciiGridsImageMetadata
extends IIOMetadata

This class represents metadata associated with images and streams.

Author:
Daniele Romagnoli, GeoSolutions., Simone Giannecchini, GeoSolutions.

Nested Class Summary
static class AsciiGridsImageMetadata.RasterSpaceType
          Two available values to define raster space as defined in GeoTiff specifications.
 
Field Summary
static String[] metadataFormatNames
          the list of supported metadata format names.
static String nativeMetadataFormatName
          the native metadata format name
 
Fields inherited from class IIOMetadata
controller, defaultController, extraMetadataFormatClassNames, extraMetadataFormatNames, nativeMetadataFormatClassName, standardFormatSupported
 
Constructor Summary
AsciiGridsImageMetadata()
          Default constructor
AsciiGridsImageMetadata(AsciiGridRaster raster)
          A constructor which uses an input AsciiGridRaster to initialize metadata fields
AsciiGridsImageMetadata(int cols, int rows, double cellsizeX, double cellsizeY, double xll, double yll, boolean isCorner, boolean grass, double inNoData)
          A special constructor which uses parameters provided by the client, to set inner fields
 
Method Summary
 Node getAsTree(String formatName)
          returns the image metadata in a tree corresponding to the provided formatName
 IIOMetadataFormat getMetadataFormat(String formatName)
          IIOMetadataFormat objects are meant to describe the structure of metadata returned from the getAsTree method.
protected  IIOMetadataNode getStandardChromaNode()
          Standard tree node methods
protected  IIOMetadataNode getStandardCompressionNode()
           
 boolean isReadOnly()
           
 void mergeTree(String formatName, Node root)
           
 void reset()
           
 
Methods inherited from class IIOMetadata
activateController, getController, getDefaultController, getExtraMetadataFormatNames, getMetadataFormatNames, getNativeMetadataFormatName, getStandardDataNode, getStandardDimensionNode, getStandardDocumentNode, getStandardTextNode, getStandardTileNode, getStandardTransparencyNode, getStandardTree, hasController, isStandardMetadataFormatSupported, setController, setFromTree
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

nativeMetadataFormatName

public static final String nativeMetadataFormatName
the native metadata format name

See Also:
Constant Field Values

metadataFormatNames

public static final String[] metadataFormatNames
the list of supported metadata format names. In this case, only the native metadata format is supported.

Constructor Detail

AsciiGridsImageMetadata

public AsciiGridsImageMetadata(AsciiGridRaster raster)
A constructor which uses an input AsciiGridRaster to initialize metadata fields

Parameters:
raster - input AsciiGridRaster used to retrieve properties to set inner fields

AsciiGridsImageMetadata

public AsciiGridsImageMetadata()
Default constructor


AsciiGridsImageMetadata

public AsciiGridsImageMetadata(int cols,
                               int rows,
                               double cellsizeX,
                               double cellsizeY,
                               double xll,
                               double yll,
                               boolean isCorner,
                               boolean grass,
                               double inNoData)
A special constructor which uses parameters provided by the client, to set inner fields

Parameters:
cols - the number of columns
rows - the number of rows
cellsizeX - the x size of the grid cell
cellsizeY - the y size of the grid cell
xll - the xllCellCoordinate of the Bounding Box
yll - the yllCellCoordinate of the Bounding Box
isCorner - true if xll represents the xllCorner
grass - true if the Ascii grid is Grass
inNoData - the value associated to noData grid values
Method Detail

getAsTree

public Node getAsTree(String formatName)
returns the image metadata in a tree corresponding to the provided formatName

Specified by:
getAsTree in class IIOMetadata
Parameters:
formatName - The format Name
Returns:
Throws:
IllegalArgumentException - if the formatName is not one of the supported format names

isReadOnly

public boolean isReadOnly()
Specified by:
isReadOnly in class IIOMetadata
See Also:
IIOMetadata.isReadOnly()

mergeTree

public void mergeTree(String formatName,
                      Node root)
               throws IIOInvalidTreeException
Specified by:
mergeTree in class IIOMetadata
Throws:
IIOInvalidTreeException
See Also:
IIOMetadata.mergeTree(java.lang.String, org.w3c.dom.Node)

reset

public void reset()
Specified by:
reset in class IIOMetadata
See Also:
IIOMetadata.reset()

getMetadataFormat

public IIOMetadataFormat getMetadataFormat(String formatName)
IIOMetadataFormat objects are meant to describe the structure of metadata returned from the getAsTree method.

Overrides:
getMetadataFormat in class IIOMetadata
Parameters:
formatName - DOCUMENT ME!
Returns:
DOCUMENT ME!
Throws:
IllegalArgumentException - DOCUMENT ME!

getStandardChromaNode

protected IIOMetadataNode getStandardChromaNode()
Standard tree node methods

Overrides:
getStandardChromaNode in class IIOMetadata

getStandardCompressionNode

protected IIOMetadataNode getStandardCompressionNode()
Overrides:
getStandardCompressionNode in class IIOMetadata


Copyright © 2006-2010 GeoSolutions. All Rights Reserved.