javax.imageio.metadata

Class IIOMetadataNode

java.lang.Object

javax.imageio.metadata.IIOMetadataNode

All Implemented Interfaces:

org.w3c.dom.Element, org.w3c.dom.Node, org.w3c.dom.NodeList

public class IIOMetadataNode
extends Object
implements org.w3c.dom.Element, org.w3c.dom.NodeList

A class representing a node in a meta-data tree, which implements the org.w3c.dom.Element interface and additionally allows for the storage of non-textual objects via the getUserObject and setUserObject methods.

This class is not intended to be used for general XML processing. In particular, Element nodes created within the Image I/O API are not compatible with those created by Sun's standard implementation of the org.w3.dom API. In particular, the implementation is tuned for simple uses and may not perform well for intensive processing.

Namespaces are ignored in this implementation. The terms "tag name" and "node name" are always considered to be synonymous. Note: The DOM Level 3 specification added a number of new methods to the Node, Element and Attr interfaces that are not of value to the IIOMetadataNode implementation or specification. Calling such methods on an IIOMetadataNode, or an Attr instance returned from an IIOMetadataNode will result in a DOMException being thrown.

See Also:

IIOMetadata.getAsTree(java.lang.String), IIOMetadata.setFromTree(java.lang.String, org.w3c.dom.Node), IIOMetadata.mergeTree(java.lang.String, org.w3c.dom.Node)

Field Summary

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Constructor Summary

Constructors

Constructor and Description
IIOMetadataNode() Constructs an empty IIOMetadataNode.
IIOMetadataNode(String nodeName) Constructs an IIOMetadataNode with a given node name.

Method Summary

Methods

Modifier and Type	Method and Description
org.w3c.dom.Node	appendChild(org.w3c.dom.Node newChild) Adds the node newChild to the end of the list of children of this node.
org.w3c.dom.Node	cloneNode(boolean deep) Returns a duplicate of this node.
short	compareDocumentPosition(org.w3c.dom.Node other) This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.
String	getAttribute(String name) Retrieves an attribute value by name.
org.w3c.dom.Attr	getAttributeNode(String name)
org.w3c.dom.Attr	getAttributeNodeNS(String namespaceURI, String localName) Equivalent to getAttributeNode(localName).
String	getAttributeNS(String namespaceURI, String localName) Equivalent to getAttribute(localName).
org.w3c.dom.NamedNodeMap	getAttributes() Returns a NamedNodeMap containing the attributes of this node.
String	getBaseURI() This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.
org.w3c.dom.NodeList	getChildNodes() Returns a NodeList that contains all children of this node.
org.w3c.dom.NodeList	getElementsByTagName(String name)
org.w3c.dom.NodeList	getElementsByTagNameNS(String namespaceURI, String localName) Equivalent to getElementsByTagName(localName).
Object	getFeature(String feature, String version) This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.
org.w3c.dom.Node	getFirstChild() Returns the first child of this node, or null if the node has no children.
org.w3c.dom.Node	getLastChild() Returns the last child of this node, or null if the node has no children.
int	getLength()
String	getLocalName() Equivalent to getNodeName.
String	getNamespaceURI() Returns null, since namespaces are not supported.
org.w3c.dom.Node	getNextSibling() Returns the next sibling of this node, or null if the node has no next sibling.
String	getNodeName() Returns the node name associated with this node.
short	getNodeType() Returns the node type, which is always ELEMENT_NODE.
String	getNodeValue() Returns the value associated with this node.
org.w3c.dom.Document	getOwnerDocument() Returns null, since IIOMetadataNodes do not belong to any Document.
org.w3c.dom.Node	getParentNode() Returns the parent of this node.
String	getPrefix() Returns null, since namespaces are not supported.
org.w3c.dom.Node	getPreviousSibling() Returns the previous sibling of this node, or null if this node has no previous sibling.
org.w3c.dom.TypeInfo	getSchemaTypeInfo() This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.
String	getTagName() Equivalent to getNodeName.
String	getTextContent() This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.
Object	getUserData(String key) This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.
Object	getUserObject() Returns the Object value associated with this node.
boolean	hasAttribute(String name)
boolean	hasAttributeNS(String namespaceURI, String localName) Equivalent to hasAttribute(localName).
boolean	hasAttributes()
boolean	hasChildNodes() Returns true if this node has child nodes.
org.w3c.dom.Node	insertBefore(org.w3c.dom.Node newChild, org.w3c.dom.Node refChild) Inserts the node newChild before the existing child node refChild.
boolean	isDefaultNamespace(String namespaceURI) This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.
boolean	isEqualNode(org.w3c.dom.Node node) This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.
boolean	isSameNode(org.w3c.dom.Node node) This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.
boolean	isSupported(String feature, String version) Returns false since DOM features are not supported.
org.w3c.dom.Node	item(int index)
String	lookupNamespaceURI(String prefix) This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.
String	lookupPrefix(String namespaceURI) This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.
void	normalize() Does nothing, since IIOMetadataNodes do not contain Text children.
void	removeAttribute(String name)
org.w3c.dom.Attr	removeAttributeNode(org.w3c.dom.Attr oldAttr)
void	removeAttributeNS(String namespaceURI, String localName) Equivalent to removeAttribute(localName).
org.w3c.dom.Node	removeChild(org.w3c.dom.Node oldChild) Removes the child node indicated by oldChild from the list of children, and returns it.
org.w3c.dom.Node	replaceChild(org.w3c.dom.Node newChild, org.w3c.dom.Node oldChild) Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node.
void	setAttribute(String name, String value)
org.w3c.dom.Attr	setAttributeNode(org.w3c.dom.Attr newAttr)
org.w3c.dom.Attr	setAttributeNodeNS(org.w3c.dom.Attr newAttr) Equivalent to setAttributeNode(newAttr).
void	setAttributeNS(String namespaceURI, String qualifiedName, String value) Equivalent to setAttribute(qualifiedName, value).
void	setIdAttribute(String name, boolean isId) This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.
void	setIdAttributeNode(org.w3c.dom.Attr idAttr, boolean isId) This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.
void	setIdAttributeNS(String namespaceURI, String localName, boolean isId) This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.
void	setNodeValue(String nodeValue) Sets the String value associated with this node.
void	setPrefix(String prefix) Does nothing, since namespaces are not supported.
void	setTextContent(String textContent) This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.
Object	setUserData(String key, Object data, org.w3c.dom.UserDataHandler handler) This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.
void	setUserObject(Object userObject) Sets the value associated with this node.

