Top Description Fields Constructors Methods
com.sun.org.apache.xml.internal.dtm.ref.dom2dtm

public Class DOM2DTMdefaultNamespaceDeclarationNode

extends Object
implements Attr, TypeInfo
Class Inheritance
All Implemented Interfaces
org.w3c.dom.TypeInfo, org.w3c.dom.Attr, org.w3c.dom.Node
Imports
com.sun.org.apache.xml.internal.dtm.DTMException, org.w3c.dom.Attr, .Document, .Element, .NamedNodeMap, .Node, .NodeList, .TypeInfo, .UserDataHandler, .DOMException

This is a kluge to let us shove a declaration for xml: into the DOM2DTM model. Basically, it creates a proxy node in DOM space to carry the additional information. This is _NOT_ a full DOM implementation, and shouldn't be one since it sits alongside the DOM rather than becoming part of the DOM model. (This used to be an internal class within DOM2DTM. Moved out because I need to perform an instanceof operation on it to support a temporary workaround in DTMManagerDefault.) %REVIEW% What if the DOM2DTM was built around a DocumentFragment and there isn't a single root element? I think this fails that case... %REVIEW% An alternative solution would be to create the node _only_ in DTM space, but given how DOM2DTM is currently written I think this is simplest.

Field Summary

Modifier and TypeField and Description
pack-priv int
pack-priv String
pack-priv final String
pack-priv String
pack-priv Element
pack-priv String

Constructor Summary

AccessConstructor and Description
pack-priv
DOM2DTMdefaultNamespaceDeclarationNode(Element pseudoparent, String prefix, String uri, int handle)

Method Summary

Modifier and TypeMethod and Description
public Node
appendChild(Node
The node to add.If it is a DocumentFragment object, the entire contents of the document fragment are moved into the child list of this node
a
)

Implements org.w3c.dom.Node.appendChild.

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

public Node
cloneNode(boolean
If true, recursively clone the subtree under the specified node; if false, clone only the node itself (and its attributes, if it is an Element).
deep
)

Implements org.w3c.dom.Node.cloneNode.

Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes.

public short

Returns:

Returns how the given node is positioned relatively to this node.
compareDocumentPosition
(Node
The node to compare against this node.
other
)

Implements org.w3c.dom.Node.compareDocumentPosition.

Compares a node with this node with regard to their position in the document.

public NamedNodeMap
getAttributes()

Implements org.w3c.dom.Node.getAttributes.

A NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.

public String
getBaseURI()

Implements org.w3c.dom.Node.getBaseURI.

The absolute base URI of this node or null if undefined.

public NodeList
getChildNodes()

Implements org.w3c.dom.Node.getChildNodes.

A NodeList that contains all children of this node.

public Object

Returns:

Returns an object which implements the specialized APIs of the specified feature and version, if any, or null if there is no object which implements interfaces associated with that feature. If the DOMObject returned by this method implements the Node interface, it must delegate to the primary core Node and not return results inconsistent with the primary core Node such as attributes, childNodes, etc.
getFeature
(String
The name of the feature requested (case-insensitive).
feature
,
String
This is the version number of the feature to test. If the version is null or the empty string, supporting any version of the feature will cause the method to return an object that supports at least one version of the feature.
version
)

Implements org.w3c.dom.Node.getFeature.

This method returns a specialized object which implements the specialized APIs of the specified feature and version.

public Node
getFirstChild()

Implements org.w3c.dom.Node.getFirstChild.

The first child of this node.

public int
getHandleOfNode()

Non-DOM method, part of the temporary kluge %REVIEW% This would be a pruning problem, but since it will always be added to the root element and we prune on elements, we shouldn't have to worry.

public Node
getLastChild()

Implements org.w3c.dom.Node.getLastChild.

The last child of this node.

public String
getLocalName()

Implements org.w3c.dom.Node.getLocalName.

Returns the local part of the qualified name of this node.

public String
getName()

Implements org.w3c.dom.Attr.getName.

Returns the name of this attribute.

public String
getNamespaceURI()

Implements org.w3c.dom.Node.getNamespaceURI.

The namespace URI of this node, or null if it is unspecified (see ).

public Node
getNextSibling()

Implements org.w3c.dom.Node.getNextSibling.

The node immediately following this node.

public String
getNodeName()

Implements org.w3c.dom.Node.getNodeName.

The name of this node, depending on its type; see the table above.

public short
getNodeType()

Implements org.w3c.dom.Node.getNodeType.

A code representing the type of the underlying object, as defined above.

public String
getNodeValue()

Implements org.w3c.dom.Node.getNodeValue.

