public class XOMNodeWrapper extends AbstractNodeWrapper implements SiblingCountingNode, SteppingNode<XOMNodeWrapper>
Modifier and Type | Field and Description |
---|---|
protected XOMDocumentWrapper |
docWrapper |
protected int |
index |
protected Node |
node |
protected short |
nodeKind |
treeInfo
ALL_NAMESPACES, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES
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,
Location locationId)
Copy this node to a given outputter (deep copy)
|
boolean |
equals(java.lang.Object other)
The equals() method compares nodes for identity.
|
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
|
java.lang.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.
|
java.lang.String |
getDisplayName()
Get the display name of this node.
|
XOMNodeWrapper |
getFirstChild()
Get the first child of this node
|
int |
getLineNumber()
Get line number
|
java.lang.String |
getLocalPart()
Get the local part of the name of this node.
|
NamePool |
getNamePool()
Get the name pool for this node
|
XOMNodeWrapper |
getNextSibling()
Get the next sibling of this node
|
int |
getNodeKind()
Return the type of node.
|
XOMNodeWrapper |
getParent()
Get the NodeInfo object representing the parent of this node
|
java.lang.String |
getPrefix()
Get the prefix of the name of the node.
|
XOMNodeWrapper |
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)
|
java.lang.String |
getStringValue()
Return the string value of the node.
|
java.lang.CharSequence |
getStringValueCS()
Get the value of the item as a CharSequence.
|
XOMNodeWrapper |
getSuccessorElement(XOMNodeWrapper 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.
|
java.lang.String |
getSystemId()
Get the System ID for the node.
|
java.lang.Object |
getUnderlyingNode()
Get the underlying XOM 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.
|
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 |
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 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.
|
getFingerprint, getPublicId, getRealNode, getTreeInfo, hasFingerprint, head, isStreamed, iterateAxis, iterateAxis, saveLocation, setSystemId
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
getFingerprint, getPublicId, getTreeInfo, hasFingerprint, isStreamed, iterateAxis, iterateAxis
saveLocation
protected Node node
protected short nodeKind
protected XOMDocumentWrapper docWrapper
protected int index
protected 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 Sequence
iterate
in class AbstractNodeWrapper
public Configuration getConfiguration()
getConfiguration
in interface NodeInfo
getConfiguration
in class AbstractNodeWrapper
public java.lang.Object getUnderlyingNode()
getUnderlyingNode
in interface VirtualNode
public NamePool getNamePool()
getNamePool
in class AbstractNodeWrapper
public int getNodeKind()
getNodeKind
in interface NodeInfo
Type
public AtomicSequence atomize()
atomize
in interface Item
atomize
in interface NodeInfo
atomize
in class AbstractNodeWrapper
public SchemaType getSchemaType()
Types derived from a DTD are not reflected in the result of this method.
getSchemaType
in interface NodeInfo
getSchemaType
in class AbstractNodeWrapper
public boolean isSameNodeInfo(NodeInfo other)
isSameNodeInfo
in interface NodeInfo
isSameNodeInfo
in class AbstractNodeWrapper
other
- the node to be compared with this nodepublic boolean equals(java.lang.Object other)
equals
in interface NodeInfo
equals
in class AbstractNodeWrapper
other
- the node to be compared with this nodepublic int hashCode()
hashCode
in interface NodeInfo
hashCode
in class AbstractNodeWrapper
public java.lang.String getSystemId()
getSystemId
in interface javax.xml.transform.Source
getSystemId
in interface javax.xml.transform.SourceLocator
getSystemId
in interface Location
getSystemId
in interface NodeInfo
getSystemId
in interface org.xml.sax.Locator
getSystemId
in class AbstractNodeWrapper
public java.lang.String getBaseURI()
getBaseURI
in interface NodeInfo
getBaseURI
in class AbstractNodeWrapper
public int getLineNumber()
getLineNumber
in interface javax.xml.transform.SourceLocator
getLineNumber
in interface Location
getLineNumber
in interface NodeInfo
getLineNumber
in interface org.xml.sax.Locator
getLineNumber
in class AbstractNodeWrapper
public int getColumnNumber()
getColumnNumber
in interface javax.xml.transform.SourceLocator
getColumnNumber
in interface Location
getColumnNumber
in interface NodeInfo
getColumnNumber
in interface org.xml.sax.Locator
getColumnNumber
in class AbstractNodeWrapper
public 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.String getStringValue()
getStringValue
in interface Item
getStringValue
in interface NodeInfo
getStringValue
in class AbstractNodeWrapper
Item.getStringValueCS()
public java.lang.CharSequence getStringValueCS()
getStringValueCS
in interface Item
Item.getStringValue()
public java.lang.String getLocalPart()
getLocalPart
in interface NodeInfo
public java.lang.String getPrefix()
public java.lang.String getURI()
public java.lang.String getDisplayName()
getDisplayName
in interface NodeInfo
getDisplayName
in class AbstractNodeWrapper
public XOMNodeWrapper getParent()
getParent
in interface NodeInfo
getParent
in interface SteppingNode<XOMNodeWrapper>
public XOMNodeWrapper getNextSibling()
SteppingNode
getNextSibling
in interface SteppingNode<XOMNodeWrapper>
public XOMNodeWrapper getPreviousSibling()
SteppingNode
getPreviousSibling
in interface SteppingNode<XOMNodeWrapper>
public XOMNodeWrapper getFirstChild()
SteppingNode
getFirstChild
in interface SteppingNode<XOMNodeWrapper>
public XOMNodeWrapper getSuccessorElement(XOMNodeWrapper anchor, java.lang.String uri, java.lang.String local)
SteppingNode
getSuccessorElement
in interface SteppingNode<XOMNodeWrapper>
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 acceptablepublic int getSiblingPosition()
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 boolean isIdref()
isIdref
in interface NodeInfo
isIdref
in class AbstractNodeWrapper
public boolean isNilled()
isNilled
in interface NodeInfo
isNilled
in class AbstractNodeWrapper
Copyright (c) 2004-2018 Saxonica Limited. All rights reserved.