com.sun.media.imageioimpl.plugins.jpeg2000

Class J2KMetadata

java.lang.Object

javax.imageio.metadata.IIOMetadata

com.sun.media.imageioimpl.plugins.jpeg2000.J2KMetadata

All Implemented Interfaces:

Cloneable

public class J2KMetadata
extends IIOMetadata
implements Cloneable

Metadata for the J2K plug-in.

Field Summary

Fields

Modifier and Type	Field and Description
private ArrayList	boxes The boxes of JP2 file used as meta data, i.
private J2KMetadataFormat	format cache the metadata format
(package private) static String	nativeMetadataFormatName

Fields inherited from class javax.imageio.metadata.IIOMetadata

controller, defaultController, extraMetadataFormatClassNames, extraMetadataFormatNames, nativeMetadataFormatClassName, standardFormatSupported

Constructor Summary

Constructors

Constructor and Description
J2KMetadata() Constructor containing code shared by other constructors.
J2KMetadata(ColorModel colorModel, SampleModel sampleModel, int width, int height, ImageWriteParam param, ImageWriter writer) Constructs a default image J2KMetadata object appropriate for the given image type and write parameters.
J2KMetadata(ImageInputStream iis, J2KImageReader reader)
J2KMetadata(ImageTypeSpecifier imageType, ImageWriteParam param, ImageWriter writer) Constructs a default image J2KMetadata object appropriate for the given image type and write parameters.
J2KMetadata(ImageWriteParam param, ImageWriter writer) Constructs a default stream J2KMetadata object appropriate for the given write parameters.

Method Summary

Methods

Modifier and Type	Method and Description
void	addNode(Box node)
private boolean	checkUUIDInfoBox(Node node, String childName) Check whether the child with a name childName exists.
Object	clone()
private void	createBitsPerComponentBoxFromStandardNode(Node node)
private void	createChannelDefinitionFromStandardNode(Node node)
private void	createColorSpecificationBoxFromStandardNode(Node node)
private void	createHeaderBoxFromStandardNode(Node node, int numComps)
private IIOMetadataNode	createNodeIntoTree(IIOMetadataNode root, String name)
private void	createPaletteBoxFromStandardNode(Node node)
private void	createResolutionBoxFromStandardNode(Node node)
private void	createXMLBoxFromStandardNode(Node node)
Node	getAsTree(String formatName)
Box	getElement(String name)
(package private) IIOMetadataNode	getNativeTree()
private IIOMetadataNode	getNodeFromTree(IIOMetadataNode root, String name, String childName)
protected IIOMetadataNode	getStandardChromaNode()
protected IIOMetadataNode	getStandardCompressionNode()
protected IIOMetadataNode	getStandardDataNode()
protected IIOMetadataNode	getStandardDimensionNode()
protected IIOMetadataNode	getStandardTextNode()
protected IIOMetadataNode	getStandardTransparencyNode()
private boolean	insertNodeIntoTree(IIOMetadataNode root, IIOMetadataNode node)
private boolean	isOriginalSigned(SampleModel sampleModel)
boolean	isReadOnly()
private void	mergeNativeTree(Node root)
private void	mergeStandardTree(Node root)
void	mergeTree(String formatName, Node root)
private void	replace(String name, Box box)
void	reset()
void	setFromTree(String formatName, Node root)

Methods inherited from class javax.imageio.metadata.IIOMetadata

activateController, getController, getDefaultController, getExtraMetadataFormatNames, getMetadataFormat, getMetadataFormatNames, getNativeMetadataFormatName, getStandardDocumentNode, getStandardTileNode, getStandardTree, hasController, isStandardMetadataFormatSupported, setController

Methods inherited from class java.lang.Object

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

Field Detail

nativeMetadataFormatName

static final String nativeMetadataFormatName

See Also:

Constant Field Values

format

private J2KMetadataFormat format

cache the metadata format

boxes

private ArrayList boxes

The boxes of JP2 file used as meta data, i. e., all the boxes except the data stream box

Constructor Detail

J2KMetadata

public J2KMetadata()

Constructor containing code shared by other constructors.

J2KMetadata

public J2KMetadata(ImageInputStream iis,
           J2KImageReader reader)
            throws IOException

Throws:

IOException

J2KMetadata