The value of this node, depending on its type; see the table above.

public Document
getOwnerDocument()

Implements org.w3c.dom.Node.getOwnerDocument.

The Document object associated with this node.

public Element
getOwnerElement()

Implements org.w3c.dom.Attr.getOwnerElement.

The Element node this attribute is attached to or null if this attribute is not in use.

public Node
getParentNode()

Implements org.w3c.dom.Node.getParentNode.

The parent of this node.

public String
getPrefix()

Implements org.w3c.dom.Node.getPrefix.

The namespace prefix of this node, or null if it is unspecified.

public Node
getPreviousSibling()

Implements org.w3c.dom.Node.getPreviousSibling.

The node immediately preceding this node.

public TypeInfo
getSchemaTypeInfo()

Implements org.w3c.dom.Attr.getSchemaTypeInfo.

The type information associated with this attribute.

public boolean
getSpecified()

Implements org.w3c.dom.Attr.getSpecified.

True if this attribute was explicitly given a value in the instance document, false otherwise.

public String
getTextContent()

Implements org.w3c.dom.Node.getTextContent.

This attribute returns the text content of this node and its descendants.

public String
getTypeName()

Implements org.w3c.dom.TypeInfo.getTypeName.

The name of a type declared for the associated element or attribute, or null if unknown.

public String
getTypeNamespace()

Implements org.w3c.dom.TypeInfo.getTypeNamespace.

The namespace of the type declared for the associated element or attribute or null if the element does not have declaration or if no namespace information is available.

public Object

Returns:

Returns the DOMObject associated to the given key on this node, or null if there was none.
getUserData
(String
The key the object is associated to.
key
)

Implements org.w3c.dom.Node.getUserData.

Retrieves the object associated to a key on a this node.

public String
getValue()

Implements org.w3c.dom.Attr.getValue.

On retrieval, the value of the attribute is returned as a string.

public boolean
hasAttributes()

Implements org.w3c.dom.Node.hasAttributes.

Returns whether this node (if it is an element) has any attributes.

public boolean
hasChildNodes()

Implements org.w3c.dom.Node.hasChildNodes.

Returns whether this node has any children.

public Node
insertBefore(Node
The node to insert.
a
,
Node
The reference node, i.e., the node before which the new node must be inserted.
b
)

Implements org.w3c.dom.Node.insertBefore.

Inserts the node newChild before the existing child node refChild.

public boolean

Returns:

true if the specified namespaceURI is the default namespace, false otherwise.
isDefaultNamespace
(String
The namespace URI to look for.
namespaceURI
)

Implements org.w3c.dom.Node.isDefaultNamespace.

DOM Level 3: Experimental This method checks if the specified namespaceURI is the default namespace or not.

public boolean
isDerivedFrom(String
the namespace of the other type definition.
ns
,
String
the name of the other type definition.
localName
,
int
the type of derivation and conditions applied between two types, as described in the list of constants provided in this interface.
derivationMethod
)

Implements org.w3c.dom.TypeInfo.isDerivedFrom.

This method returns if there is a derivation between the reference type definition, i.e. the TypeInfo on which the method is being called, and the other type definition, i.e. the one passed as parameters.

public boolean

Returns:

If the nodes, and possibly subtrees are equal, true otherwise false.
isEqualNode
(Node
The node to compare equality with.
arg
)

Implements org.w3c.dom.Node.isEqualNode.

Tests whether two nodes are equal.

public boolean
isId()

Implements org.w3c.dom.Attr.isId.

Returns whether this attribute is known to be of type ID (i.e. to contain an identifier for its owner element) or not.

public boolean

Returns:

Returns true if the nodes are the same, false otherwise.
isSameNode
(Node
The node to test against.
other
)

Implements org.w3c.dom.Node.isSameNode.

Returns whether this node is the same node as the given one.

public boolean
isSupported(String
The name of the feature to test.
feature
,
String
This is the version number of the feature to test.
version
)

Implements org.w3c.dom.Node.isSupported.

Tests whether the DOM implementation implements a specific feature and that feature is supported by this node, as specified in .

public String

Returns:

th URI for the namespace
lookupNamespaceURI
(String
The prefix to look for. If this parameter is null, the method will return the default namespace URI if any.
specifiedPrefix
)

Implements org.w3c.dom.Node.lookupNamespaceURI.

DOM Level 3 - Experimental: Look up the namespace URI associated to the given prefix, starting from this node.

public String

Returns:

the prefix for the namespace
lookupPrefix
(String namespaceURI)

Implements org.w3c.dom.Node.lookupPrefix.

