org.netbeans.modules.xml.xdm.nodes
Class Element

java.lang.Object
  org.netbeans.modules.xml.xdm.nodes.NodeImpl
      org.netbeans.modules.xml.xdm.nodes.Element

All Implemented Interfaces:

Cloneable, Element, Node

public class Element
extends NodeImpl
implements Node, Element

This class represents the XML Element. An element is of the form or [TextNode] In terms of tokens attibute can have upto 12 tokens. Start of start element token, <. element namespace token, optional. element namespace seperator, optional. element name token. whitespace token, optional. end of start element token, > or />. start of end element token, . the end element tokens are optional.

Field Summary

Fields inherited from class org.netbeans.modules.xml.xdm.nodes.NodeImpl

XMLNS

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

Method Summary

void	accept(XMLNodeVisitor visitor)
void	addAttribute(Attribute newAttr, int index) This api adds new attribute at a given index.
void	appendAttribute(Attribute newAttr) This api adds new attribute at the end.
Node	appendChild(Node node) Adds the node newChild to the end of the list of children of this node.
Node	appendChild(Node node, boolean consolidateNamespaces)
protected void	cloneNamespacePrefix(Map<Integer,String> allNS, Map<String,String> prefixes)
Element	cloneNode(boolean deep, boolean cloneNamespacePrefix)
String	getAttribute(String name) Retrieves an attribute value by name.
Attribute	getAttributeNode(String name) Retrieves an attribute node by name.
Attribute	getAttributeNodeNS(String namespaceURI, String localName) Retrieves an Attr node by local name and namespace URI.
String	getAttributeNS(String namespaceURI, String localName) Retrieves an attribute value by local name and namespace URI.
NodeList	getElementsByTagName(String name) Returns a NodeList of all descendant Elements with a given tag name, in document order.
NodeList	getElementsByTagNameNS(String namespaceURI, String localName) Returns a NodeList of all the descendant Elements with a given local name and namespace URI in document order.
String	getLocalName()
String	getNodeName()
short	getNodeType()
String	getPrefix()
TypeInfo	getSchemaTypeInfo() The type information associated with this element.
String	getTagName()
String	getXmlFragmentText()
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) Returns true when an attribute with a given local name and namespace URI is specified on this element or has a default value, false otherwise.
Node	insertBefore(Node newChild, Node refChild) Inserts the node newChild before the existing child node refChild.
void	removeAttribute(String name) Removes an attribute by name.
Attribute	removeAttributeNode(Attr oldAttr) Removes the specified attribute node.
void	removeAttributeNS(String namespaceURI, String localName) Removes an attribute by local name and namespace URI.
void	reorderAttribute(Attribute attr, int index) Moves attribute to the given index.
void	reorderAttribute(int[] permutation) Rearranges attribute list to the given permutaion.
void	replaceAttribute(Attribute newAttr, Attribute oldAttr) This api replaces old attribute of this element with new attribute.
void	setAttribute(String name, String value) Adds a new attribute.
Attribute	setAttributeNode(Attr newAttr) Adds a new attribute node.
Attr	setAttributeNodeNS(Attr newAttr) Adds a new attribute.
void	setAttributeNS(String namespaceURI, String qualifiedName, String value) Adds a new attribute.
void	setIdAttribute(String name, boolean isId) If the parameter isId is true, this method declares the specified attribute to be a user-determined ID attribute .
void	setIdAttributeNode(Attr idAttr, boolean isId) If the parameter isId is true, this method declares the specified attribute to be a user-determined ID attribute .
void	setIdAttributeNS(String namespaceURI, String localName, boolean isId) If the parameter isId is true, this method declares the specified attribute to be a user-determined ID attribute .
void	setLocalName(String localName)
void	setPrefix(String prefix)
void	setTagName(String tagName)
void	setXmlFragmentText(String text)

Methods inherited from class org.netbeans.modules.xml.xdm.nodes.NodeImpl

