public class DOMNodeWrapper extends AbstractNodeWrapper implements SiblingCountingNode, SteppingNode<DOMNodeWrapper>
This is the implementation of the NodeInfo interface used as a wrapper for DOM nodes.
Because the DOM is not thread-safe even when reading, and because Saxon-EE can spawn multiple threads that access the same input tree, all methods that invoke DOM methods are synchronized on the Document object.
Modifier and Type | Field and Description |
---|---|
protected DocumentWrapper |
docWrapper |
protected int |
index |
protected org.w3c.dom.Node |
node |
protected short |
nodeKind |
protected int |
span |
treeInfo
ALL_NAMESPACES, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES
Modifier | Constructor and Description |
---|---|
protected |
DOMNodeWrapper(org.w3c.dom.Node node,
DocumentWrapper docWrapper,
DOMNodeWrapper parent,
int index)
This constructor is protected: nodes should be created using the makeWrapper
factory method
|
Modifier and Type | Method and Description |
---|---|
int |
compareOrder(NodeInfo other)
Determine the relative position of this node and another node, in document order.
|
int |
comparePosition(NodeInfo other)
Determine the relative position of this node and another node, in document order,
distinguishing whether the first node is a preceding, following, descendant, ancestor,
or the same node as the second.
|
void |
copy(Receiver out,
int copyOptions,
Location locationId)
Copy this node to a given outputter (deep copy)
|
static void |
expandStringValue(org.w3c.dom.NodeList list,
FastStringBuffer sb) |
void |
generateId(FastStringBuffer buffer)
Get a character string that uniquely identifies this node.
|
java.lang.String |
getAttributeValue(java.lang.String uri,
java.lang.String local)
Get the string value of a given attribute of this node
|
NamespaceBinding[] |
getDeclaredNamespaces(NamespaceBinding[] buffer)
Get all namespace undeclarations and undeclarations defined on this element.
|
java.lang.String |
getDisplayName()
Get the display name of this node.
|
DOMNodeWrapper |
getFirstChild()
Get the first child of this node
|
static java.lang.String |
getLocalName(org.w3c.dom.Node node)
Get the local name of a DOM element or attribute node.
|
java.lang.String |
getLocalPart()
Get the local part of the name of this node.
|
DOMNodeWrapper |
getNextSibling()
Get the next sibling of this node
|
int |
getNodeKind()
Return the kind of node.
|
DOMNodeWrapper |
getParent()
Get the NodeInfo object representing the parent of this node
|
java.lang.String |
getPrefix()
Get the prefix of the name of the node.
|
DOMNodeWrapper |
getPreviousSibling()
Get the previous sibling of this node
|
NodeInfo |
getRoot()
Get the root node - always a document node with this tree implementation
|
int |
getSiblingPosition()
Get the index position of this node among its siblings (starting from 0).
|
java.lang.CharSequence |
getStringValueCS()
Get the value of the item as a CharSequence.
|
DOMNodeWrapper |
getSuccessorElement(DOMNodeWrapper anchor,
java.lang.String uri,
java.lang.String local)
Find the next matching element in document order; that is, the first child element
with the required name if there is one; otherwise the next sibling element
if there is one; otherwise the next sibling element of the parent, grandparent, etc, up to the anchor element.
|
DocumentWrapper |
getTreeInfo()
Get information about the tree to which this NodeInfo belongs
|
java.lang.Object |
getUnderlyingNode()
Get the underlying DOM node, to implement the VirtualNode interface
|
java.lang.String |
getURI()
Get the URI part of the name of this node.
|
boolean |
hasChildNodes()
Determine whether the node has any children.
|
boolean |
isId()
Determine whether this node has the is-id property
|
boolean |
isSameNodeInfo(NodeInfo other)
Determine whether this is the same node as another node.
|
protected AxisIterator |
iterateAttributes(NodeTest nodeTest)
Return an iterator over the attributes of this element node.
|
protected AxisIterator |
iterateChildren(NodeTest nodeTest)
Return an iterator over the children of this node.
|
protected AxisIterator |
iterateDescendants(NodeTest nodeTest,
boolean includeSelf)
Return an iterator over the descendants of this node.
|
protected AxisIterator |
iterateSiblings(NodeTest nodeTest,
boolean forwards)
Return an iterator over the siblings of this node.
|
protected static DOMNodeWrapper |
makeWrapper(org.w3c.dom.Node node,
DocumentWrapper docWrapper)
Factory method to wrap a DOM node with a wrapper that implements the Saxon
NodeInfo interface.
|
protected static DOMNodeWrapper |
makeWrapper(org.w3c.dom.Node node,
DocumentWrapper docWrapper,
DOMNodeWrapper parent,
int index)
Factory method to wrap a DOM node with a wrapper that implements the Saxon
NodeInfo interface.
|
atomize, equals, getBaseURI, getColumnNumber, getConfiguration, getFingerprint, getLineNumber, getNamePool, getPublicId, getRealNode, getSchemaType, getStringValue, getSystemId, hasFingerprint, hashCode, head, isIdref, isNilled, isStreamed, iterate, iterateAxis, iterateAxis, saveLocation, setSystemId
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
atomize, equals, getBaseURI, getColumnNumber, getConfiguration, getFingerprint, getLineNumber, getPublicId, getSchemaType, getStringValue, getSystemId, hasFingerprint, hashCode, isIdref, isNilled, isStreamed, iterateAxis, iterateAxis
saveLocation
protected org.w3c.dom.Node node
protected short nodeKind
protected DocumentWrapper docWrapper
protected int index
protected int span
protected DOMNodeWrapper(org.w3c.dom.Node node, DocumentWrapper docWrapper, DOMNodeWrapper parent, int index)
node
- The DOM node to be wrappeddocWrapper
- The wrapper for the Document node at the root of the DOM tree. Never null
except in the case where we are creating the DocumentWrapper itself (which is a subclass).parent
- The DOMNodeWrapper that wraps the parent of this node. May be null if unknown.index
- Position of this node among its siblings, 0-based. May be -1 if unknown.protected static DOMNodeWrapper makeWrapper(org.w3c.dom.Node node, DocumentWrapper docWrapper)
node
- The DOM nodedocWrapper
- The wrapper for the containing Document nodejava.lang.NullPointerException
- if the node or the document wrapper are nullprotected static DOMNodeWrapper makeWrapper(org.w3c.dom.Node node, DocumentWrapper docWrapper, DOMNodeWrapper parent, int index)
node
- The DOM nodedocWrapper
- The wrapper for the containing Document node *parent
- The wrapper for the parent of the JDOM nodeindex
- The position of this node relative to its siblingspublic DocumentWrapper getTreeInfo()
NodeInfo
getTreeInfo
in interface NodeInfo
getTreeInfo
in class AbstractNodeWrapper
public java.lang.Object getUnderlyingNode()
getUnderlyingNode
in interface VirtualNode
public int getNodeKind()
getNodeKind
in interface NodeInfo
Type
public boolean isSameNodeInfo(NodeInfo other)
isSameNodeInfo
in interface NodeInfo
isSameNodeInfo
in class AbstractNodeWrapper
other
- the node to be compared with this nodepublic int compareOrder(NodeInfo other)
compareOrder
in interface NodeInfo
other
- The other node, whose position is to be compared with this nodepublic int comparePosition(NodeInfo other)
comparePosition
in interface NodeInfo
comparePosition
in class AbstractNodeWrapper
other
- The other node, whose position is to be compared with this
nodeAxisInfo.PRECEDING
if this node is on the preceding axis of the other node;
AxisInfo.FOLLOWING
if it is on the following axis; AxisInfo.ANCESTOR
if the first node is an
ancestor of the second; AxisInfo.DESCENDANT
if the first is a descendant of the second;
AxisInfo.SELF
if they are the same node.java.lang.UnsupportedOperationException
- if either node is an attribute or namespacepublic java.lang.CharSequence getStringValueCS()
getStringValueCS
in interface Item
Item.getStringValue()
public static void expandStringValue(org.w3c.dom.NodeList list, FastStringBuffer sb)
public java.lang.String getLocalPart()
getLocalPart
in interface NodeInfo
public static java.lang.String getLocalName(org.w3c.dom.Node node)
node
- the DOM element or attribute nodepublic java.lang.String getURI()
public java.lang.String getPrefix()
public java.lang.String getDisplayName()
getDisplayName
in interface NodeInfo
getDisplayName
in class AbstractNodeWrapper
public DOMNodeWrapper getParent()
getParent
in interface NodeInfo
getParent
in interface SteppingNode<DOMNodeWrapper>
public int getSiblingPosition()
Despite the name, this method also returns a meaningful result for attribute nodes; it returns the position of the attribute among the attributes of its parent element, when they are listed in document order.
getSiblingPosition
in interface SiblingCountingNode
protected AxisIterator iterateAttributes(NodeTest nodeTest)
AbstractNodeWrapper
iterateAttributes
in class AbstractNodeWrapper
nodeTest
- a test that the returned attributes must satisfyprotected AxisIterator iterateChildren(NodeTest nodeTest)
AbstractNodeWrapper
iterateChildren
in class AbstractNodeWrapper
nodeTest
- a test that the returned attributes must satisfyprotected AxisIterator iterateSiblings(NodeTest nodeTest, boolean forwards)
AbstractNodeWrapper
iterateSiblings
in class AbstractNodeWrapper
nodeTest
- a test that the returned siblings must satisfyforwards
- true for following siblings, false for preceding siblingsprotected AxisIterator iterateDescendants(NodeTest nodeTest, boolean includeSelf)
AbstractNodeWrapper
iterateDescendants
in class AbstractNodeWrapper
nodeTest
- a test that the returned descendants must satisfyincludeSelf
- true if this node is to be included in the resultpublic java.lang.String getAttributeValue(java.lang.String uri, java.lang.String local)
getAttributeValue
in interface NodeInfo
getAttributeValue
in class AbstractNodeWrapper
uri
- the namespace URI of the attribute name. Supply the empty string for an attribute
that is in no namespacelocal
- the local part of the attribute name.public NodeInfo getRoot()
getRoot
in interface NodeInfo
getRoot
in class AbstractNodeWrapper
public boolean hasChildNodes()
hasChildNodes
in interface NodeInfo
hasChildNodes
in class AbstractNodeWrapper
public void generateId(FastStringBuffer buffer)
generateId
in interface NodeInfo
buffer
- a buffer to contain a string that uniquely identifies this node, across all
documentspublic void copy(Receiver out, int copyOptions, Location locationId) throws XPathException
copy
in interface NodeInfo
copy
in class AbstractNodeWrapper
out
- the Receiver to which the node should be copied. It is the caller's
responsibility to ensure that this Receiver is open before the method is called
(or that it is self-opening), and that it is closed after use.copyOptions
- a selection of the options defined in CopyOptions
locationId
- If non-null, identifies the location of the instruction
that requested this copy. If zero, indicates that the location information
is not availableXPathException
- if any downstream error occurspublic NamespaceBinding[] getDeclaredNamespaces(NamespaceBinding[] buffer)
getDeclaredNamespaces
in interface NodeInfo
getDeclaredNamespaces
in class AbstractNodeWrapper
buffer
- If this is non-null, and the result array fits in this buffer, then the result
may overwrite the contents of this array, to avoid the cost of allocating a new array on the heap.For a node other than an element, the method returns null.
public boolean isId()
isId
in interface NodeInfo
isId
in class AbstractNodeWrapper
public DOMNodeWrapper getNextSibling()
SteppingNode
getNextSibling
in interface SteppingNode<DOMNodeWrapper>
public DOMNodeWrapper getFirstChild()
SteppingNode
getFirstChild
in interface SteppingNode<DOMNodeWrapper>
public DOMNodeWrapper getPreviousSibling()
SteppingNode
getPreviousSibling
in interface SteppingNode<DOMNodeWrapper>
public DOMNodeWrapper getSuccessorElement(DOMNodeWrapper anchor, java.lang.String uri, java.lang.String local)
SteppingNode
getSuccessorElement
in interface SteppingNode<DOMNodeWrapper>
anchor
- the root of the tree within which navigation is confineduri
- the required namespace URI, or null if any namespace is acceptablelocal
- the required local name, or null if any local name is acceptableCopyright (c) 2004-2018 Saxonica Limited. All rights reserved.