public class XOMNodeWrapper extends AbstractNodeWrapper implements VirtualNode, SiblingCountingNode, SteppingNode
| Modifier and Type | Field and Description |
|---|---|
protected XOMDocumentWrapper |
docWrapper |
protected int |
index |
protected Node |
node |
protected short |
nodeKind |
ALL_NAMESPACES, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES| Modifier | Constructor and Description |
|---|---|
protected |
XOMNodeWrapper(Node node,
XOMNodeWrapper parent,
int index)
This constructor is protected: nodes should be created using the wrap
factory method on the XOMDocumentWrapper class
|
| Modifier and Type | Method and Description |
|---|---|
AtomicSequence |
atomize()
Get the typed value.
|
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 |
delete()
Delete this node (that is, detach it from its parent)
|
boolean |
equals(Object other)
The equals() method compares nodes for identity.
|
void |
generateId(FastStringBuffer buffer)
Get a character string that uniquely identifies this node.
|
String |
getAttributeValue(String uri,
String local)
Get the string value of a given attribute of this node
|
String |
getBaseURI()
Get the Base URI for the node, that is, the URI used for resolving a
relative URI contained in the node.
|
int |
getColumnNumber()
Get column number
|
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 node, if it is a document node.
|
int |
getFingerprint()
Get fingerprint.
|
SteppingNode |
getFirstChild()
Get the first child of this node
|
int |
getLineNumber()
Get line number
|
String |
getLocalPart()
Get the local part of the name of this node.
|
int |
getNameCode()
Get name code.
|
NamePool |
getNamePool()
Get the name pool for this node
|
SteppingNode |
getNextSibling()
Get the next sibling of this node
|
int |
getNodeKind()
Return the type of node.
|
SteppingNode |
getParent()
Get the NodeInfo object representing the parent of this node
|
String |
getPrefix()
Get the prefix of the name of the node.
|
SteppingNode |
getPreviousSibling()
Get the previous sibling of this node
|
NodeInfo |
getRoot()
Get the root node of the tree containing this node
|
SchemaType |
getSchemaType()
Get the type annotation of this node, if any.
|
int |
getSiblingPosition()
Get the index position of this node among its siblings (starting from 0)
|
String |
getStringValue()
Return the string value of the node.
|
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.
|
String |
getSystemId()
Get the System ID for the node.
|
int |
getTypeAnnotation()
Get the type annotation
|
Object |
getUnderlyingNode()
Get the underlying XOM 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.
|
int |
hashCode()
The hashCode() method obeys the contract for hashCode(): that is, if two objects are equal
(represent the same node) then they must have the same hashCode()
|
boolean |
isId()
Determine whether this node has the is-id property
|
boolean |
isIdref()
Determine whether this node has the is-idref property
|
boolean |
isNilled()
Determine whether the node has the is-nilled property
|
boolean |
isSameNodeInfo(NodeInfo other)
Determine whether this is the same node as another node.
|
SequenceIterator |
iterate()
To implement
Sequence, this method returns a singleton iterator
that delivers this item in the form of a sequence |
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 XOMNodeWrapper |
makeWrapper(Node node,
XOMDocumentWrapper docWrapper)
Factory method to wrap a XOM node with a wrapper that implements the
Saxon NodeInfo interface.
|
protected XOMNodeWrapper |
makeWrapper(Node node,
XOMDocumentWrapper docWrapper,
XOMNodeWrapper parent,
int index)
Factory method to wrap a XOM node with a wrapper that implements the
Saxon NodeInfo interface.
|
void |
setSystemId(String uri)
Set the system ID.
|
getRealNode, head, iterateAxis, iterateAxisclone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitgetRealNodeiterateAxis, iterateAxisprotected Node node
protected short nodeKind
protected XOMDocumentWrapper docWrapper
protected int index
protected XOMNodeWrapper(Node node, XOMNodeWrapper parent, int index)
node - The XOM node to be wrappedparent - The XOMNodeWrapper that wraps the parent of this nodeindex - Position of this node among its siblingsprotected final XOMNodeWrapper makeWrapper(Node node, XOMDocumentWrapper docWrapper)
node - The XOM nodedocWrapper - The wrapper for the Document containing this nodeprotected final XOMNodeWrapper makeWrapper(Node node, XOMDocumentWrapper docWrapper, XOMNodeWrapper parent, int index)
node - The XOM nodedocWrapper - The wrapper for the Document containing this nodeparent - The wrapper for the parent of the XOM nodeindex - The position of this node relative to its siblingspublic SequenceIterator iterate()
Sequence, this method returns a singleton iterator
that delivers this item in the form of a sequenceiterate in interface Sequenceiterate in class AbstractNodeWrapperpublic Configuration getConfiguration()
getConfiguration in interface NodeInfogetConfiguration in class AbstractNodeWrapperpublic Object getUnderlyingNode()
getUnderlyingNode in interface VirtualNodepublic NamePool getNamePool()
getNamePool in interface NodeInfogetNamePool in class AbstractNodeWrapperpublic int getNodeKind()
getNodeKind in interface NodeInfoTypepublic AtomicSequence atomize()
atomize in interface NodeInfoatomize in class AbstractNodeWrapperpublic int getTypeAnnotation()
getTypeAnnotation in interface NodeInfogetTypeAnnotation in class AbstractNodeWrapperFor elements and attributes, this is the type annotation as defined in XDM. For document nodes, it should be one of XS_UNTYPED if the document has not been validated, or XS_ANY_TYPE if validation has taken place (that is, if any node in the document has an annotation other than Untyped or UntypedAtomic).
public SchemaType getSchemaType()
Types derived from a DTD are not reflected in the result of this method.
getSchemaType in interface NodeInfogetSchemaType in class AbstractNodeWrapperpublic boolean isSameNodeInfo(NodeInfo other)
isSameNodeInfo in interface NodeInfoisSameNodeInfo in class AbstractNodeWrapperother - the node to be compared with this nodepublic boolean equals(Object other)
equals in interface NodeInfoequals in class AbstractNodeWrapperother - the node to be compared with this nodepublic int hashCode()
hashCode in interface NodeInfohashCode in class AbstractNodeWrapperpublic 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 String getBaseURI()
getBaseURI in interface NodeInfogetBaseURI in class AbstractNodeWrapperpublic int getLineNumber()
getLineNumber in interface NodeInfogetLineNumber in class AbstractNodeWrapperpublic int getColumnNumber()
getColumnNumber in interface NodeInfogetColumnNumber in class AbstractNodeWrapperpublic 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 String getStringValue()
getStringValue in interface ItemgetStringValue in interface NodeInfogetStringValue in class AbstractNodeWrapperItem.getStringValueCS()public CharSequence getStringValueCS()
getStringValueCS in interface ItemItem.getStringValue()public int getNameCode()
getNameCode in interface NodeInfogetNameCode in class AbstractNodeWrapperallocatepublic int getFingerprint()
getFingerprint in interface NodeInfogetFingerprint in class AbstractNodeWrapperpublic String getLocalPart()
getLocalPart in interface NodeInfopublic String getPrefix()
public String getURI()
public String getDisplayName()
getDisplayName in interface NodeInfogetDisplayName in class AbstractNodeWrapperpublic SteppingNode getParent()
getParent in interface NodeInfogetParent in interface SteppingNodepublic SteppingNode getNextSibling()
SteppingNodegetNextSibling in interface SteppingNodepublic SteppingNode getPreviousSibling()
SteppingNodegetPreviousSibling in interface SteppingNodepublic SteppingNode 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 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(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 boolean isIdref()
isIdref in interface NodeInfoisIdref in class AbstractNodeWrapperpublic boolean isNilled()
isNilled in interface NodeInfoisNilled in class AbstractNodeWrapperpublic void delete()
throws XPathException
XPathExceptionCopyright (c) 2004-2013 Saxonica Limited. All rights reserved.