addedToTree, assignNodeId, assignNodeIdRecursively, clone, cloneNamespacePrefixes, cloneNode, cloneNode, cloneShallowWithModelContext, compareDocumentPosition, copy, copyTokens, getAttributes, getAttributesForRead, getAttributesForWrite, getBaseURI, getChildNodes, getFeature, getFirstChild, getId, getIndexOfChild, getLastChild, getModel, getNamespaceURI, getNamespaceURI, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPreviousSibling, getTextContent, getTokens, getUserData, hasAttributes, hasChildNodes, hashCode, isDefaultNamespace, isEqualNode, isEquivalentNode, isInTree, isSameNode, isSupported, lookupNamespace, lookupNamespace, lookupNamespaceURI, lookupPrefix, lookupPrefix, normalize, removeChild, reorderChild, reorderChildren, replaceChild, setNodeValue, setTextContent, setUserData, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.netbeans.modules.xml.xdm.nodes.Node

addedToTree, clone, getId, getIndexOfChild, getNamespaceURI, isEquivalentNode, isInTree

Methods inherited from interface org.w3c.dom.Node

cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getNamespaceURI, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setTextContent, setUserData

Method Detail

getNodeType

public short getNodeType()

Specified by:

getNodeType in interface Node

Specified by:

getNodeType in class NodeImpl

getNodeName

public String getNodeName()

Specified by:

getNodeName in interface Node

Specified by:

getNodeName in class NodeImpl

accept

public void accept(XMLNodeVisitor visitor)

getTagName

public String getTagName()

Specified by:

getTagName in interface Element

setTagName

public void setTagName(String tagName)

getPrefix

public String getPrefix()

Specified by:

getPrefix in interface Node

Overrides:

getPrefix in class NodeImpl

setPrefix

public void setPrefix(String prefix)

Specified by:

setPrefix in interface Node

Overrides:

setPrefix in class NodeImpl

getLocalName

public String getLocalName()

Specified by:

getLocalName in interface Node

Overrides:

getLocalName in class NodeImpl

setLocalName

public void setLocalName(String localName)

getAttribute

public String getAttribute(String name)

Retrieves an attribute value by name.

Specified by:

getAttribute in interface 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.

getAttributeNode

public Attribute getAttributeNode(String name)

Retrieves an attribute node by name.
To retrieve an attribute node by qualified name and namespace URI, use the getAttributeNodeNS method.

Specified by:

getAttributeNode in interface Element

Parameters:

name - The name (nodeName) of the attribute to retrieve.

Returns:

The Attr node with the specified name ( nodeName) or null if there is no such attribute.

hasAttribute

public 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.

Specified by:

hasAttribute in interface Element

Parameters:

name - The name of the attribute to look for.

Returns:

true if an attribute with the given name is specified on this element or has a default value, false otherwise.

Since:

DOM Level 2

getAttributeNS

public String getAttributeNS(String namespaceURI,
                             String localName)

Retrieves an attribute value by local name and namespace URI.
Per [XML Namespaces] , applications must use the value null as the namespaceURI parameter for methods if they wish to have no namespace.

Specified by:

getAttributeNS in interface Element

Parameters:

namespaceURI - The namespace URI of the attribute to retrieve.

localName - The local 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.

Throws:

DOMException - NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature "XML" and the language exposed through the Document does not support XML Namespaces (such as [HTML 4.01]).

Since:

DOM Level 2

getAttributeNodeNS

public Attribute getAttributeNodeNS(String namespaceURI,
                                    String localName)

Retrieves an Attr node by local name and namespace URI.
Per [XML Namespaces] , applications must use the value null as the namespaceURI parameter for methods if they wish to have no namespace.

Specified by:

getAttributeNodeNS in interface Element

Parameters:

namespaceURI - The namespace URI of the attribute to retrieve.

localName - The local name of the attribute to retrieve.

Returns:

The Attr node with the specified attribute local name and namespace URI or null if there is no such attribute.

Throws:

DOMException - NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature "XML" and the language exposed through the Document does not support XML Namespaces (such as [HTML 4.01]).

Since:

DOM Level 2

hasAttributeNS

public boolean hasAttributeNS(String namespaceURI,
                              String localName)

Returns true when an attribute with a given local name and namespace URI is specified on this element or has a default value, false otherwise.
Per [XML Namespaces] , applications must use the value null as the namespaceURI parameter for methods if they wish to have no namespace.

Specified by:

hasAttributeNS in interface Element

Parameters:

namespaceURI - The namespace URI of the attribute to look for.

localName - The local name of the attribute to look for.

Returns:

true if an attribute with the given local name and namespace URI is specified or has a default value on this element, false otherwise.

Throws:

DOMException - NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature "XML" and the language exposed through the Document does not support XML Namespaces (such as [HTML 4.01]).

Since:

DOM Level 2

setAttribute

public void setAttribute(String name,
                         String value)

Adds a new attribute. If an attribute with that name is already present in the element, its value is changed to be that of the value parameter. This value is a simple string; it is not parsed as it is being set. So any markup (such as syntax to be recognized as an entity reference) is treated as literal text, and needs to be appropriately escaped by the implementation when it is written out. In order to assign an attribute value that contains entity references, the user must create an Attr node plus any Text and EntityReference nodes, build the appropriate subtree, and use setAttributeNode to assign it as the value of an attribute.
To set an attribute with a qualified name and namespace URI, use the setAttributeNS method.

Specified by:

setAttribute in interface Element

Parameters:

name - The name of the attribute to create or alter.

value - Value to set in string form.

Throws:

DOMException - INVALID_CHARACTER_ERR: Raised if the specified name is not an XML name according to the XML version in use specified in the Document.xmlVersion attribute.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

setAttributeNode

public Attribute setAttributeNode(Attr newAttr)

Adds a new attribute node. If an attribute with that name ( nodeName) is already present in the element, it is replaced by the new one. Replacing an attribute node by itself has no effect.
To add a new attribute node with a qualified name and namespace URI, use the setAttributeNodeNS method.

Specified by:

setAttributeNode in interface Element

Parameters:

newAttr - The Attr node to add to the attribute list.

Returns:

If the newAttr attribute replaces an existing attribute, the replaced Attr node is returned, otherwise null is returned.

Throws:

DOMException - WRONG_DOCUMENT_ERR: Raised if newAttr was created from a different document than the one that created the element.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
INUSE_ATTRIBUTE_ERR: Raised if newAttr is already an attribute of another Element object. The DOM user must explicitly clone Attr nodes to re-use them in other elements.

removeAttribute

public void removeAttribute(String name)

Removes an attribute by name. If a default value for the removed attribute is defined in the DTD, a new attribute immediately appears with the default value as well as the corresponding namespace URI, local name, and prefix when applicable. The implementation may handle default values from other schemas similarly but applications should use Document.normalizeDocument() to guarantee this information is up-to-date.
If no attribute with this name is found, this method has no effect.
To remove an attribute by local name and namespace URI, use the removeAttributeNS method.

Specified by:

removeAttribute in interface Element

Parameters:

name - The name of the attribute to remove.

Throws:

DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

removeAttributeNode

public Attribute removeAttributeNode(Attr oldAttr)

Removes the specified attribute node. If a default value for the removed Attr node is defined in the DTD, a new node immediately appears with the default value as well as the corresponding namespace URI, local name, and prefix when applicable. The implementation may handle default values from other schemas similarly but applications should use Document.normalizeDocument() to guarantee this information is up-to-date.

Specified by:

removeAttributeNode in interface Element

Parameters:

oldAttr - The Attr node to remove from the attribute list.

Returns:

The Attr node that was removed.

Throws:

DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised if oldAttr is not an attribute of the element.

setAttributeNodeNS

public Attr setAttributeNodeNS(Attr newAttr)

Adds a new attribute. If an attribute with that local name and that namespace URI is already present in the element, it is replaced by the new one. Replacing an attribute node by itself has no effect.
Per [XML Namespaces] , applications must use the value null as the namespaceURI parameter for methods if they wish to have no namespace.

Specified by:

setAttributeNodeNS in interface Element

Parameters:

newAttr - The Attr node to add to the attribute list.

Returns:

If the newAttr attribute replaces an existing attribute with the same local name and namespace URI, the replaced Attr node is returned, otherwise null is returned.

Throws:

DOMException - WRONG_DOCUMENT_ERR: Raised if newAttr was created from a different document than the one that created the element.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
INUSE_ATTRIBUTE_ERR: Raised if newAttr is already an attribute of another Element object. The DOM user must explicitly clone Attr nodes to re-use them in other elements.
NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature "XML" and the language exposed through the Document does not support XML Namespaces (such as [HTML 4.01]).

Since:

DOM Level 2

setAttributeNS

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