Methods inherited from class java.lang.Object

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

Constructor Detail

IIOMetadataNode

public IIOMetadataNode()

Constructs an empty IIOMetadataNode.

IIOMetadataNode

public IIOMetadataNode(String nodeName)

Constructs an IIOMetadataNode with a given node name.

Parameters:

nodeName - the name of the node, as a String.

Method Detail

getNodeName

public String getNodeName()

Returns the node name associated with this node.

Specified by:

getNodeName in interface org.w3c.dom.Node

Returns:

the node name, as a String.

getNodeValue

public String getNodeValue()

Returns the value associated with this node.

Specified by:

getNodeValue in interface org.w3c.dom.Node

Returns:

the node value, as a String.

setNodeValue

public void setNodeValue(String nodeValue)

Sets the String value associated with this node.

Specified by:

setNodeValue in interface org.w3c.dom.Node

getNodeType

public short getNodeType()

Returns the node type, which is always ELEMENT_NODE.

Specified by:

getNodeType in interface org.w3c.dom.Node

Returns:

the short value ELEMENT_NODE.

getParentNode

public org.w3c.dom.Node getParentNode()

Returns the parent of this node. A null value indicates that the node is the root of its own tree. To add a node to an existing tree, use one of the insertBefore, replaceChild, or appendChild methods.

Specified by:

getParentNode in interface org.w3c.dom.Node

Returns:

the parent, as a Node.

See Also:

insertBefore(org.w3c.dom.Node, org.w3c.dom.Node), replaceChild(org.w3c.dom.Node, org.w3c.dom.Node), appendChild(org.w3c.dom.Node)

getChildNodes

public org.w3c.dom.NodeList getChildNodes()

Returns a NodeList that contains all children of this node. If there are no children, this is a NodeList containing no nodes.