DOM Level 3 - Experimental: Look up the prefix associated to the given namespace URI, starting from this node.

public void
normalize()

Implements org.w3c.dom.Node.normalize.

Puts all Text nodes in the full depth of the sub-tree underneath this Node, including attribute nodes, into a "normal" form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separates Text nodes, i.e., there are neither adjacent Text nodes nor empty Text nodes.

public Node
removeChild(Node
The node being removed.
a
)

Implements org.w3c.dom.Node.removeChild.

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

public Node
replaceChild(Node
The new node to put in the child list.
a
,
Node
The node being replaced in the list.
b
)

Implements org.w3c.dom.Node.replaceChild.

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

public void
setNodeValue(String value)

Implements org.w3c.dom.Node.setNodeValue.

The value of this node, depending on its type; see the table above.

public void
setPrefix(String value)

Implements org.w3c.dom.Node.setPrefix.

The namespace prefix of this node, or null if it is unspecified.

public void
setTextContent(String textContent)

Implements org.w3c.dom.Node.setTextContent.

This attribute returns the text content of this node and its descendants.

public Object

Returns:

Returns the DOMObject previously associated to the given key on this node, or null if there was none.
setUserData
(String
The key to associate the object to.
key
,
Object
The object to associate to the given key, or null to remove any existing association to that key.
data
,
UserDataHandler
The handler to associate to that key, or null.
handler
)

Implements org.w3c.dom.Node.setUserData.

Associate an object to a key on this node.

public void
setValue(String value)

Implements org.w3c.dom.Attr.setValue.

On retrieval, the value of the attribute is returned as a string.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

handleback to summary
pack-priv int handle
nodenameback to summary
pack-priv String nodename
NOT_SUPPORTED_ERRback to summary
pack-priv final String NOT_SUPPORTED_ERR
prefixback to summary
pack-priv String prefix
pseudoparentback to summary
pack-priv Element pseudoparent
uriback to summary
pack-priv String uri

Constructor Detail

DOM2DTMdefaultNamespaceDeclarationNodeback to summary
pack-priv DOM2DTMdefaultNamespaceDeclarationNode(Element pseudoparent, String prefix, String uri, int handle)

Method Detail

appendChildback to summary
public Node appendChild(Node a)

Implements org.w3c.dom.Node.appendChild.

Doc from org.w3c.dom.Node.appendChild.

Adds the node newChild to the end of the list of children of this node. If the newChild is already in the tree, it is first removed.

Parameters
a:Node

The node to add.If it is a DocumentFragment object, the entire contents of the document fragment are moved into the child list of this node

Returns:Node

The node added.

cloneNodeback to summary
public Node cloneNode(boolean deep)

Implements org.w3c.dom.Node.cloneNode.

Doc from org.w3c.dom.Node.cloneNode.

Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes. The duplicate node has no parent ( parentNode is null) and no user data. User data associated to the imported node is not carried over. However, if any UserDataHandlers has been specified along with the associated data these handlers will be called with the appropriate parameters before this method returns.
Cloning an Element copies all attributes and their values, including those generated by the XML processor to represent defaulted attributes, but this method does not copy any children it contains unless it is a deep clone. This includes text contained in an the Element since the text is contained in a child Text node. Cloning an Attr directly, as opposed to be cloned as part of an Element cloning operation, returns a specified attribute (specified is true). Cloning an Attr always clones its children, since they represent its value, no matter whether this is a deep clone or not. Cloning an EntityReference automatically constructs its subtree if a corresponding Entity is available, no matter whether this is a deep clone or not. Cloning any other type of node simply returns a copy of this node.
Note that cloning an immutable subtree results in a mutable copy, but the children of an EntityReference clone are readonly . In addition, clones of unspecified Attr nodes are specified. And, cloning Document, DocumentType, Entity, and Notation nodes is implementation dependent.

Parameters
deep:boolean

If true, recursively clone the subtree under the specified node; if false, clone only the node itself (and its attributes, if it is an Element).

Returns:Node

The duplicate node.

compareDocumentPositionback to summary
public short compareDocumentPosition(Node other) throws DOMException

Implements org.w3c.dom.Node.compareDocumentPosition.

Compares a node with this node with regard to their position in the document.

Parameters
other:Node

The node to compare against this node.

Returns:short

Returns how the given node is positioned relatively to this node.

Exceptions
DOMException:

Doc from org.w3c.dom.Node.compareDocumentPosition.

NOT_SUPPORTED_ERR: when the compared nodes are from different DOM implementations that do not coordinate to return consistent implementation-specific results.

Since
DOM Level 3
getAttributesback to summary
public NamedNodeMap getAttributes()

