javax.imageio.metadata

Class IIOMetadata

java.lang.Object

javax.imageio.metadata.IIOMetadata

public abstract class IIOMetadata
extends java.lang.Object

Represents metadata that describe an image or an image stream. Each ImageIO plugin will represent image data using an opaque object but all such objects should expose their internal information as a tree of IIOMetadataNodes. There are three formats of metadata that a plugin can support:

• a "native" format
• a custom format
• a standard plugin-neutral format

If a plugin supports more than one format of metadata, the other formats can be retrieved by calling getMetadataFormatNames. The native format is used to transfer metadata from one image to another image of the same type, losslessly. The custom format describes the image metadata and exposes a tree of IIOMetadataNodes but its internal representation is specific to this plugin. The plugin-neutral format uses a generic tree structure as its internal representation. ImageTranscoders may be used to convert metadata understood by one plugin to metadata understood by another, however the conversion may be lossy.

Field Summary

Fields

Modifier and Type	Field and Description
protected IIOMetadataController	controller
protected IIOMetadataController	defaultController
protected java.lang.String[]	extraMetadataFormatClassNames
protected java.lang.String[]	extraMetadataFormatNames
protected java.lang.String	nativeMetadataFormatClassName
protected java.lang.String	nativeMetadataFormatName
protected boolean	standardFormatSupported

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IIOMetadata() Construct an IIOMetadata object.
protected	IIOMetadata(boolean standardMetadataFormatSupported, java.lang.String nativeMetadataFormatName, java.lang.String nativeMetadataFormatClassName, java.lang.String[] extraMetadataFormatNames, java.lang.String[] extraMetadataFormatClassNames) Construct an IIOMetadata object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	activateController()
abstract org.w3c.dom.Node	getAsTree(java.lang.String formatName)
IIOMetadataController	getController()
IIOMetadataController	getDefaultController()
java.lang.String[]	getExtraMetadataFormatNames()
IIOMetadataFormat	getMetadataFormat(java.lang.String formatName)
java.lang.String[]	getMetadataFormatNames()
java.lang.String	getNativeMetadataFormatName()
protected IIOMetadataNode	getStandardChromaNode()
protected IIOMetadataNode	getStandardCompressionNode()
protected IIOMetadataNode	getStandardDataNode()
protected IIOMetadataNode	getStandardDimensionNode()
protected IIOMetadataNode	getStandardDocumentNode()
protected IIOMetadataNode	getStandardTextNode()
protected IIOMetadataNode	getStandardTileNode()
protected IIOMetadataNode	getStandardTransparencyNode()
protected IIOMetadataNode	getStandardTree()
boolean	hasController()
abstract boolean	isReadOnly()
boolean	isStandardMetadataFormatSupported()
abstract void	mergeTree(java.lang.String formatName, org.w3c.dom.Node root)
abstract void	reset()
void	setController(IIOMetadataController controller)
void	setFromTree(java.lang.String formatName, org.w3c.dom.Node root)

Methods inherited from class java.lang.Object

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

Field Detail

controller

protected IIOMetadataController controller

defaultController

protected IIOMetadataController defaultController

extraMetadataFormatClassNames

protected java.lang.String[] extraMetadataFormatClassNames

extraMetadataFormatNames

protected java.lang.String[] extraMetadataFormatNames

nativeMetadataFormatClassName

protected java.lang.String nativeMetadataFormatClassName

nativeMetadataFormatName

protected java.lang.String nativeMetadataFormatName

standardFormatSupported

protected boolean standardFormatSupported

Constructor Detail

IIOMetadata

protected IIOMetadata()

Construct an IIOMetadata object.

IIOMetadata

protected IIOMetadata(boolean standardMetadataFormatSupported,
           java.lang.String nativeMetadataFormatName,
           java.lang.String nativeMetadataFormatClassName,
           java.lang.String[] extraMetadataFormatNames,
           java.lang.String[] extraMetadataFormatClassNames)

Construct an IIOMetadata object.

Parameters:

standardMetadataFormatSupported -

nativeMetadataFormatName -

nativeMetadataFormatClassName -

extraMetadataFormatNames -

extraMetadataFormatClassNames -

Throws:

java.lang.IllegalArgumentException - if extraMetadataFormatNames has length of zero or extraMetadataFormatNames and extraMetadataFormatClassNames are neither both null, not have the same length

Method Detail

activateController

public boolean activateController()

getController

public IIOMetadataController getController()

getDefaultController

public IIOMetadataController getDefaultController()

getExtraMetadataFormatNames

public java.lang.String[] getExtraMetadataFormatNames()

getMetadataFormat

public IIOMetadataFormat getMetadataFormat(java.lang.String formatName)

getMetadataFormatNames

public java.lang.String[] getMetadataFormatNames()

getNativeMetadataFormatName

public java.lang.String getNativeMetadataFormatName()

hasController

public boolean hasController()

isReadOnly

public abstract boolean isReadOnly()

isStandardMetadataFormatSupported

public boolean isStandardMetadataFormatSupported()

reset

public abstract void reset()

setController

public void setController(IIOMetadataController controller)

getAsTree

public abstract org.w3c.dom.Node getAsTree(java.lang.String formatName)

getStandardChromaNode

protected IIOMetadataNode getStandardChromaNode()

getStandardCompressionNode

protected IIOMetadataNode getStandardCompressionNode()

getStandardDataNode

protected IIOMetadataNode getStandardDataNode()

getStandardDimensionNode

protected IIOMetadataNode getStandardDimensionNode()

getStandardDocumentNode

protected IIOMetadataNode getStandardDocumentNode()

getStandardTextNode

protected IIOMetadataNode getStandardTextNode()

getStandardTileNode

protected IIOMetadataNode getStandardTileNode()

getStandardTransparencyNode

protected IIOMetadataNode getStandardTransparencyNode()

getStandardTree

protected final IIOMetadataNode getStandardTree()

mergeTree

public abstract void mergeTree(java.lang.String formatName,
             org.w3c.dom.Node root)
                        throws IIOInvalidTreeException

Throws:

IIOInvalidTreeException

setFromTree

public void setFromTree(java.lang.String formatName,
               org.w3c.dom.Node root)
                 throws IIOInvalidTreeException

Throws:

IIOInvalidTreeException