Specified by:

getChildNodes in interface org.w3c.dom.Node

Returns:

the children as a NodeList

getFirstChild

public org.w3c.dom.Node getFirstChild()

Returns the first child of this node, or null if the node has no children.

Specified by:

getFirstChild in interface org.w3c.dom.Node

Returns:

the first child, as a Node, or null

getLastChild

public org.w3c.dom.Node getLastChild()

Returns the last child of this node, or null if the node has no children.

Specified by:

getLastChild in interface org.w3c.dom.Node

Returns:

the last child, as a Node, or null.

getPreviousSibling

public org.w3c.dom.Node getPreviousSibling()

Returns the previous sibling of this node, or null if this node has no previous sibling.

Specified by:

getPreviousSibling in interface org.w3c.dom.Node

Returns:

the previous sibling, as a Node, or null.

getNextSibling

public org.w3c.dom.Node getNextSibling()

Returns the next sibling of this node, or null if the node has no next sibling.

Specified by:

getNextSibling in interface org.w3c.dom.Node

Returns:

the next sibling, as a Node, or null.

getAttributes

public org.w3c.dom.NamedNodeMap getAttributes()

Returns a NamedNodeMap containing the attributes of this node.

Specified by:

getAttributes in interface org.w3c.dom.Node

Returns:

a NamedNodeMap containing the attributes of this node.

getOwnerDocument

public org.w3c.dom.Document getOwnerDocument()

Returns null, since IIOMetadataNodes do not belong to any Document.

Specified by:

getOwnerDocument in interface org.w3c.dom.Node

Returns:

null.

insertBefore

public org.w3c.dom.Node insertBefore(org.w3c.dom.Node newChild,
                            org.w3c.dom.Node refChild)

Inserts the node newChild before the existing child node refChild. If refChild is null, insert newChild at the end of the list of children.

Specified by:

insertBefore in interface org.w3c.dom.Node

Parameters:

newChild - the Node to insert.

refChild - the reference Node.

Returns:

the node being inserted.

Throws:

IllegalArgumentException - if newChild is null.

replaceChild

public org.w3c.dom.Node replaceChild(org.w3c.dom.Node newChild,
                            org.w3c.dom.Node oldChild)

Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node.

Specified by:

replaceChild in interface org.w3c.dom.Node

Parameters:

newChild - the Node to insert.

oldChild - the Node to be replaced.

Returns:

the node replaced.

Throws:

IllegalArgumentException - if newChild is null.

removeChild

public org.w3c.dom.Node removeChild(org.w3c.dom.Node oldChild)

Removes the child node indicated by oldChild from the list of children, and returns it.

Specified by:

removeChild in interface org.w3c.dom.Node

Parameters:

oldChild - the Node to be removed.

Returns:

the node removed.

Throws:

IllegalArgumentException - if oldChild is null.

appendChild

public org.w3c.dom.Node appendChild(org.w3c.dom.Node newChild)

Adds the node newChild to the end of the list of children of this node.

Specified by:

appendChild in interface org.w3c.dom.Node

Parameters:

newChild - the Node to insert.

Returns:

the node added.

Throws:

IllegalArgumentException - if newChild is null.

hasChildNodes

public boolean hasChildNodes()

Returns true if this node has child nodes.

Specified by:

hasChildNodes in interface org.w3c.dom.Node

Returns:

true if this node has children.

cloneNode

public org.w3c.dom.Node cloneNode(boolean deep)

Returns a duplicate of this node. The duplicate node has no parent (getParentNode returns null). If a shallow clone is being performed (deep is false), the new node will not have any children or siblings. If a deep clone is being performed, the new node will form the root of a complete cloned subtree.

Specified by:

cloneNode in interface org.w3c.dom.Node

Parameters:

deep - if true, recursively clone the subtree under the specified node; if false, clone only the node itself.

Returns:

the duplicate node.

normalize

public void normalize()

Does nothing, since IIOMetadataNodes do not contain Text children.

Specified by:

normalize in interface org.w3c.dom.Node

isSupported

public boolean isSupported(String feature,
                  String version)

Returns false since DOM features are not supported.

Specified by:

isSupported in interface org.w3c.dom.Node