Implements org.w3c.dom.Node.getAttributes.

Doc from org.w3c.dom.Node.getAttributes.

A NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.

getBaseURIback to summary
public String getBaseURI()

Implements org.w3c.dom.Node.getBaseURI.

The absolute base URI of this node or null if undefined. This value is computed according to . However, when the Document supports the feature "HTML" , the base URI is computed using first the value of the href attribute of the HTML BASE element if any, and the value of the documentURI attribute from the Document interface otherwise.
When the node is an Element, a Document or a a ProcessingInstruction, this attribute represents the properties [base URI] defined in . When the node is a Notation, an Entity, or an EntityReference, this attribute represents the properties [declaration base URI] in the . How will this be affected by resolution of relative namespace URIs issue?It's not.Should this only be on Document, Element, ProcessingInstruction, Entity, and Notation nodes, according to the infoset? If not, what is it equal to on other nodes? Null? An empty string? I think it should be the parent's.No.Should this be read-only and computed or and actual read-write attribute?Read-only and computed (F2F 19 Jun 2000 and teleconference 30 May 2001).If the base HTML element is not yet attached to a document, does the insert change the Document.baseURI? Yes. (F2F 26 Sep 2001)

Since
DOM Level 3
getChildNodesback to summary
public NodeList getChildNodes()

Implements org.w3c.dom.Node.getChildNodes.

Doc from org.w3c.dom.Node.getChildNodes.

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

getFeatureback to summary
public Object getFeature(String feature, String version)

Implements org.w3c.dom.Node.getFeature.

This method returns a specialized object which implements the specialized APIs of the specified feature and version. The specialized object may also be obtained by using binding-specific casting methods but is not necessarily expected to, as discussed in Mixed DOM implementations.

Parameters
feature:String

The name of the feature requested (case-insensitive).

version:String

This is the version number of the feature to test. If the version is null or the empty string, supporting any version of the feature will cause the method to return an object that supports at least one version of the feature.

Returns:Object

Returns an object which implements the specialized APIs of the specified feature and version, if any, or null if there is no object which implements interfaces associated with that feature. If the DOMObject returned by this method implements the Node interface, it must delegate to the primary core Node and not return results inconsistent with the primary core Node such as attributes, childNodes, etc.

Since
DOM Level 3
getFirstChildback to summary
public Node getFirstChild()

Implements org.w3c.dom.Node.getFirstChild.

Doc from org.w3c.dom.Node.getFirstChild.

The first child of this node. If there is no such node, this returns null.

getHandleOfNodeback to summary
public int getHandleOfNode()

Non-DOM method, part of the temporary kluge %REVIEW% This would be a pruning problem, but since it will always be added to the root element and we prune on elements, we shouldn't have to worry.

getLastChildback to summary
public Node getLastChild()

Implements org.w3c.dom.Node.getLastChild.

Doc from org.w3c.dom.Node.getLastChild.

The last child of this node. If there is no such node, this returns null.

getLocalNameback to summary
public String getLocalName()

Implements org.w3c.dom.Node.getLocalName.

Doc from org.w3c.dom.Node.getLocalName.

Returns the local part of the qualified name of this node.
For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as Document.createElement(), this is always null.

getNameback to summary
public String getName()

Implements org.w3c.dom.Attr.getName.

Doc from org.w3c.dom.Attr.getName.

Returns the name of this attribute. If Node.localName is different from null, this attribute is a qualified name.

getNamespaceURIback to summary
public String getNamespaceURI()

Implements org.w3c.dom.Node.getNamespaceURI.

Doc from org.w3c.dom.Node.getNamespaceURI.

The namespace URI of this node, or null if it is unspecified (see ).
This is not a computed value that is the result of a namespace lookup based on an examination of the namespace declarations in scope. It is merely the namespace URI given at creation time.
For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as Document.createElement(), this is always null.

Note

Per the Namespaces in XML Specification [XML Namespaces] an attribute does not inherit its namespace from the element it is attached to. If an attribute is not explicitly given a namespace, it simply has no namespace.

getNextSiblingback to summary
public Node getNextSibling()

Implements org.w3c.dom.Node.getNextSibling.

Doc from org.w3c.dom.Node.getNextSibling.

The node immediately following this node. If there is no such node, this returns null.

getNodeNameback to summary
public String getNodeName()

Implements org.w3c.dom.Node.getNodeName.

Doc from org.w3c.dom.Node.getNodeName.

The name of this node, depending on its type; see the table above.

getNodeTypeback to summary
public short getNodeType()

