org.apache.xerces.impl.xs.opti.DefaultNode
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object
public class DefaultNode
| Field Summary |
|---|
| Constructor Summary | |
|---|---|
DefaultNode()
|
|
| 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, i.e., serves as a generic copy constructor for nodes. |
short |
compareDocumentPosition(Node other)
Compares the reference node, i.e. |
NamedNodeMap |
getAttributes()
A NamedNodeMap containing the attributes of this node (if
it is an Element) or null otherwise. |
java.lang.String |
getBaseURI()
DOM Level 3 |
NodeList |
getChildNodes()
A NodeList that contains all children of this node. |
java.lang.Object |
getFeature(java.lang.String feature,
java.lang.String version)
This method returns a specialized object which implements the specialized APIs of the specified feature and version, as specified in . |
Node |
getFirstChild()
The first child of this node. |
Node |
getLastChild()
The last child of this node. |
java.lang.String |
getLocalName()
Returns the local part of the qualified name of this node. |
java.lang.String |
getNamespaceURI()
The namespace URI of this node, or null if it is
unspecified (see ). |
Node |
getNextSibling()
The node immediately following this node. |
java.lang.String |
getNodeName()
The name of this node, depending on its type; see the table above. |
short |
getNodeType()
A code representing the type of the underlying object, as defined above. |
java.lang.String |
getNodeValue()
The value of this node, depending on its type; see the table above. |
Document |
getOwnerDocument()
The Document object associated with this node. |
Node |
getParentNode()
The parent of this node. |
java.lang.String |
getPrefix()
The namespace prefix of this node, or null if it is
unspecified. |
Node |
getPreviousSibling()
The node immediately preceding this node. |
java.lang.String |
getTextContent()
This attribute returns the text content of this node and its descendants. |
java.lang.Object |
getUserData(java.lang.String key)
Retrieves the object associated to a key on a this node. |
boolean |
hasAttributes()
Returns whether this node (if it is an element) has any attributes. |
boolean |
hasChildNodes()
Returns whether this node has any children. |
Node |
insertBefore(Node newChild,
Node refChild)
Inserts the node newChild before the existing child node
refChild. |
boolean |
isDefaultNamespace(java.lang.String namespaceURI)
This method checks if the specified namespaceURI is the
default namespace or not. |
boolean |
isEqualNode(Node arg)
Tests whether two nodes are equal. |
boolean |
isSameNode(Node other)
Returns whether this node is the same node as the given one. |
boolean |
isSupported(java.lang.String feature,
java.lang.String version)
Tests whether the DOM implementation implements a specific feature and that feature is supported by this node, as specified in . |
java.lang.String |
lookupNamespaceURI(java.lang.String prefix)
Look up the namespace URI associated to the given prefix, starting from this node. |
java.lang.String |
lookupPrefix(java.lang.String namespaceURI)
Look up the prefix associated to the given namespace URI, starting from this node. |
void |
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. |
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 |
setNodeValue(java.lang.String nodeValue)
The value of this node, depending on its type; see the table above. |
void |
setPrefix(java.lang.String prefix)
The namespace prefix of this node, or null if it is
unspecified. |
void |
setTextContent(java.lang.String textContent)
This attribute returns the text content of this node and its descendants. |
java.lang.Object |
setUserData(java.lang.String key,
java.lang.Object data,
UserDataHandler handler)
Associate an object to a key on this node. |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public DefaultNode()
| Method Detail |
|---|
public java.lang.String getNodeName()
Node
getNodeName in interface Node
public java.lang.String getNodeValue()
throws DOMException
Nodenull, setting it has no effect,
including if the node is read-only.
getNodeValue in interface NodeDOMException - DOMSTRING_SIZE_ERR: Raised when it would return more characters than
fit in a DOMString variable on the implementation
platform.public short getNodeType()
Node
getNodeType in interface Nodepublic Node getParentNode()
NodeAttr,
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.
getParentNode in interface Nodepublic 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()
Nodenull.
getFirstChild in interface Nodepublic Node getLastChild()
Nodenull.
getLastChild in interface Nodepublic Node getPreviousSibling()
Nodenull.
getPreviousSibling in interface Nodepublic Node getNextSibling()
Nodenull.
getNextSibling in interface Nodepublic NamedNodeMap getAttributes()
NodeNamedNodeMap containing the attributes of this node (if
it is an Element) or null otherwise.
getAttributes in interface Nodepublic Document getOwnerDocument()
NodeDocument 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.
getOwnerDocument in interface Nodepublic boolean hasChildNodes()
Node
hasChildNodes in interface Nodetrue if this node has any children,
false otherwise.public Node cloneNode(boolean deep)
NodeparentNode 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.
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.
EntityReference clone are readonly
. In addition, clones of unspecified Attr nodes are
specified. And, cloning Document,
DocumentType, Entity, and
Notation nodes is implementation dependent.
cloneNode in interface Nodedeep - 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).
public void normalize()
NodeText 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.
normalize in interface Node
public boolean isSupported(java.lang.String feature,
java.lang.String version)
Node
isSupported in interface Nodefeature - The name of the feature to test.version - This is the version number of the feature to test.
true if the specified feature is
supported on this node, false otherwise.public java.lang.String getNamespaceURI()
Nodenull if it is
unspecified (see ).
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.
getNamespaceURI in interface Nodepublic java.lang.String getPrefix()
Nodenull if it is
unspecified. When it is defined to be null, setting it
has no effect, including if the node is read-only.
nodeName attribute, which holds the qualified name, as
well as the tagName and name attributes of
the Element and Attr interfaces, when
applicable.
null makes it unspecified,
setting it to an empty string is implementation dependent.
namespaceURI and localName do not change.
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.
getPrefix in interface Nodepublic java.lang.String getLocalName()
NodeELEMENT_NODE and
ATTRIBUTE_NODE and nodes created with a DOM Level 1
method, such as Document.createElement(), this is always
null.
getLocalName in interface Nodepublic java.lang.String getBaseURI()
getBaseURI in interface Nodepublic boolean hasAttributes()
Node
hasAttributes in interface Nodetrue if this node has any attributes,
false otherwise.
public void setNodeValue(java.lang.String nodeValue)
throws DOMException
Nodenull, setting it has no effect,
including if the node is read-only.
setNodeValue in interface NodeDOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly and if
it is not defined to be null.
public Node insertBefore(Node newChild,
Node refChild)
throws DOMException
NodenewChild before the existing child node
refChild. If refChild is null,
insert newChild at the end of the list of children.
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.
insertBefore in interface NodenewChild - The node to insert.refChild - The reference node, i.e., the node before which the
new node must be inserted.
DOMException - HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not
allow children of the type of the newChild node, or if
the node to insert is one of this node's ancestors or this node
itself, or if this node is of type Document and the
DOM application attempts to insert a second
DocumentType or Element node.
newChild was created
from a different document than the one that created this node.
refChild is not a child of
this node.
Document,
this exception might be raised if the DOM implementation doesn't
support the insertion of a DocumentType or
Element node.
public Node replaceChild(Node newChild,
Node oldChild)
throws DOMException
NodeoldChild with newChild
in the list of children, and returns the oldChild node.
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.
replaceChild in interface NodenewChild - The new node to put in the child list.oldChild - The node being replaced in the list.
DOMException - HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not
allow children of the type of the newChild node, or if
the node to put in is one of this node's ancestors or this node
itself, or if this node is of type Document and the
result of the replacement operation would add a second
DocumentType or Element on the
Document node.
newChild was created
from a different document than the one that created this node.
oldChild is not a child of
this node.
Document,
this exception might be raised if the DOM implementation doesn't
support the replacement of the DocumentType child or
Element child.
public Node removeChild(Node oldChild)
throws DOMException
NodeoldChild from the list
of children, and returns it.
removeChild in interface NodeoldChild - The node being removed.
DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
oldChild is not a child of
this node.
Document,
this exception might be raised if the DOM implementation doesn't
support the removal of the DocumentType child or the
Element child.
public Node appendChild(Node newChild)
throws DOMException
NodenewChild to the end of the list of children
of this node. If the newChild is already in the tree, it
is first removed.
appendChild in interface NodenewChild - 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
DOMException - HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not
allow children of the type of the newChild node, or if
the node to append is one of this node's ancestors or this node
itself, or if this node is of type Document and the
DOM application attempts to append a second
DocumentType or Element node.
newChild was created
from a different document than the one that created this node.
newChild node is a child
of the Document node, this exception might be raised
if the DOM implementation doesn't support the removal of the
DocumentType child or Element child.
public void setPrefix(java.lang.String prefix)
throws DOMException
Nodenull if it is
unspecified. When it is defined to be null, setting it
has no effect, including if the node is read-only.
nodeName attribute, which holds the qualified name, as
well as the tagName and name attributes of
the Element and Attr interfaces, when
applicable.
null makes it unspecified,
setting it to an empty string is implementation dependent.
namespaceURI and localName do not change.
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.
setPrefix in interface NodeDOMException - INVALID_CHARACTER_ERR: Raised if the specified prefix contains an
illegal character according to the XML version in use specified in
the Document.xmlVersion attribute.
prefix is
malformed per the Namespaces in XML specification, if the
namespaceURI of this node is null, if the
specified prefix is "xml" and the namespaceURI of this
node is different from "
http://www.w3.org/XML/1998/namespace", if this node is an attribute and the specified prefix is "xmlns" and
the namespaceURI of this node is different from "http://www.w3.org/2000/xmlns/", or if this node is an attribute and the qualifiedName of
this node is "xmlns" [XML Namespaces]
.public short compareDocumentPosition(Node other)
Node
compareDocumentPosition in interface Nodeother - The node to compare against the reference node.
public java.lang.String getTextContent()
throws DOMException
Nodenull, setting it
has no effect. On setting, any possible children this node may have
are removed and, if it the new string is not empty or
null, replaced by a single Text node
containing the string this attribute is set to.
Text.isElementContentWhitespace). Similarly, on setting,
no parsing is performed either, the input string is taken as pure
textual content.
| Node type | Content |
|---|---|
| ELEMENT_NODE, ATTRIBUTE_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. This is the empty string if the
node has no children. |
| TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE | nodeValue |
| DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE | null |
getTextContent in interface NodeDOMException - DOMSTRING_SIZE_ERR: Raised when it would return more characters than
fit in a DOMString variable on the implementation
platform.
public void setTextContent(java.lang.String textContent)
throws DOMException
Nodenull, setting it
has no effect. On setting, any possible children this node may have
are removed and, if it the new string is not empty or
null, replaced by a single Text node
containing the string this attribute is set to.
Text.isElementContentWhitespace). Similarly, on setting,
no parsing is performed either, the input string is taken as pure
textual content.
| Node type | Content |
|---|---|
| ELEMENT_NODE, ATTRIBUTE_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. This is the empty string if the
node has no children. |
| TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE | nodeValue |
| DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE | null |
setTextContent in interface NodeDOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.public boolean isSameNode(Node other)
NodeNode 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 interchangeably, such that all attributes have the
same values and calling the same DOM method on either reference
always has exactly the same effect.
isSameNode in interface Nodeother - The node to test against.
true if the nodes are the same,
false otherwise.public java.lang.String lookupPrefix(java.lang.String namespaceURI)
Node
lookupPrefix in interface NodenamespaceURI - The namespace URI to look for.
null if none is found. If more than one prefix are
associated to the namespace prefix, the returned namespace prefix
is implementation dependent.public boolean isDefaultNamespace(java.lang.String namespaceURI)
NodenamespaceURI is the
default namespace or not.
isDefaultNamespace in interface NodenamespaceURI - The namespace URI to look for.
true if the specified
namespaceURI is the default namespace,
false otherwise.public java.lang.String lookupNamespaceURI(java.lang.String prefix)
Node
lookupNamespaceURI in interface Nodeprefix - The prefix to look for. If this parameter is
null, the method will return the default namespace URI
if any.
null if
none is found.public boolean isEqualNode(Node arg)
NodeNode.isSameNode(). All nodes that are the
same will also be equal, though the reverse may not be true.
nodeName, localName,
namespaceURI, prefix, nodeValue
. This is: they are both null, or they have the same
length and are character for character identical.
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.
childNodes NodeLists are equal.
This is: they are both null, or they have the same
length and contain equal nodes at the same index. Note that
normalization can affect equality; to avoid this, nodes should be
normalized before being compared.
DocumentType nodes to be equal, the following
conditions must also be satisfied:
publicId, systemId,
internalSubset.
entities
NamedNodeMaps are equal.
notations
NamedNodeMaps are equal.
ownerDocument, baseURI, and
parentNode attributes, the specified
attribute for Attr nodes, the schemaTypeInfo
attribute for Attr and Element nodes, the
Text.isElementContentWhitespace attribute for
Text nodes, as well as any user data or event listeners
registered on the nodes.
Note: As a general rule, anything not mentioned in the description above is not significant in consideration of equality checking. Note that future versions of this specification may take into account more attributes and implementations conform to this specification are expected to be updated accordingly.
isEqualNode in interface Nodearg - The node to compare equality with.
true if the nodes are equal,
false otherwise.
public java.lang.Object getFeature(java.lang.String feature,
java.lang.String version)
NodeNode
interface.
getFeature in interface Nodefeature - The name of the feature requested. Note that any plus
sign "+" prepended to the name of the feature will be ignored since
it is not significant in the context of this method.version - This is the version number of the feature to test.
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.
public java.lang.Object setUserData(java.lang.String key,
java.lang.Object data,
UserDataHandler handler)
NodegetUserData with the
same key.
setUserData in interface Nodekey - The key to associate the object to.data - The object to associate to the given key, or
null to remove any existing association to that key.handler - The handler to associate to that key, or
null.
DOMUserData previously associated to
the given key on this node, or null if there was none.public java.lang.Object getUserData(java.lang.String key)
NodesetUserData with the same key.
getUserData in interface Nodekey - The key the object is associated to.
DOMUserData associated to the given
key on this node, or null if there was none.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||