Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
net.sf.saxon.dom.NodeOverNodeInfo
public abstract class NodeOverNodeInfo
extends java.lang.Object
implements Node
Method Summary | |
Node |
|
Node |
|
short |
|
protected static void |
|
NamedNodeMap |
|
String |
|
NodeList |
|
Object |
|
Node |
|
Node |
|
String |
|
String |
|
Node |
|
String |
|
short |
|
String |
|
Document |
|
Node |
|
String |
|
Node |
|
String |
|
NodeInfo |
|
Object |
|
boolean |
|
boolean |
|
Node |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
String |
|
String |
|
void |
|
Node |
|
Node |
|
void |
|
void |
|
void |
|
Object |
|
static NodeOverNodeInfo |
public Node appendChild(Node newChild) throws DOMException
Adds the nodenewChild
to the end of the list of children of this node. Always fails.
- Parameters:
newChild
- The node to add.
- Returns:
- The node added.
public Node cloneNode(boolean deep)
Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes. Always fails.
- Parameters:
deep
- Iftrue
, recursively clone the subtree under the specified node; iffalse
, clone only the node itself (and its attributes, if it is anElement
).
- Returns:
- The duplicate node.
public short compareDocumentPosition(Node other) throws DOMException
Compare the position of the (other) node in document order with the reference node (this node). DOM Level 3 method.
- Parameters:
other
- the other node.
- Returns:
- Returns how the node is positioned relatively to the reference node.
protected static void disallowUpdate() throws DOMException
Internal method used to indicate that update operations are not allowed
public NamedNodeMap getAttributes()
Return aNamedNodeMap
containing the attributes of this node (if it is anElement
) ornull
otherwise. Note that this implementation changed in Saxon 8.8 to treat namespace declarations as attributes.
public String getBaseURI()
Get the base URI for the node. Default implementation for child nodes gets the base URI of the parent node.
public NodeList getChildNodes()
Return aNodeList
that contains all children of this node. If there are no children, this is aNodeList
containing no nodes.
public Object getFeature(String feature, String version)
Get a feature of this node. DOM Level 3 method, always returns null.
- Parameters:
feature
- the required featureversion
- the version of the required feature
- Returns:
- the value of the feature. Always null in this implementation
public Node getFirstChild()
Get first child
- Returns:
- the first child node of this node, or null if it has no children
public Node getLastChild()
Get last child
- Returns:
- last child of this node, or null if it has no children
public String getLocalName()
Get the local name of this node, following the DOM rules
- Returns:
- The local name of the node. For an element this is the local part of the element name, for an attribute it is the local part of the attribute name. Other node types return null.
public String getNamespaceURI()
The namespace URI of this node, ornull
if it is unspecified.
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 thanELEMENT_NODE
andATTRIBUTE_NODE
and nodes created with a DOM Level 1 method, such ascreateElement
from theDocument
interface, this is alwaysnull
. Per the Namespaces in XML Specification 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.
- Since:
- DOM Level 2
public Node getNextSibling()
Get next sibling node
- Returns:
- The next sibling node. Returns null if the current node is the last child of its parent.
public String getNodeName()
Get the name of this node, following the DOM rules
- Returns:
- The name of the node. For an element this is the element name, for an attribute it is the attribute name, as a lexical QName. Other node types return conventional names such as "#text" or "#comment"
public short getNodeType()
Get the type of this node (node kind, in XPath terminology). Note, the numbers assigned to node kinds in Saxon (seeType
) are the same as those assigned in the DOM
public String getNodeValue()
Get the node value (as defined in the DOM). This is not generally the same as the XPath string-value: in particular, the node value of an element node is null.
public Document getOwnerDocument()
Return theDocument
object associated with this node.
public Node getParentNode()
Find the parent node of this node.
- Returns:
- The Node object describing the containing element or root node.
public String getPrefix()
The namespace prefix of this node, ornull
if it is unspecified.
For nodes of any type other thanELEMENT_NODE
andATTRIBUTE_NODE
and nodes created with a DOM Level 1 method, such ascreateElement
from theDocument
interface, this is alwaysnull
.
- Since:
- DOM Level 2
public Node getPreviousSibling()
Get the previous sibling of the node
- Returns:
- The previous sibling node. Returns null if the current node is the first child of its parent.
public String getTextContent() throws DOMException
Get the text content of a node. This is a DOM Level 3 method. The definition is the same as the definition of the string value of a node in XPath, except in the case of document nodes.
- Returns:
- the string value of the node, or null in the case of document nodes.
public NodeInfo getUnderlyingNodeInfo()
Get the Saxon NodeInfo object representing this node
- Returns:
- the Saxon NodeInfo object
public Object getUserData(String key)
Get user data associated with this node. DOM Level 3 method, always returns null in this implementation
- Parameters:
key
- identifies the user data required
- Returns:
- always null in this implementation
public boolean hasAttributes()
Returns whether this node has any attributes. We treat the declaration of the XML namespace as being present on every element, and since namespace declarations are treated as attributes, every element has at least one attribute. This method therefore returns true.
- Returns:
true
if this node has any attributes,false
otherwise.
- Since:
- DOM Level 2
public boolean hasChildNodes()
Determine whether the node has any children.
- Returns:
true
if this node has any attributes,false
otherwise.
public Node insertBefore(Node newChild, Node refChild) throws DOMException
Insert the nodenewChild
before the existing child noderefChild
. Always fails.
- 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.
public boolean isDefaultNamespace(String namespaceURI)
Test whether a particular namespace is the default namespace. DOM Level 3 method.
- Parameters:
namespaceURI
- the namespace to be tested
- Returns:
- true if this is the default namespace
public boolean isEqualNode(Node arg)
Compare whether two nodes have the same content. This is a DOM Level 3 method.
- Parameters:
arg
- The node to be compared. This must wrap a Saxon NodeInfo.
- Returns:
- true if the two nodes are deep-equal.
public final boolean isSameNode(Node other)
Determine whether this is the same node as another node. DOM Level 3 method.
- Returns:
- true if this Node object and the supplied Node object represent the same node in the tree.
public boolean isSupported(String feature, String version)
Tests whether the DOM implementation implements a specific feature and that feature is supported by this node.
- Parameters:
feature
- The name of the feature to test. This is the same name which can be passed to the methodhasFeature
onDOMImplementation
.version
- This is the version number of the feature to test. In Level 2, version 1, this is the string "2.0". If the version is not specified, supporting any version of the feature will cause the method to returntrue
.
- Returns:
- Returns
true
if the specified feature is supported on this node,false
otherwise.
- Since:
- DOM Level 2
public String lookupNamespaceURI(String prefix)
Find the URI corresponding to a given in-scope prefix
- Parameters:
prefix
- The namespace prefix whose namespace URI is required.
- Returns:
- the corresponding namespace URI, or null if the prefix is not declared.
public String lookupPrefix(String namespaceURI)
Get the (first) prefix assigned to a specified namespace URI, or null if the namespace is not in scope. DOM Level 3 method.
- Parameters:
namespaceURI
- the namespace whose prefix is required
- Returns:
- the corresponding prefix, if there is one, or null if not.
public void normalize()
Puts allText
nodes in the full depth of the sub-tree underneath thisNode
, including attribute nodes, into a "normal" form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separatesText
nodes, i.e., there are neither adjacentText
nodes nor emptyText
nodes.
- Since:
- DOM Level 2
public Node removeChild(Node oldChild) throws DOMException
Remove the child node indicated byoldChild
from the list of children, and returns it. Always fails.
- Parameters:
oldChild
- The node being removed.
- Returns:
- The node removed.
public Node replaceChild(Node newChild, Node oldChild) throws DOMException
Replace the child nodeoldChild
withnewChild
in the list of children, and returns theoldChild
node. Always fails.
- Parameters:
newChild
- The new node to put in the child list.oldChild
- The node being replaced in the list.
- Returns:
- The node replaced.
public void setNodeValue(String nodeValue) throws DOMException
Set the node value. Always fails
public void setPrefix(String prefix) throws DOMException
Set the namespace prefix of this node. Always fails.
public void setTextContent(String textContent) throws DOMException
Set the text content of a node. Always fails.
- Parameters:
textContent
-
public Object setUserData(String key, Object data, UserDataHandler handler)
Set user data. Always throws UnsupportedOperationException in this implementation
- Parameters:
key
-data
-handler
-
- Returns:
- This implementation always throws an exception
public static NodeOverNodeInfo wrap(NodeInfo node)
Factory method to construct a DOM node that wraps an underlying Saxon NodeInfo
- Parameters:
node
- the Saxon NodeInfo object
- Returns:
- the DOM wrapper node