Implements org.w3c.dom.Node.getNodeType.

Doc from org.w3c.dom.Node.getNodeType.

A code representing the type of the underlying object, as defined above.

getNodeValueback to summary
public String getNodeValue()

Implements org.w3c.dom.Node.getNodeValue.

Doc from org.w3c.dom.Node.getNodeValue.

The value of this node, depending on its type; see the table above. When it is defined to be null, setting it has no effect, including if the node is read-only.

getOwnerDocumentback to summary
public Document getOwnerDocument()

Implements org.w3c.dom.Node.getOwnerDocument.

Doc from org.w3c.dom.Node.getOwnerDocument.

The Document object associated with this node. This is also the Document object used to create new nodes. When this node is a Document or a DocumentType which is not used with any Document yet, this is null.

getOwnerElementback to summary
public Element getOwnerElement()

Implements org.w3c.dom.Attr.getOwnerElement.

Doc from org.w3c.dom.Attr.getOwnerElement.

The Element node this attribute is attached to or null if this attribute is not in use.

getParentNodeback to summary
public Node getParentNode()

Implements org.w3c.dom.Node.getParentNode.

Doc from org.w3c.dom.Node.getParentNode.

The parent of this node. All nodes, except Attr, Document, DocumentFragment, Entity, and Notation may have a parent. However, if a node has just been created and not yet added to the tree, or if it has been removed from the tree, this is null.

getPrefixback to summary
public String getPrefix()

Implements org.w3c.dom.Node.getPrefix.

Doc from org.w3c.dom.Node.getPrefix.

The namespace prefix of this node, or null if it is unspecified. When it is defined to be null, setting it has no effect, including if the node is read-only.
Note that setting this attribute, when permitted, changes the nodeName attribute, which holds the qualified name, as well as the tagName and name attributes of the Element and Attr interfaces, when applicable.
Setting the prefix to null makes it unspecified, setting it to an empty string is implementation dependent.
Note also that changing the prefix of an attribute that is known to have a default value, does not make a new attribute with the default value and the original prefix appear, since the namespaceURI and localName do not change.
For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as createElement from the Document interface, this is always null.

getPreviousSiblingback to summary
public Node getPreviousSibling()

Implements org.w3c.dom.Node.getPreviousSibling.

Doc from org.w3c.dom.Node.getPreviousSibling.

The node immediately preceding this node. If there is no such node, this returns null.

getSchemaTypeInfoback to summary
public TypeInfo getSchemaTypeInfo()

Implements org.w3c.dom.Attr.getSchemaTypeInfo.

Doc from org.w3c.dom.Attr.getSchemaTypeInfo.

The type information associated with this attribute. While the type information contained in this attribute is guarantee to be correct after loading the document or invoking Document.normalizeDocument(), schemaTypeInfo may not be reliable if the node was moved.

getSpecifiedback to summary
public boolean getSpecified()

Implements org.w3c.dom.Attr.getSpecified.

Doc from org.w3c.dom.Attr.getSpecified.

True if this attribute was explicitly given a value in the instance document, false otherwise. If the application changed the value of this attribute node (even if it ends up having the same value as the default value) then it is set to true. The implementation may handle attributes with default values from other schemas similarly but applications should use Document.normalizeDocument() to guarantee this information is up-to-date.

getTextContentback to summary
public String getTextContent() throws DOMException

Implements org.w3c.dom.Node.getTextContent.

This attribute returns the text content of this node and its descendants. When it is defined to be null, setting it has no effect. When set, any possible children this node may have are removed and replaced by a single Text node containing the string this attribute is set to. On getting, no serialization is performed, the returned string does not contain any markup. No whitespace normalization is performed, the returned string does not contain the element content whitespaces . Similarly, on setting, no parsing is performed either, the input string is taken as pure textual content.
The string returned is made of the text content of this node depending on its type, as defined below:

Node type Content
ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, DOCUMENT_FRAGMENT_NODE concatenation of the textContent attribute value of every child node, excluding COMMENT_NODE and PROCESSING_INSTRUCTION_NODE nodes
ATTRIBUTE_NODE, TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE nodeValue
DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE null
Exceptions
DOMException:
  • NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
  • DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform.
Since
DOM Level 3
getTypeNameback to summary
public String getTypeName()

Implements org.w3c.dom.TypeInfo.getTypeName.

Doc from org.w3c.dom.TypeInfo.getTypeName.

The name of a type declared for the associated element or attribute, or null if unknown.

See Also
org.w3c.dom.TypeInfo#getTypeName()
getTypeNamespaceback to summary
public String getTypeNamespace()

