public class DOMNodeWrapper extends AbstractNodeWrapper implements SiblingCountingNode, SteppingNode
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 DocumentWrapper object. (This still relies on the user not allocating two DocumentWrappers around the same DOM).
| Modifier and Type | Field and Description |
|---|---|
protected DocumentWrapper |
docWrapper |
protected int |
index |
protected Node |
node |
protected short |
nodeKind |
protected int |
span |
ALL_NAMESPACES, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES| Modifier | Constructor and Description |
|---|---|
protected |
DOMNodeWrapper(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,
int locationId)
Copy this node to a given outputter (deep copy)
|
void |
generateId(FastStringBuffer buffer)
Get a character string that uniquely identifies this node.
|
static String |
getAttributeURI(Attr attr) |
String |
getAttributeValue(String uri,
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.
|
String |
getDisplayName()
Get the display name of this node.
|
long |
getDocumentNumber()
Get the document number of the document containing this node.
|
DocumentInfo |
getDocumentRoot()
Get the root (document) node
|
static String |
getElementURI(Element element) |
DOMNodeWrapper |
getFirstChild()
Get the first child of this node
|
static String |
getLocalName(Node node)
Get the local name of a DOM element or attribute node.
|
String |
getLocalPart()
Get the local part of the name of this node.
|
int |
getNameCode()
Get name code.
|
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
|
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).
|
CharSequence |
getStringValueCS()
Get the value of the item as a CharSequence.
|
SteppingNode |
getSuccessorElement(SteppingNode anchor,
String uri,
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.
|
Object |
getUnderlyingNode()
Get the underlying DOM node, to implement the VirtualNode interface
|
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<NodeInfo> |
iterateAttributes(NodeTest nodeTest)
Return an iterator over the attributes of this element node.
|
protected AxisIterator<NodeInfo> |
iterateChildren(NodeTest nodeTest)
Return an iterator over the children of this node.
|
protected AxisIterator<NodeInfo> |
iterateDescendants(NodeTest nodeTest,
boolean includeSelf)
Return an iterator over the descendants of this node.
|
protected AxisIterator<NodeInfo> |
iterateSiblings(NodeTest nodeTest,
boolean forwards)
Return an iterator over the siblings of this node.
|
protected DOMNodeWrapper |
makeWrapper(Node node,
DocumentWrapper docWrapper)
Factory method to wrap a DOM node with a wrapper that implements the Saxon
NodeInfo interface.
|
protected DOMNodeWrapper |
makeWrapper(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, getRealNode, getSchemaType, getStringValue, getSystemId, getTypeAnnotation, hashCode, head, isIdref, isNilled, iterate, iterateAxis, iterateAxis, setSystemIdclone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitatomize, equals, getBaseURI, getColumnNumber, getConfiguration, getFingerprint, getLineNumber, getNamePool, getSchemaType, getStringValue, getSystemId, getTypeAnnotation, hashCode, isIdref, isNilled, iterateAxis, iterateAxissetSystemIdprotected Node node
protected short nodeKind
protected DocumentWrapper docWrapper
protected int index
protected int span
protected DOMNodeWrapper(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 DOMNodeWrapper makeWrapper(Node node, DocumentWrapper docWrapper)
node - The DOM nodedocWrapper - The wrapper for the containing Document nodeNullPointerException - if the node or the document wrapper are nullprotected DOMNodeWrapper makeWrapper(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 Object getUnderlyingNode()
getUnderlyingNode in interface VirtualNodepublic int getNodeKind()
getNodeKind in interface NodeInfoTypepublic boolean isSameNodeInfo(NodeInfo other)
isSameNodeInfo in interface NodeInfoisSameNodeInfo in class AbstractNodeWrapperother - the node to be compared with this nodepublic int compareOrder(NodeInfo other)
compareOrder in interface NodeInfoother - The other node, whose position is to be compared with this nodepublic int comparePosition(NodeInfo other)
comparePosition in interface NodeInfocomparePosition in class AbstractNodeWrapperother - 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.UnsupportedOperationException - if either node is an attribute or namespacepublic CharSequence getStringValueCS()
getStringValueCS in interface ItemItem.getStringValue()public int getNameCode()
getNameCode in interface NodeInfogetNameCode in class AbstractNodeWrapperallocatepublic String getLocalPart()
getLocalPart in interface NodeInfopublic static String getLocalName(Node node)
node - the DOM element or attribute nodepublic String getURI()
public String getPrefix()
public String getDisplayName()
getDisplayName in interface NodeInfogetDisplayName in class AbstractNodeWrapperpublic DOMNodeWrapper getParent()
getParent in interface NodeInfogetParent in interface SteppingNodepublic 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 SiblingCountingNodeprotected AxisIterator<NodeInfo> iterateAttributes(NodeTest nodeTest)
AbstractNodeWrapperiterateAttributes in class AbstractNodeWrappernodeTest - a test that the returned attributes must satisfyprotected AxisIterator<NodeInfo> iterateChildren(NodeTest nodeTest)
AbstractNodeWrapperiterateChildren in class AbstractNodeWrappernodeTest - a test that the returned attributes must satisfyprotected AxisIterator<NodeInfo> iterateSiblings(NodeTest nodeTest, boolean forwards)
AbstractNodeWrapperiterateSiblings in class AbstractNodeWrappernodeTest - a test that the returned siblings must satisfyforwards - true for following siblings, false for preceding siblingsprotected AxisIterator<NodeInfo> iterateDescendants(NodeTest nodeTest, boolean includeSelf)
AbstractNodeWrapperiterateDescendants in class AbstractNodeWrappernodeTest - a test that the returned descendants must satisfyincludeSelf - true if this node is to be included in the resultpublic String getAttributeValue(String uri, String local)
getAttributeValue in interface NodeInfogetAttributeValue in class AbstractNodeWrapperuri - 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 NodeInfogetRoot in class AbstractNodeWrapperpublic DocumentInfo getDocumentRoot()
getDocumentRoot in interface NodeInfopublic boolean hasChildNodes()
hasChildNodes in interface NodeInfohasChildNodes in class AbstractNodeWrapperpublic void generateId(FastStringBuffer buffer)
generateId in interface NodeInfobuffer - a buffer to contain a string that uniquely identifies this node, across all
documentspublic long getDocumentNumber()
getDocumentNumber in interface NodeInfogetDocumentNumber in class AbstractNodeWrapperpublic void copy(Receiver out, int copyOptions, int locationId) throws XPathException
copy in interface NodeInfocopy in class AbstractNodeWrapperout - 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 CopyOptionslocationId - If non-zero, identifies the location of the instruction
that requested this copy. If zero, indicates that the location informationXPathException - if any downstream error occurspublic NamespaceBinding[] getDeclaredNamespaces(NamespaceBinding[] buffer)
getDeclaredNamespaces in interface NodeInfogetDeclaredNamespaces in class AbstractNodeWrapperbuffer - 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 NodeInfoisId in class AbstractNodeWrapperpublic DOMNodeWrapper getNextSibling()
SteppingNodegetNextSibling in interface SteppingNodepublic DOMNodeWrapper getFirstChild()
SteppingNodegetFirstChild in interface SteppingNodepublic DOMNodeWrapper getPreviousSibling()
SteppingNodegetPreviousSibling in interface SteppingNodepublic SteppingNode getSuccessorElement(SteppingNode anchor, String uri, String local)
SteppingNodegetSuccessorElement in interface SteppingNodeanchor - 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-2013 Saxonica Limited. All rights reserved.