it.geosolutions.imageio.plugins.jp2k.box
Class ResolutionBox

Object
  extended by DefaultMutableTreeNode
      extended by BaseJP2KBox
          extended by ResolutionBox
All Implemented Interfaces:
JP2KBox, JP2KBoxMetadata, Serializable, Cloneable, MutableTreeNode, TreeNode

public class ResolutionBox
extends BaseJP2KBox

This class is defined to represent a Resolution Box of JPEG JP2 file format. A Resolution Box has a length, and a fixed type of "resc" (capture resolution) or "resd" (default display resolution). Its contents includes the resolution numerators, denominator, and the exponents for both horizontal and vertical directions.

See Also:
Serialized Form

Field Summary
static int BOX_TYPE
           
static int BOX_TYPE_CAPTURE
           
static int BOX_TYPE_DEFAULT_DISPLAY
           
static String CAP_NAME
           
static String DEF_NAME
           
static String JP2_MD_CAP_NAME
           
static String JP2_MD_DEF_DISP_NAME
           
static String JP2K_MD_NAME
           
static String NAME
           
 
Fields inherited from class DefaultMutableTreeNode
allowsChildren, children, EMPTY_ENUMERATION, parent, userObject
 
Constructor Summary
ResolutionBox(int type, byte[] data)
          Constructs a ResolutionBox from the provided type and content data array.
ResolutionBox(int type, float hRes, float vRes)
          Constructs a ResolutionBox from the provided type and horizontal/vertical resolutions.
ResolutionBox(Node node)
          Constructs a ResolutionBox based on the provided org.w3c.dom.Node.
 
Method Summary
protected  byte[] compose()
          Composes the content byte array from the data elements.
 float getHorizontalResolution()
          Return the horizontal resolution.
 short getHorizontalResolutionDenominator()
           
 byte getHorizontalResolutionExponent()
           
 short getHorizontalResolutionNumerator()
           
 IIOMetadataNode getNativeNode()
          Creates an IIOMetadataNode from this resolution box.
 float getVerticalResolution()
          Return the vertical resolution.
 short getVerticalResolutionDenominator()
           
 byte getVerticalResolutionExponent()
           
 short getVerticalResolutionNumerator()
           
protected  void parse(byte[] data)
          Parse the data elements from the provided content data array.
 
Methods inherited from class BaseJP2KBox
clone, getContent, getExtraLength, getLength, getNativeNodeForSimpleBox, getType, setDefaultAttributes, setExtraLength, setLength, setType, toString
 
Methods inherited from class DefaultMutableTreeNode
add, breadthFirstEnumeration, children, depthFirstEnumeration, getAllowsChildren, getChildAfter, getChildAt, getChildBefore, getChildCount, getDepth, getFirstChild, getFirstLeaf, getIndex, getLastChild, getLastLeaf, getLeafCount, getLevel, getNextLeaf, getNextNode, getNextSibling, getParent, getPath, getPathToRoot, getPreviousLeaf, getPreviousNode, getPreviousSibling, getRoot, getSharedAncestor, getSiblingCount, getUserObject, getUserObjectPath, insert, isLeaf, isNodeAncestor, isNodeChild, isNodeDescendant, isNodeRelated, isNodeSibling, isRoot, pathFromAncestorEnumeration, postorderEnumeration, preorderEnumeration, remove, remove, removeAllChildren, removeFromParent, setAllowsChildren, setParent, setUserObject
 
Methods inherited from class Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface MutableTreeNode
insert, remove, remove, removeFromParent, setParent, setUserObject
 
Methods inherited from interface TreeNode
children, getAllowsChildren, getChildAt, getChildCount, getIndex, getParent, isLeaf
 

Field Detail

BOX_TYPE

public static final int BOX_TYPE
See Also:
Constant Field Values

BOX_TYPE_CAPTURE

public static final int BOX_TYPE_CAPTURE
See Also:
Constant Field Values

BOX_TYPE_DEFAULT_DISPLAY

public static final int BOX_TYPE_DEFAULT_DISPLAY
See Also:
Constant Field Values

NAME

public static final String NAME
See Also:
Constant Field Values

CAP_NAME

public static final String CAP_NAME
See Also:
Constant Field Values

DEF_NAME

public static final String DEF_NAME
See Also:
Constant Field Values

JP2K_MD_NAME

public static final String JP2K_MD_NAME
See Also:
Constant Field Values

JP2_MD_CAP_NAME

public static final String JP2_MD_CAP_NAME
See Also:
Constant Field Values

JP2_MD_DEF_DISP_NAME

public static final String JP2_MD_DEF_DISP_NAME
See Also:
Constant Field Values
Constructor Detail

ResolutionBox

public ResolutionBox(int type,
                     byte[] data)
Constructs a ResolutionBox from the provided type and content data array.


ResolutionBox

public ResolutionBox(int type,
                     float hRes,
                     float vRes)
Constructs a ResolutionBox from the provided type and horizontal/vertical resolutions.


ResolutionBox

public ResolutionBox(Node node)
              throws IIOInvalidTreeException
Constructs a ResolutionBox based on the provided org.w3c.dom.Node.

Throws:
IIOInvalidTreeException
Method Detail

getHorizontalResolution

public float getHorizontalResolution()
Return the horizontal resolution.


getVerticalResolution

public float getVerticalResolution()
Return the vertical resolution.


parse

protected void parse(byte[] data)
Parse the data elements from the provided content data array.

Specified by:
parse in class BaseJP2KBox

getNativeNode

public IIOMetadataNode getNativeNode()
Creates an IIOMetadataNode from this resolution box. The format of this node is defined in the XML dtd and xsd for the JP2 image file.

Specified by:
getNativeNode in interface JP2KBoxMetadata
Overrides:
getNativeNode in class BaseJP2KBox

compose

protected byte[] compose()
Description copied from class: BaseJP2KBox
Composes the content byte array from the data elements.

Specified by:
compose in class BaseJP2KBox

getVerticalResolutionNumerator

public short getVerticalResolutionNumerator()

getHorizontalResolutionNumerator

public short getHorizontalResolutionNumerator()

getVerticalResolutionDenominator

public short getVerticalResolutionDenominator()

getHorizontalResolutionDenominator

public short getHorizontalResolutionDenominator()

getVerticalResolutionExponent

public byte getVerticalResolutionExponent()

getHorizontalResolutionExponent

public byte getHorizontalResolutionExponent()


Copyright © 2006-2010 GeoSolutions. All Rights Reserved.