Implements org.w3c.dom.TypeInfo.getTypeNamespace.

Doc from org.w3c.dom.TypeInfo.getTypeNamespace.

The namespace of the type declared for the associated element or attribute or null if the element does not have declaration or if no namespace information is available.

See Also
org.w3c.dom.TypeInfo#getTypeNamespace()
getUserDataback to summary
public Object getUserData(String key)

Implements org.w3c.dom.Node.getUserData.

Retrieves the object associated to a key on a this node. The object must first have been set to this node by calling setUserData with the same key.

Parameters
key:String

The key the object is associated to.

Returns:Object

Returns the DOMObject associated to the given key on this node, or null if there was none.

Since
DOM Level 3
getValueback to summary
public String getValue()

Implements org.w3c.dom.Attr.getValue.

Doc from org.w3c.dom.Attr.getValue.

On retrieval, the value of the attribute is returned as a string. Character and general entity references are replaced with their values. See also the method getAttribute on the Element interface.
On setting, this creates a Text node with the unparsed contents of the string, i.e. any characters that an XML processor would recognize as markup are instead treated as literal text. See also the method Element.setAttribute().
Some specialized implementations, such as some [SVG 1.1] implementations, may do normalization automatically, even after mutation; in such case, the value on retrieval may differ from the value on setting.

hasAttributesback to summary
public boolean hasAttributes()

Implements org.w3c.dom.Node.hasAttributes.

Doc from org.w3c.dom.Node.hasAttributes.

Returns whether this node (if it is an element) has any attributes.

Returns:boolean

Returns true if this node has any attributes, false otherwise.

hasChildNodesback to summary
public boolean hasChildNodes()

Implements org.w3c.dom.Node.hasChildNodes.

Doc from org.w3c.dom.Node.hasChildNodes.

Returns whether this node has any children.

Returns:boolean

Returns true if this node has any children, false otherwise.

insertBeforeback to summary
public Node insertBefore(Node a, Node b)

Implements org.w3c.dom.Node.insertBefore.

Doc from org.w3c.dom.Node.insertBefore.

Inserts the node newChild before the existing child node refChild. If refChild is null, insert newChild at the end of the list of children.
If newChild is a DocumentFragment object, all of its children are inserted, in the same order, before refChild. If the newChild is already in the tree, it is first removed.

Note

Inserting a node before itself is implementation dependent.

Parameters
a:Node

The node to insert.

b:Node

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

Returns:Node

The node being inserted.

isDefaultNamespaceback to summary
public boolean isDefaultNamespace(String namespaceURI)

Implements org.w3c.dom.Node.isDefaultNamespace.

DOM Level 3: Experimental This method checks if the specified namespaceURI is the default namespace or not.

Parameters
namespaceURI:String

The namespace URI to look for.

Returns:boolean

true if the specified namespaceURI is the default namespace, false otherwise.

Since
DOM Level 3
isDerivedFromback to summary
public boolean isDerivedFrom(String ns, String localName, int derivationMethod)

Implements org.w3c.dom.TypeInfo.isDerivedFrom.

Doc from org.w3c.dom.TypeInfo.isDerivedFrom.

This method returns if there is a derivation between the reference type definition, i.e. the TypeInfo on which the method is being called, and the other type definition, i.e. the one passed as parameters.

Parameters
ns:String

the namespace of the other type definition.

localName:String

the name of the other type definition.

derivationMethod:int

the type of derivation and conditions applied between two types, as described in the list of constants provided in this interface.

Returns:boolean

If the document's schema is a DTD or no schema is associated with the document, this method will always return false . If the document's schema is an XML Schema, the method will return true if the reference type definition is derived from the other type definition according to the derivation parameter. If the value of the parameter is 0 (no bit is set to 1 for the derivationMethod parameter), the method will return true if the other type definition can be reached by recursing any combination of {base type definition}, {item type definition}, or {member type definitions} from the reference type definition.

See Also
or.gw3c.dom.TypeInfo#isDerivedFrom(String, String, int)
isEqualNodeback to summary
public boolean isEqualNode(Node arg)

Implements org.w3c.dom.Node.isEqualNode.