Parameters:

feature - a String, which is ignored.

version - a String, which is ignored.

Returns:

false.

getNamespaceURI

public String getNamespaceURI()
                       throws org.w3c.dom.DOMException

Returns null, since namespaces are not supported.

Specified by:

getNamespaceURI in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException

getPrefix

public String getPrefix()

Returns null, since namespaces are not supported.

Specified by:

getPrefix in interface org.w3c.dom.Node

Returns:

null.

See Also:

setPrefix(java.lang.String)

setPrefix

public void setPrefix(String prefix)

Does nothing, since namespaces are not supported.

Specified by:

setPrefix in interface org.w3c.dom.Node

Parameters:

prefix - a String, which is ignored.

See Also:

getPrefix()

getLocalName

public String getLocalName()

Equivalent to getNodeName.

Specified by:

getLocalName in interface org.w3c.dom.Node

Returns:

the node name, as a String.

getTagName

public String getTagName()

Equivalent to getNodeName.

Specified by:

getTagName in interface org.w3c.dom.Element

Returns:

the node name, as a String

getAttribute

public String getAttribute(String name)

Retrieves an attribute value by name.

Specified by:

getAttribute in interface org.w3c.dom.Element

Parameters:

name - The name of the attribute to retrieve.

Returns:

The Attr value as a string, or the empty string if that attribute does not have a specified or default value.

getAttributeNS

public String getAttributeNS(String namespaceURI,
                    String localName)

Equivalent to getAttribute(localName).

Specified by:

getAttributeNS in interface org.w3c.dom.Element

See Also:

setAttributeNS(java.lang.String, java.lang.String, java.lang.String)

setAttribute

public void setAttribute(String name,
                String value)

Specified by:

setAttribute in interface org.w3c.dom.Element

setAttributeNS

public void setAttributeNS(String namespaceURI,
                  String qualifiedName,
                  String value)

Equivalent to setAttribute(qualifiedName, value).

Specified by:

setAttributeNS in interface org.w3c.dom.Element

See Also:

getAttributeNS(java.lang.String, java.lang.String)

removeAttribute

public void removeAttribute(String name)

Specified by:

removeAttribute in interface org.w3c.dom.Element

removeAttributeNS

public void removeAttributeNS(String namespaceURI,
                     String localName)

Equivalent to removeAttribute(localName).

Specified by:

removeAttributeNS in interface org.w3c.dom.Element

getAttributeNode

public org.w3c.dom.Attr getAttributeNode(String name)

Specified by:

getAttributeNode in interface org.w3c.dom.Element

getAttributeNodeNS

public org.w3c.dom.Attr getAttributeNodeNS(String namespaceURI,
                                  String localName)

Equivalent to getAttributeNode(localName).

Specified by:

getAttributeNodeNS in interface org.w3c.dom.Element

See Also:

setAttributeNodeNS(org.w3c.dom.Attr)

setAttributeNode

public org.w3c.dom.Attr setAttributeNode(org.w3c.dom.Attr newAttr)
                                  throws org.w3c.dom.DOMException

Specified by:

setAttributeNode in interface org.w3c.dom.Element

Throws:

org.w3c.dom.DOMException

setAttributeNodeNS

public org.w3c.dom.Attr setAttributeNodeNS(org.w3c.dom.Attr newAttr)

Equivalent to setAttributeNode(newAttr).

Specified by:

setAttributeNodeNS in interface org.w3c.dom.Element

See Also:

getAttributeNodeNS(java.lang.String, java.lang.String)

removeAttributeNode

public org.w3c.dom.Attr removeAttributeNode(org.w3c.dom.Attr oldAttr)

Specified by:

removeAttributeNode in interface org.w3c.dom.Element

getElementsByTagName

public org.w3c.dom.NodeList getElementsByTagName(String name)

Specified by:

getElementsByTagName in interface org.w3c.dom.Element

getElementsByTagNameNS

public org.w3c.dom.NodeList getElementsByTagNameNS(String namespaceURI,
                                          String localName)

Equivalent to getElementsByTagName(localName).

Specified by:

getElementsByTagNameNS in interface org.w3c.dom.Element

hasAttributes

public boolean hasAttributes()