Adds a new attribute. If an attribute with the same local name and namespace URI is already present on the element, its prefix is changed to be the prefix part of the qualifiedName, and its value is changed to be the value parameter. This value is a simple string; it is not parsed as it is being set. So any markup (such as syntax to be recognized as an entity reference) is treated as literal text, and needs to be appropriately escaped by the implementation when it is written out. In order to assign an attribute value that contains entity references, the user must create an Attr node plus any Text and EntityReference nodes, build the appropriate subtree, and use setAttributeNodeNS or setAttributeNode to assign it as the value of an attribute.
Per [XML Namespaces] , applications must use the value null as the namespaceURI parameter for methods if they wish to have no namespace.

Specified by:

setAttributeNS in interface Element

Parameters:

namespaceURI - 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.

Throws:

DOMException - INVALID_CHARACTER_ERR: Raised if the specified qualified name is not an XML name according to the XML version in use specified in the Document.xmlVersion attribute.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NAMESPACE_ERR: Raised if the qualifiedName is malformed per the Namespaces in XML specification, if the qualifiedName has a prefix and the namespaceURI is null, if the qualifiedName has a prefix that is "xml" and the namespaceURI is different from " http://www.w3.org/XML/1998/namespace", if the qualifiedName or its prefix is "xmlns" and the namespaceURI is different from "http://www.w3.org/2000/xmlns/", or if the namespaceURI is "http://www.w3.org/2000/xmlns/" and neither the qualifiedName nor its prefix is "xmlns".
NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature "XML" and the language exposed through the Document does not support XML Namespaces (such as [HTML 4.01]).

Since:

DOM Level 2

removeAttributeNS

public void removeAttributeNS(String namespaceURI,
                              String localName)

Removes an attribute by local name and namespace URI. If a default value for the removed attribute is defined in the DTD, a new attribute immediately appears with the default value as well as the corresponding namespace URI, local name, and prefix when applicable. The implementation may handle default values from other schemas similarly but applications should use Document.normalizeDocument() to guarantee this information is up-to-date.
If no attribute with this local name and namespace URI is found, this method has no effect.
Per [XML Namespaces] , applications must use the value null as the namespaceURI parameter for methods if they wish to have no namespace.

Specified by:

removeAttributeNS in interface Element

Parameters:

namespaceURI - The namespace URI of the attribute to remove.

localName - The local name of the attribute to remove.

Throws:

DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature "XML" and the language exposed through the Document does not support XML Namespaces (such as [HTML 4.01]).

Since:

DOM Level 2

getElementsByTagName

public NodeList getElementsByTagName(String name)

Returns a NodeList of all descendant Elements with a given tag name, in document order.

Specified by:

getElementsByTagName in interface Element

Parameters:

name - The name of the tag to match on. The special value "*" matches all tags.

Returns:

A list of matching Element nodes.

getElementsByTagNameNS

public NodeList getElementsByTagNameNS(String namespaceURI,
                                       String localName)

Returns a NodeList of all the descendant Elements with a given local name and namespace URI in document order.

Specified by:

getElementsByTagNameNS in interface Element

Parameters:

namespaceURI - 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.

Returns:

A new NodeList object containing all the matched Elements.

Throws:

DOMException - NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature "XML" and the language exposed through the Document does not support XML Namespaces (such as [HTML 4.01]).

Since:

DOM Level 2

setIdAttributeNode

public void setIdAttributeNode(Attr idAttr,
                               boolean isId)

If the parameter isId is true, this method declares the specified attribute to be a user-determined ID attribute . This affects the value of Attr.isId and the behavior of Document.getElementById, but does not change any schema that may be in use, in particular this does not affect the Attr.schemaTypeInfo of the specified Attr node. Use the value false for the parameter isId to undeclare an attribute for being a user-determined ID attribute.

Specified by:

setIdAttributeNode in interface Element

Parameters:

idAttr - The attribute node.

isId - Whether the attribute is a of type ID.

Throws:

DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised if the specified node is not an attribute of this element.

Since:

DOM Level 3

setIdAttribute

public void setIdAttribute(String name,
                           boolean isId)