Tests whether two nodes are equal.
This method tests for equality of nodes, not sameness (i.e., whether the two nodes are references to the same object) which can be tested with Node.isSameNode. All nodes that are the same will also be equal, though the reverse may not be true.
Two nodes are equal if and only if the following conditions are satisfied: The two nodes are of the same type.The following string attributes are equal: nodeName, localName, namespaceURI, prefix, nodeValue , baseURI. This is: they are both null, or they have the same length and are character for character identical. The attributes NamedNodeMaps are equal. This is: they are both null, or they have the same length and for each node that exists in one map there is a node that exists in the other map and is equal, although not necessarily at the same index.The childNodes NodeLists are equal. This is: they are both null, or they have the same length and contain equal nodes at the same index. This is true for Attr nodes as for any other type of node. Note that normalization can affect equality; to avoid this, nodes should be normalized before being compared.
For two DocumentType nodes to be equal, the following conditions must also be satisfied: The following string attributes are equal: publicId, systemId, internalSubset.The entities NamedNodeMaps are equal.The notations NamedNodeMaps are equal.
On the other hand, the following do not affect equality: the ownerDocument attribute, the specified attribute for Attr nodes, the isWhitespaceInElementContent attribute for Text nodes, as well as any user data or event listeners registered on the nodes.

Parameters
arg:Node

The node to compare equality with.

Returns:boolean

If the nodes, and possibly subtrees are equal, true otherwise false.

Since
DOM Level 3
isIdback to summary
public boolean isId()

Implements org.w3c.dom.Attr.isId.

Doc from org.w3c.dom.Attr.isId.

Returns whether this attribute is known to be of type ID (i.e. to contain an identifier for its owner element) or not. When it is and its value is unique, the ownerElement of this attribute can be retrieved using the method Document.getElementById . The implementation could use several ways to determine if an attribute node is known to contain an identifier:

  • If validation occurred using an XML Schema [XML Schema Part 1] while loading the document or while invoking Document.normalizeDocument(), the post-schema-validation infoset contributions (PSVI contributions) values are used to determine if this attribute is a schema-determined ID attribute using the schema-determined ID definition in [XPointer] .
  • If validation occurred using a DTD while loading the document or while invoking Document.normalizeDocument(), the infoset [type definition] value is used to determine if this attribute is a DTD-determined ID attribute using the DTD-determined ID definition in [XPointer] .
  • from the use of the methods Element.setIdAttribute(), Element.setIdAttributeNS(), or Element.setIdAttributeNode(), i.e. it is an user-determined ID attribute;

    Note: XPointer framework (see section 3.2 in [XPointer] ) consider the DOM user-determined ID attribute as being part of the XPointer externally-determined ID definition.

  • using mechanisms that are outside the scope of this specification, it is then an externally-determined ID attribute. This includes using schema languages different from XML schema and DTD.

If validation occurred while invoking Document.normalizeDocument(), all user-determined ID attributes are reset and all attribute nodes ID information are then reevaluated in accordance to the schema used. As a consequence, if the Attr.schemaTypeInfo attribute contains an ID type, isId will always return true.
isSameNodeback to summary
public boolean isSameNode(Node other)

Implements org.w3c.dom.Node.isSameNode.

Returns whether this node is the same node as the given one.
This method provides a way to determine whether two Node references returned by the implementation reference the same object. When two Node references are references to the same object, even if through a proxy, the references may be used completely interchangably, such that all attributes have the same values and calling the same DOM method on either reference always has exactly the same effect.

Parameters
other:Node

The node to test against.

Returns:boolean

Returns true if the nodes are the same, false otherwise.

Since
DOM Level 3
isSupportedback to summary
public boolean isSupported(String feature, String version)

Implements org.w3c.dom.Node.isSupported.

Doc from org.w3c.dom.Node.isSupported.

Tests whether the DOM implementation implements a specific feature and that feature is supported by this node, as specified in .

Parameters
feature:String

The name of the feature to test.

version:String

This is the version number of the feature to test.

Returns:boolean

Returns true if the specified feature is supported on this node, false otherwise.

lookupNamespaceURIback to summary
public String lookupNamespaceURI(String specifiedPrefix)

Implements org.w3c.dom.Node.lookupNamespaceURI.

DOM Level 3 - Experimental: Look up the namespace URI associated to the given prefix, starting from this node. Use lookupNamespaceURI(null) to lookup the default namespace

Parameters
specifiedPrefix:String

Doc from org.w3c.dom.Node.lookupNamespaceURI.

The prefix to look for. If this parameter is null, the method will return the default namespace URI if any.

Returns:String

th URI for the namespace

Since
DOM Level 3
lookupPrefixback to summary
public String lookupPrefix(String namespaceURI)

Implements org.w3c.dom.Node.lookupPrefix.

DOM Level 3 - Experimental: Look up the prefix associated to the given namespace URI, starting from this node.

Returns:String

the prefix for the namespace

normalizeback to summary
public void normalize()

Implements org.w3c.dom.Node.normalize.

Doc from org.w3c.dom.Node.normalize.