Specified by:

hasAttributes in interface org.w3c.dom.Node

hasAttribute

public boolean hasAttribute(String name)

Specified by:

hasAttribute in interface org.w3c.dom.Element

hasAttributeNS

public boolean hasAttributeNS(String namespaceURI,
                     String localName)

Equivalent to hasAttribute(localName).

Specified by:

hasAttributeNS in interface org.w3c.dom.Element

getLength

public int getLength()

Specified by:

getLength in interface org.w3c.dom.NodeList

item

public org.w3c.dom.Node item(int index)

Specified by:

item in interface org.w3c.dom.NodeList

getUserObject

public Object getUserObject()

Returns the Object value associated with this node.

Returns:

the user Object.

See Also:

setUserObject(java.lang.Object)

setUserObject

public void setUserObject(Object userObject)

Sets the value associated with this node.

Parameters:

userObject - the user Object.

See Also:

getUserObject()

setIdAttribute

public void setIdAttribute(String name,
                  boolean isId)
                    throws org.w3c.dom.DOMException

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

Specified by:

setIdAttribute in interface org.w3c.dom.Element

Throws:

org.w3c.dom.DOMException - - always.

setIdAttributeNS

public void setIdAttributeNS(String namespaceURI,
                    String localName,
                    boolean isId)
                      throws org.w3c.dom.DOMException

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

Specified by:

setIdAttributeNS in interface org.w3c.dom.Element

Throws:

org.w3c.dom.DOMException - - always.

setIdAttributeNode

public void setIdAttributeNode(org.w3c.dom.Attr idAttr,
                      boolean isId)
                        throws org.w3c.dom.DOMException

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

Specified by:

setIdAttributeNode in interface org.w3c.dom.Element

Throws:

org.w3c.dom.DOMException - - always.

getSchemaTypeInfo

public org.w3c.dom.TypeInfo getSchemaTypeInfo()
                                       throws org.w3c.dom.DOMException

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

Specified by:

getSchemaTypeInfo in interface org.w3c.dom.Element

Throws:

org.w3c.dom.DOMException - - always.

setUserData

public Object setUserData(String key,
                 Object data,
                 org.w3c.dom.UserDataHandler handler)
                   throws org.w3c.dom.DOMException

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

Specified by:

setUserData in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException - - always.

getUserData

public Object getUserData(String key)
                   throws org.w3c.dom.DOMException

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

Specified by:

getUserData in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException - - always.

getFeature

public Object getFeature(String feature,
                String version)
                  throws org.w3c.dom.DOMException

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

Specified by:

getFeature in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException - - always.

isSameNode

public boolean isSameNode(org.w3c.dom.Node node)
                   throws org.w3c.dom.DOMException

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

Specified by:

isSameNode in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException - - always.

isEqualNode

public boolean isEqualNode(org.w3c.dom.Node node)
                    throws org.w3c.dom.DOMException

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

Specified by:

isEqualNode in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException - - always.

lookupNamespaceURI

public String lookupNamespaceURI(String prefix)
                          throws org.w3c.dom.DOMException

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

Specified by:

lookupNamespaceURI in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException - - always.

isDefaultNamespace

public boolean isDefaultNamespace(String namespaceURI)
                           throws org.w3c.dom.DOMException

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

Specified by:

isDefaultNamespace in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException - - always.

lookupPrefix

public String lookupPrefix(String namespaceURI)
                    throws org.w3c.dom.DOMException

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

Specified by:

lookupPrefix in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException - - always.

getTextContent

public String getTextContent()
                      throws org.w3c.dom.DOMException

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

Specified by:

getTextContent in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException - - always.

setTextContent

public void setTextContent(String textContent)
                    throws org.w3c.dom.DOMException

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

Specified by:

setTextContent in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException - - always.

compareDocumentPosition

public short compareDocumentPosition(org.w3c.dom.Node other)
                              throws org.w3c.dom.DOMException

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

Specified by:

compareDocumentPosition in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException - - always.

getBaseURI

public String getBaseURI()
                  throws org.w3c.dom.DOMException

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

Specified by:

getBaseURI in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException - - always.