public class DOM4JNodeWrapper extends AbstractNodeWrapper implements SiblingCountingNode, SteppingNode
This is the implementation of the NodeInfo interface used as a wrapper for DOM4J nodes.
| Modifier and Type | Field and Description |
|---|---|
protected DOM4JDocumentWrapper |
docWrapper |
protected int |
index |
protected org.dom4j.Node |
node |
protected short |
nodeKind |
ALL_NAMESPACES, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES| Modifier | Constructor and Description |
|---|---|
protected |
DOM4JNodeWrapper(org.dom4j.Node node,
DOM4JNodeWrapper parent,
int index)
This constructor is protected: nodes should be created using the wrap
factory method on the DocumentWrapper class
|
| Modifier and Type | Method and Description |
|---|---|
int |
compareOrder(NodeInfo other)
Determine the relative position of this node and another node, in document order.
|
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.
|
String |
getAttributeValue(int fingerprint)
Get the value of a given attribute of this node
|
String |
getAttributeValue(String uri,
String local)
Get the string value of a given attribute of this node
|
Configuration |
getConfiguration()
Get the configuration
|
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
|
DOM4JNodeWrapper |
getFirstChild()
Get the first child of this node
|
String |
getLocalPart()
Get the local part of the name of this node.
|
DOM4JNodeWrapper |
getNextSibling()
Get the next sibling of this node
|
int |
getNodeKind()
Return the type of node.
|
DOM4JNodeWrapper |
getParent()
Get the NodeInfo object representing the parent of this node
|
String |
getPrefix()
Get the prefix part of the name of this node.
|
DOM4JNodeWrapper |
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 string 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.
|
String |
getSystemId()
Get the System ID for the node.
|
Object |
getUnderlyingNode()
Get the underlying DOM4J 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 |
isSameNodeInfo(NodeInfo other)
Determine whether this is the same node as another node.
|
protected AxisIterator<NodeInfo> |
iterateAttributes(NodeTest nodeTest)
Return an iteration over the nodes reached by the given axis from this node
// * @param axisNumber the axis to be used
|
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 DOM4JNodeWrapper |
makeWrapper(org.dom4j.Node node,
DOM4JDocumentWrapper docWrapper)
Factory method to wrap a DOM4J node with a wrapper that implements the Saxon
NodeInfo interface.
|
protected DOM4JNodeWrapper |
makeWrapper(org.dom4j.Node node,
DOM4JDocumentWrapper docWrapper,
DOM4JNodeWrapper parent,
int index)
Factory method to wrap a DOM4J node with a wrapper that implements the Saxon
NodeInfo interface.
|
void |
setSystemId(String uri)
Set the system ID.
|
atomize, comparePosition, equals, getBaseURI, getColumnNumber, getFingerprint, getLineNumber, getNameCode, getNamePool, getRealNode, getSchemaType, getStringValue, getTypeAnnotation, hashCode, head, isId, isIdref, isNilled, iterate, iterateAxis, iterateAxisclone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitatomize, comparePosition, equals, getBaseURI, getColumnNumber, getFingerprint, getLineNumber, getNameCode, getNamePool, getSchemaType, getStringValue, getTypeAnnotation, hashCode, isId, isIdref, isNilled, iterateAxis, iterateAxisprotected org.dom4j.Node node
protected short nodeKind
protected DOM4JDocumentWrapper docWrapper
protected int index
protected DOM4JNodeWrapper(org.dom4j.Node node,
DOM4JNodeWrapper parent,
int index)
node - The DOM4J node to be wrappedparent - The NodeWrapper that wraps the parent of this nodeindex - Position of this node among its siblingsprotected DOM4JNodeWrapper makeWrapper(org.dom4j.Node node, DOM4JDocumentWrapper docWrapper)
node - The DOM4J nodedocWrapper - The wrapper for the Document containing this nodeprotected DOM4JNodeWrapper makeWrapper(org.dom4j.Node node, DOM4JDocumentWrapper docWrapper, DOM4JNodeWrapper parent, int index)
node - The DOM4J nodedocWrapper - The wrapper for the Document containing this nodeparent - The wrapper for the parent of the DOM4J nodeindex - The position of this node relative to its siblingspublic Object getUnderlyingNode()
getUnderlyingNode in interface VirtualNodepublic int getNodeKind()
getNodeKind in interface NodeInfoTypepublic String getSystemId()
getSystemId in interface SourcegetSystemId in interface NodeInfogetSystemId in class AbstractNodeWrapperpublic void setSystemId(String uri)
AbstractNodeWrappersetSystemId in interface SourcesetSystemId in class AbstractNodeWrapperuri - the system ID.public int compareOrder(NodeInfo other)
compareOrder in interface NodeInfoother - The other node, whose position is to be compared with this nodepublic CharSequence getStringValueCS()
ItemX.getStringValueCS().toString() returns a string that is equal to
X.getStringValue().
Note that two CharSequence values of different types should not be compared using equals(), and for the same reason they should not be used as a key in a hash table.
If the calling code can handle any CharSequence, this method should
be used. If the caller requires a string, the Item.getStringValue() method is preferred.
getStringValueCS in interface ItemItem.getStringValue()public String getLocalPart()
getLocalPart in interface NodeInfopublic String getPrefix()
public String getURI()
public String getDisplayName()
getDisplayName in interface NodeInfogetDisplayName in class AbstractNodeWrapperpublic DOM4JNodeWrapper getParent()
getParent in interface NodeInfogetParent in interface SteppingNodepublic int getSiblingPosition()
getSiblingPosition in interface SiblingCountingNodeprotected AxisIterator<NodeInfo> iterateAttributes(NodeTest nodeTest)
iterateAttributes in class AbstractNodeWrappernodeTest - A pattern to be matched by the returned nodesprotected 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(int fingerprint)
fingerprint - The fingerprint of the attribute namepublic 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 DOM4JNodeWrapper getNextSibling()
SteppingNodegetNextSibling in interface SteppingNodepublic DOM4JNodeWrapper getPreviousSibling()
SteppingNodegetPreviousSibling in interface SteppingNodepublic DOM4JNodeWrapper getFirstChild()
SteppingNodegetFirstChild 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 acceptablepublic boolean isSameNodeInfo(NodeInfo other)
isSameNodeInfo in interface NodeInfoisSameNodeInfo in class AbstractNodeWrapperother - the node to be compared with this nodepublic Configuration getConfiguration()
AbstractNodeWrappergetConfiguration in interface NodeInfogetConfiguration in class AbstractNodeWrapperpublic 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.
Copyright (c) 2004-2013 Saxonica Limited. All rights reserved.