|
JavaTM 2 Platform Std. Ed. v1.4.2 |
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectjavax.imageio.metadata.IIOMetadataNode
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.
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_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE |
| Constructor Summary | |
IIOMetadataNode()
Constructs an empty IIOMetadataNode. |
|
IIOMetadataNode(String nodeName)
Constructs an IIOMetadataNode with a given node
name. |
|
| Method Summary | |
Node |
appendChild(Node newChild)
Adds the node newChild to the end of the list of
children of this node. |
Node |
cloneNode(boolean deep)
Returns a duplicate of this node. |
String |
getAttribute(String name)
Retrieves an attribute value by name. |
Attr |
getAttributeNode(String name)
Retrieves an attribute node by name. |
Attr |
getAttributeNodeNS(String namespaceURI,
String localName)
Equivalent to getAttributeNode(localName). |
String |
getAttributeNS(String namespaceURI,
String localName)
Equivalent to getAttribute(localName). |
NamedNodeMap |
getAttributes()
A NamedNodeMap containing the attributes of this node (if
it is an Element) or null otherwise. |
NodeList |
getChildNodes()
A NodeList that contains all children of this node. |
NodeList |
getElementsByTagName(String name)
Returns a NodeList of all descendant Elements
with a given tag name, in the order in which they are encountered in
a preorder traversal of this Element tree. |
NodeList |
getElementsByTagNameNS(String namespaceURI,
String localName)
Equivalent to getElementsByTagName(localName). |
Node |
getFirstChild()
Returns the first child of this node, or null if
the node has no children. |
Node |
getLastChild()
Returns the last child of this node, or null if
the node has no children. |
int |
getLength()
The number of nodes in the list. |
String |
getLocalName()
Equivalent to getNodeName. |
String |
getNamespaceURI()
Returns null, since namespaces are not supported. |
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()
The value of this node, depending on its type; see the table above. |
Document |
getOwnerDocument()
Returns null, since IIOMetadataNodes
do not belong to any Document. |
Node |
getParentNode()
Returns the parent of this node. |
String |
getPrefix()
Returns null, since namespaces are not supported. |
Node |
getPreviousSibling()
Returns the previous sibling of this node, or null
if this node has no previous sibling. |
String |
getTagName()
The name of the element. |
Object |
getUserObject()
Returns the Object value associated with this node. |
boolean |
hasAttribute(String name)
Returns true when an attribute with a given name is
specified on this element or has a default value, false
otherwise. |
boolean |
hasAttributeNS(String namespaceURI,
String localName)
Equivalent to hasAttribute(localName). |
boolean |
hasAttributes()
Returns whether this node (if it is an element) has any attributes. |
boolean |
hasChildNodes()
Returns true if this node has child nodes. |
Node |
insertBefore(Node newChild,
Node refChild)
Inserts the node newChild before the existing
child node refChild. |
boolean |
isSupported(String feature,
String version)
Returns false since DOM features are not
supported. |
Node |
item(int index)
Returns the indexth item in the collection. |
void |
normalize()
Does nothing, since IIOMetadataNodes do not
contain Text children. |
void |
removeAttribute(String name)
Removes an attribute by name. |
Attr |
removeAttributeNode(Attr oldAttr)
Removes the specified attribute node. |
void |
removeAttributeNS(String namespaceURI,
String localName)
Equivalent to removeAttribute(localName). |
Node |
removeChild(Node oldChild)
Removes the child node indicated by oldChild from
the list of children, and returns it. |
Node |
replaceChild(Node newChild,
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)
Adds a new attribute. |
Attr |
setAttributeNode(Attr newAttr)
Adds a new attribute node. |
Attr |
setAttributeNodeNS(Attr newAttr)
Equivalent to setAttributeNode(newAttr). |
void |
setAttributeNS(String namespaceURI,
String qualifiedName,
String value)
Equivalent to setAttribute(qualifiedName, value). |
void |
setNodeValue(String nodeValue)
The value of this node, depending on its type; see the table above. |
void |
setPrefix(String prefix)
Does nothing, since namespaces are not supported. |
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 |
public IIOMetadataNode()
IIOMetadataNode.
public IIOMetadataNode(String nodeName)
IIOMetadataNode with a given node
name.
nodeName - the name of the node, as a String.| Method Detail |
public String getNodeName()
getNodeName in interface NodeString.
public String getNodeValue()
throws DOMException
Nodenull, setting it has no effect.
getNodeValue in interface NodeDOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
public void setNodeValue(String nodeValue)
throws DOMException
Nodenull, setting it has no effect.
setNodeValue in interface NodeDOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.public short getNodeType()
ELEMENT_NODE.
getNodeType in interface Nodeshort value ELEMENT_NODE.public Node getParentNode()
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.
getParentNode in interface NodeNode.insertBefore(org.w3c.dom.Node, org.w3c.dom.Node),
replaceChild(org.w3c.dom.Node, org.w3c.dom.Node),
appendChild(org.w3c.dom.Node)public NodeList getChildNodes()
NodeNodeList that contains all children of this node. If
there are no children, this is a NodeList containing no
nodes.
getChildNodes in interface Nodepublic Node getFirstChild()
null if
the node has no children.
getFirstChild in interface NodeNode, or
nullpublic Node getLastChild()
null if
the node has no children.
getLastChild in interface NodeNode, or
null.public Node getPreviousSibling()
null
if this node has no previous sibling.
getPreviousSibling in interface NodeNode, or
null.public Node getNextSibling()
null if
the node has no next sibling.
getNextSibling in interface NodeNode, or
null.public NamedNodeMap getAttributes()
NodeNamedNodeMap containing the attributes of this node (if
it is an Element) or null otherwise.
getAttributes in interface Nodepublic Document getOwnerDocument()
null, since IIOMetadataNodes
do not belong to any Document.
getOwnerDocument in interface Nodenull.
public Node insertBefore(Node newChild,
Node refChild)
newChild before the existing
child node refChild. If refChild is
null, insert newChild at the end of
the list of children.
insertBefore in interface NodenewChild - the Node to insert.refChild - the reference Node.
IllegalArgumentException - if newChild is
null.
public Node replaceChild(Node newChild,
Node oldChild)
oldChild with
newChild in the list of children, and returns the
oldChild node.
replaceChild in interface NodenewChild - the Node to insert.oldChild - the Node to be replaced.
IllegalArgumentException - if newChild is
null.public Node removeChild(Node oldChild)
oldChild from
the list of children, and returns it.
removeChild in interface NodeoldChild - the Node to be removed.
IllegalArgumentException - if oldChild is
null.public Node appendChild(Node newChild)
newChild to the end of the list of
children of this node.
appendChild in interface NodenewChild - the Node to insert.
IllegalArgumentException - if newChild is
null.public boolean hasChildNodes()
true if this node has child nodes.
hasChildNodes in interface Nodetrue if this node has children.public Node cloneNode(boolean deep)
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.
cloneNode in interface Nodedeep - if true, recursively clone the subtree
under the specified node; if false, clone only the
node itself.
public void normalize()
IIOMetadataNodes do not
contain Text children.
normalize in interface Node
public boolean isSupported(String feature,
String version)
false since DOM features are not
supported.
isSupported in interface Nodefeature - a String, which is ignored.version - a String, which is ignored.
false.
public String getNamespaceURI()
throws DOMException
null, since namespaces are not supported.
getNamespaceURI in interface NodeDOMExceptionpublic String getPrefix()
null, since namespaces are not supported.
getPrefix in interface Nodenull.setPrefix(java.lang.String)public void setPrefix(String prefix)
setPrefix in interface Nodeprefix - a String, which is ignored.getPrefix()public String getLocalName()
getNodeName.
getLocalName in interface NodeString.public String getTagName()
Element<elementExample id="demo"> ... </elementExample> ,
tagName has
the value "elementExample". Note that this is
case-preserving in XML, as are all of the operations of the DOM. The
HTML DOM returns the tagName of an HTML element in the
canonical uppercase form, regardless of the case in the source HTML
document.
getTagName in interface Elementpublic String getAttribute(String name)
Element
getAttribute in interface Elementname - The name of the attribute to retrieve.
Attr value as a string, or the empty string
if that attribute does not have a specified or default value.
public String getAttributeNS(String namespaceURI,
String localName)
getAttribute(localName).
getAttributeNS in interface ElementnamespaceURI - The namespace URI of the attribute to retrieve.localName - The local name of the attribute to retrieve.
Attr value as a string, or the empty string
if that attribute does not have a specified or default value.setAttributeNS(java.lang.String, java.lang.String, java.lang.String)
public void setAttribute(String name,
String value)
ElementAttr node plus any
Text and EntityReference nodes, build the
appropriate subtree, and use setAttributeNode to assign
it as the value of an attribute.
setAttributeNS method.
setAttribute in interface Elementname - The name of the attribute to create or alter.value - Value to set in string form.
public void setAttributeNS(String namespaceURI,
String qualifiedName,
String value)
setAttribute(qualifiedName, value).
setAttributeNS in interface ElementnamespaceURI - The namespace URI of the attribute to create or
alter.qualifiedName - The qualified name of the attribute to create or
alter.value - The value to set in string form.getAttributeNS(java.lang.String, java.lang.String)public void removeAttribute(String name)
ElementremoveAttributeNS method.
removeAttribute in interface Elementname - The name of the attribute to remove.
public void removeAttributeNS(String namespaceURI,
String localName)
removeAttribute(localName).
removeAttributeNS in interface ElementnamespaceURI - The namespace URI of the attribute to remove.localName - The local name of the attribute to remove.public Attr getAttributeNode(String name)
ElementgetAttributeNodeNS method.
getAttributeNode in interface Elementname - The name (nodeName) of the attribute to
retrieve.
Attr node with the specified name (
nodeName) or null if there is no such
attribute.
public Attr getAttributeNodeNS(String namespaceURI,
String localName)
getAttributeNode(localName).
getAttributeNodeNS in interface ElementnamespaceURI - The namespace URI of the attribute to retrieve.localName - The local name of the attribute to retrieve.
Attr node with the specified attribute local
name and namespace URI or null if there is no such
attribute.setAttributeNodeNS(org.w3c.dom.Attr)
public Attr setAttributeNode(Attr newAttr)
throws DOMException
ElementnodeName) is already present in the element, it is
replaced by the new one.
setAttributeNodeNS method.
setAttributeNode in interface ElementnewAttr - The Attr node to add to the attribute list.
newAttr attribute replaces an existing
attribute, the replaced Attr node is returned,
otherwise null is returned.
DOMException - WRONG_DOCUMENT_ERR: Raised if newAttr was created from a
different document than the one that created the element.
newAttr is already an
attribute of another Element object. The DOM user must
explicitly clone Attr nodes to re-use them in other
elements.public Attr setAttributeNodeNS(Attr newAttr)
setAttributeNode(newAttr).
setAttributeNodeNS in interface ElementnewAttr - The Attr node to add to the attribute list.
newAttr attribute replaces an existing
attribute with the same local name and namespace URI, the replaced
Attr node is returned, otherwise null is
returned.getAttributeNodeNS(java.lang.String, java.lang.String)public Attr removeAttributeNode(Attr oldAttr)
ElementAttr
has a default value it is immediately replaced. The replacing
attribute has the same namespace URI and local name, as well as the
original prefix, when applicable.
removeAttributeNode in interface ElementoldAttr - The Attr node to remove from the attribute
list.
Attr node that was removed.public NodeList getElementsByTagName(String name)
ElementNodeList of all descendant Elements
with a given tag name, in the order in which they are encountered in
a preorder traversal of this Element tree.
getElementsByTagName in interface Elementname - The name of the tag to match on. The special value "*"
matches all tags.
Element nodes.
public NodeList getElementsByTagNameNS(String namespaceURI,
String localName)
getElementsByTagName(localName).
getElementsByTagNameNS in interface ElementnamespaceURI - The namespace URI of the elements to match on. The
special value "*" matches all namespaces.localName - The local name of the elements to match on. The
special value "*" matches all local names.
NodeList object containing all the matched
Elements.public boolean hasAttributes()
Node
hasAttributes in interface Nodetrue if this node has any attributes,
false otherwise.public boolean hasAttribute(String name)
Elementtrue when an attribute with a given name is
specified on this element or has a default value, false
otherwise.
hasAttribute in interface Elementname - The name of the attribute to look for.
true if an attribute with the given name is
specified on this element or has a default value, false
otherwise.
public boolean hasAttributeNS(String namespaceURI,
String localName)
hasAttribute(localName).
hasAttributeNS in interface ElementnamespaceURI - The namespace URI of the attribute to look for.localName - The local name of the attribute to look for.
true if an attribute with the given local name
and namespace URI is specified or has a default value on this
element, false otherwise.public int getLength()
NodeListlength-1 inclusive.
getLength in interface NodeListpublic Node item(int index)
NodeListindexth item in the collection. If
index is greater than or equal to the number of nodes in
the list, this returns null.
item in interface NodeListindex - Index into the collection.
indexth position in the
NodeList, or null if that is not a valid
index.public Object getUserObject()
Object value associated with this node.
Object.setUserObject(java.lang.Object)public void setUserObject(Object userObject)
userObject - the user Object.getUserObject()
|
JavaTM 2 Platform Std. Ed. v1.4.2 |
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
Copyright 2003 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.