Puts all Text nodes in the full depth of the sub-tree underneath this Node, including attribute nodes, into a "normal" form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separates Text nodes, i.e., there are neither adjacent Text nodes nor empty Text nodes. This can be used to ensure that the DOM view of a document is the same as if it were saved and re-loaded, and is useful when operations (such as XPointer [XPointer] lookups) that depend on a particular document tree structure are to be used. If the parameter "normalize-characters" of the DOMConfiguration object attached to the Node.ownerDocument is true, this method will also fully normalize the characters of the Text nodes.

Note

In cases where the document contains CDATASections, the normalize operation alone may not be sufficient, since XPointers do not differentiate between Text nodes and CDATASection nodes.

removeChildback to summary
public Node removeChild(Node a)

Implements org.w3c.dom.Node.removeChild.

Doc from org.w3c.dom.Node.removeChild.

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

Parameters
a:Node

The node being removed.

Returns:Node

The node removed.

replaceChildback to summary
public Node replaceChild(Node a, Node b)

Implements org.w3c.dom.Node.replaceChild.

Doc from org.w3c.dom.Node.replaceChild.

Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node.
If newChild is a DocumentFragment object, oldChild is replaced by all of the DocumentFragment children, which are inserted in the same order. If the newChild is already in the tree, it is first removed.

Note

Replacing a node with itself is implementation dependent.

Parameters
a:Node

The new node to put in the child list.

b:Node

The node being replaced in the list.

Returns:Node

The node replaced.

setNodeValueback to summary
public void setNodeValue(String value)

Implements org.w3c.dom.Node.setNodeValue.

Doc from org.w3c.dom.Node.setNodeValue.

The value of this node, depending on its type; see the table above. When it is defined to be null, setting it has no effect, including if the node is read-only.

setPrefixback to summary
public void setPrefix(String value)

Implements org.w3c.dom.Node.setPrefix.

Doc from org.w3c.dom.Node.setPrefix.

The namespace prefix of this node, or null if it is unspecified. When it is defined to be null, setting it has no effect, including if the node is read-only.
Note that setting this attribute, when permitted, changes the nodeName attribute, which holds the qualified name, as well as the tagName and name attributes of the Element and Attr interfaces, when applicable.
Setting the prefix to null makes it unspecified, setting it to an empty string is implementation dependent.
Note also that changing the prefix of an attribute that is known to have a default value, does not make a new attribute with the default value and the original prefix appear, since the namespaceURI and localName do not change.
For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as createElement from the Document interface, this is always null.

setTextContentback to summary
public void setTextContent(String textContent) throws DOMException

Implements org.w3c.dom.Node.setTextContent.

This attribute returns the text content of this node and its descendants. When it is defined to be null, setting it has no effect. When set, any possible children this node may have are removed and replaced by a single Text node containing the string this attribute is set to. On getting, no serialization is performed, the returned string does not contain any markup. No whitespace normalization is performed, the returned string does not contain the element content whitespaces . Similarly, on setting, no parsing is performed either, the input string is taken as pure textual content.
The string returned is made of the text content of this node depending on its type, as defined below:

Node type Content
ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, DOCUMENT_FRAGMENT_NODE concatenation of the textContent attribute value of every child node, excluding COMMENT_NODE and PROCESSING_INSTRUCTION_NODE nodes
ATTRIBUTE_NODE, TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE nodeValue
DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE null
Exceptions
DOMException:
  • NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
  • DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform.
Since
DOM Level 3
setUserDataback to summary
public Object setUserData(String key, Object data, UserDataHandler handler)

Implements org.w3c.dom.Node.setUserData.

Associate an object to a key on this node. The object can later be retrieved from this node by calling getUserData with the same key.

Parameters
key:String

The key to associate the object to.

data:Object

The object to associate to the given key, or null to remove any existing association to that key.

handler:UserDataHandler

The handler to associate to that key, or null.

Returns:Object

Returns the DOMObject previously associated to the given key on this node, or null if there was none.

Since
DOM Level 3
setValueback to summary
public void setValue(String value)

Implements org.w3c.dom.Attr.setValue.

Doc from org.w3c.dom.Attr.setValue.

On retrieval, the value of the attribute is returned as a string. Character and general entity references are replaced with their values. See also the method getAttribute on the Element interface.
On setting, this creates a Text node with the unparsed contents of the string, i.e. any characters that an XML processor would recognize as markup are instead treated as literal text. See also the method Element.setAttribute().
Some specialized implementations, such as some [SVG 1.1] implementations, may do normalization automatically, even after mutation; in such case, the value on retrieval may differ from the value on setting.