If the parameter isId is true, this method declares the specified attribute to be a user-determined ID attribute . This affects the value of Attr.isId and the behavior of Document.getElementById, but does not change any schema that may be in use, in particular this does not affect the Attr.schemaTypeInfo of the specified Attr node. Use the value false for the parameter isId to undeclare an attribute for being a user-determined ID attribute.
To specify an attribute by local name and namespace URI, use the setIdAttributeNS method.

Specified by:

setIdAttribute in interface Element

Parameters:

name - The name of the attribute.

isId - Whether the attribute is a of type ID.

Throws:

DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised if the specified node is not an attribute of this element.

Since:

DOM Level 3

setIdAttributeNS

public void setIdAttributeNS(String namespaceURI,
                             String localName,
                             boolean isId)

If the parameter isId is true, this method declares the specified attribute to be a user-determined ID attribute . This affects the value of Attr.isId and the behavior of Document.getElementById, but does not change any schema that may be in use, in particular this does not affect the Attr.schemaTypeInfo of the specified Attr node. Use the value false for the parameter isId to undeclare an attribute for being a user-determined ID attribute.

Specified by:

setIdAttributeNS in interface Element

Parameters:

namespaceURI - The namespace URI of the attribute.

localName - The local name of the attribute.

isId - Whether the attribute is a of type ID.

Throws:

DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised if the specified node is not an attribute of this element.

Since:

DOM Level 3

getSchemaTypeInfo

public TypeInfo getSchemaTypeInfo()

The type information associated with this element.

Specified by:

getSchemaTypeInfo in interface Element

Since:

DOM Level 3

replaceAttribute

public void replaceAttribute(Attribute newAttr,
                             Attribute oldAttr)

This api replaces old attribute of this element with new attribute. This api is provided for XDMModel purposes only.

Parameters:

newAttr - The new attribute.

oldAttr - The old attribute to replace.

Throws:

IllegalStateException - if a newAttr has already been added to a tree.

addAttribute

public void addAttribute(Attribute newAttr,
                         int index)

This api adds new attribute at a given index. This api is provided for XDMModel purposes only.

Parameters:

newAttr - The new attribute to be added.

index - The index at which attribute to be added

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index > size()).

IllegalStateException - if a newAttr has already been added to a tree.

reorderAttribute

public void reorderAttribute(Attribute attr,
                             int index)

Moves attribute to the given index. This api is provided for XDMModel purposes only.

Parameters:

attr - The new attribute to be moved.

index - The index at which attribute to be moved

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index > size()).

IllegalStateException - if a attr has not already been added to a tree.

reorderAttribute

public void reorderAttribute(int[] permutation)

Rearranges attribute list to the given permutaion.

Parameters:

permutation - integer array with index represents current index and value is final index after reordered.

appendAttribute

public void appendAttribute(Attribute newAttr)

This api adds new attribute at the end. This api is provided for XDMModel purposes only.

Parameters:

newAttr - The new attribute to be added.

Throws:

IllegalStateException - if a newAttr has already been added to a tree.

appendChild

public Node appendChild(Node node)

Description copied from class: NodeImpl

Adds the node newChild to the end of the list of children of this node. Since the model is immutable checks if current node and node being added are not already in tree.

Specified by:

appendChild in interface Node

Overrides:

appendChild in class NodeImpl

Returns:

The node added.

appendChild

public Node appendChild(Node node,
                        boolean consolidateNamespaces)

insertBefore

public Node insertBefore(Node newChild,
                         Node refChild)
                  throws DOMException

Description copied from class: NodeImpl

Inserts the node newChild before the existing child node refChild. If refChild is null, insert newChild at the end of the list of children. Since the model is immutable checks if current node and node being inserted are not already in tree.

Specified by:

insertBefore in interface Node

Overrides:

insertBefore in class NodeImpl

Parameters:

newChild - - The node to insert.

refChild - - The reference node, i.e., the node before which the new node must be inserted.

Returns:

The node being inserted.

Throws:

DOMException

getXmlFragmentText

public String getXmlFragmentText()

setXmlFragmentText

public void setXmlFragmentText(String text)
                        throws IOException

Throws:

IOException

cloneNode

public Element cloneNode(boolean deep,
                         boolean cloneNamespacePrefix)

Overrides:

cloneNode in class NodeImpl

cloneNamespacePrefix

protected void cloneNamespacePrefix(Map<Integer,String> allNS,
                                    Map<String,String> prefixes)