public J2KMetadata(ImageWriteParam param,
           ImageWriter writer)

Constructs a default stream J2KMetadata object appropriate for the given write parameters.

J2KMetadata

public J2KMetadata(ImageTypeSpecifier imageType,
           ImageWriteParam param,
           ImageWriter writer)

Constructs a default image J2KMetadata object appropriate for the given image type and write parameters.

J2KMetadata

public J2KMetadata(ColorModel colorModel,
           SampleModel sampleModel,
           int width,
           int height,
           ImageWriteParam param,
           ImageWriter writer)

Constructs a default image J2KMetadata object appropriate for the given image type and write parameters.

Method Detail

clone

public Object clone()

Overrides:

clone in class Object

getAsTree

public Node getAsTree(String formatName)

Specified by:

getAsTree in class IIOMetadata

getNativeTree

IIOMetadataNode getNativeTree()

getStandardChromaNode

protected IIOMetadataNode getStandardChromaNode()

Overrides:

getStandardChromaNode in class IIOMetadata

getStandardCompressionNode

protected IIOMetadataNode getStandardCompressionNode()

Overrides:

getStandardCompressionNode in class IIOMetadata

getStandardDataNode

protected IIOMetadataNode getStandardDataNode()

Overrides:

getStandardDataNode in class IIOMetadata

getStandardDimensionNode

protected IIOMetadataNode getStandardDimensionNode()

Overrides:

getStandardDimensionNode in class IIOMetadata

getStandardTransparencyNode

protected IIOMetadataNode getStandardTransparencyNode()

Overrides:

getStandardTransparencyNode in class IIOMetadata

getStandardTextNode

protected IIOMetadataNode getStandardTextNode()

Overrides:

getStandardTextNode in class IIOMetadata

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in class IIOMetadata

mergeTree

public void mergeTree(String formatName,
             Node root)
               throws IIOInvalidTreeException

Specified by:

mergeTree in class IIOMetadata

Throws:

IIOInvalidTreeException

setFromTree

public void setFromTree(String formatName,
               Node root)
                 throws IIOInvalidTreeException

Overrides:

setFromTree in class IIOMetadata

Throws:

IIOInvalidTreeException

reset

public void reset()

Specified by:

reset in class IIOMetadata

addNode

public void addNode(Box node)

getElement

public Box getElement(String name)

mergeNativeTree

private void mergeNativeTree(Node root)
                      throws IIOInvalidTreeException

Throws:

IIOInvalidTreeException

mergeStandardTree

private void mergeStandardTree(Node root)
                        throws IIOInvalidTreeException

Throws:

IIOInvalidTreeException

createColorSpecificationBoxFromStandardNode

private void createColorSpecificationBoxFromStandardNode(Node node)

createPaletteBoxFromStandardNode

private void createPaletteBoxFromStandardNode(Node node)

createBitsPerComponentBoxFromStandardNode

private void createBitsPerComponentBoxFromStandardNode(Node node)

createResolutionBoxFromStandardNode

private void createResolutionBoxFromStandardNode(Node node)

createXMLBoxFromStandardNode

private void createXMLBoxFromStandardNode(Node node)

createHeaderBoxFromStandardNode

private void createHeaderBoxFromStandardNode(Node node,
                                   int numComps)

createChannelDefinitionFromStandardNode

private void createChannelDefinitionFromStandardNode(Node node)

replace

private void replace(String name,
           Box box)

insertNodeIntoTree

private boolean insertNodeIntoTree(IIOMetadataNode root,
                         IIOMetadataNode node)

getNodeFromTree

private IIOMetadataNode getNodeFromTree(IIOMetadataNode root,
                              String name,
                              String childName)

createNodeIntoTree

private IIOMetadataNode createNodeIntoTree(IIOMetadataNode root,
                                 String name)

isOriginalSigned

private boolean isOriginalSigned(SampleModel sampleModel)

checkUUIDInfoBox

private boolean checkUUIDInfoBox(Node node,
                       String childName)

Check whether the child with a name childName exists. This method is designed because UUID info box may have many instances. So if one of its sub-box is inserted into the tree, an empty slut for this sub-box has to be find or created to avoid one UUID info box has duplicated sub-boxes. The users have to guarantee each UUID info box has all the sub-boxes.