public interface NodeInfo extends javax.xml.transform.Source, Item, Location
isSameNodeInfo(NodeInfo)
should be used. An exception to this rule applies for
document nodes, where the correspondence between document nodes and DocumentInfo objects is one to
one. NodeInfo objects are never reused: a given NodeInfo object represents the same node for its entire
lifetime.
This is the primary interface for accessing trees in Saxon, and it forms part of the public
Saxon API. Methods that form part of the public API are (since Saxon 8.4)
labelled with a JavaDoc "since" tag: classes and methods that have no such label should not be
regarded as stable interfaces.
The interface represented by this class is at a slightly higher level than the abstraction described
in the W3C data model specification, in that it includes support for the XPath axes, rather than exposing
the lower-level properties (such as "parent" and "children") directly. All navigation within trees,
except for a few convenience methods, is done by following the axes using the iterateAxis(byte)
method.
This allows different implementations of the XPath tree model to implement axis navigation in different ways.
Some implementations may choose to use the helper methods provided in class Navigator
.
Note that the stability of this interface applies to classes that use the interface,
not to classes that implement it. The interface may be extended in future to add new methods.
New implementations of NodeInfo are advised also to implement the methods in interface
ExtendedNodeInfo, which will be moved into this interface at some time in the future.Modifier and Type | Field and Description |
---|---|
static int |
ALL_NAMESPACES
Copy all in-scope namespaces
|
static int |
IS_DTD_TYPE
Bit setting in the returned type annotation indicating a DTD_derived type on an attribute node
|
static int |
IS_NILLED
Bit setting for use alongside a type annotation indicating that the is-nilled property is set
|
static int |
LOCAL_NAMESPACES
Copy namespaces declared (or undeclared) on this element, but not namespaces inherited from a parent element
|
static int |
NO_NAMESPACES
Don't copy any namespace nodes.
|
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 Receiver.
|
boolean |
equals(java.lang.Object other)
The equals() method compares nodes for identity.
|
void |
generateId(FastStringBuffer buffer)
Construct 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()
Convenience method to get the Configuration.
|
NamespaceBinding[] |
getDeclaredNamespaces(NamespaceBinding[] buffer)
Get all namespace declarations and undeclarations defined on this element.
|
java.lang.String |
getDisplayName()
Get the display name of this node, in the form of a lexical QName.
|
int |
getFingerprint()
Get fingerprint.
|
int |
getLineNumber()
Get line number.
|
java.lang.String |
getLocalPart()
Get the local part of the name of this node.
|
int |
getNodeKind()
Get the kind of node.
|
NodeInfo |
getParent()
Get the NodeInfo object representing the parent of this node
|
java.lang.String |
getPrefix()
Get the prefix of the name of the node.
|
java.lang.String |
getPublicId()
Get the Public ID of the entity containing the node.
|
NodeInfo |
getRoot()
Get the root node of the tree containing this node
|
SchemaType |
getSchemaType()
Get the type annotation of this node, if any.
|
java.lang.String |
getStringValue()
Return the string value of the node as defined in the XPath data model.
|
java.lang.String |
getSystemId()
Get the System ID for the node.
|
TreeInfo |
getTreeInfo()
Get information about the tree to which this NodeInfo belongs
|
java.lang.String |
getURI()
Get the URI part of the name of this node.
|
boolean |
hasChildNodes()
Determine whether the node has any children.
|
boolean |
hasFingerprint()
Ask whether this NodeInfo implementation holds a fingerprint identifying the name of the
node in the NamePool.
|
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()
Ask whether this node has the is-id property
|
boolean |
isIdref()
Ask whether this node has the is-idref property
|
boolean |
isNilled()
Ask whether the node has the is-nilled property
|
boolean |
isSameNodeInfo(NodeInfo other)
Determine whether this is the same node as another node.
|
boolean |
isStreamed()
Ask whether this is a node in a streamed document
|
AxisIterator |
iterateAxis(byte axisNumber)
Return an iteration over all the nodes reached by the given axis from this node
|
AxisIterator |
iterateAxis(byte axisNumber,
NodeTest nodeTest)
Return an iteration over all the nodes reached by the given axis from this node
that match a given NodeTest
|
getStringValueCS, head
saveLocation
static final int IS_DTD_TYPE
static final int IS_NILLED
static final int NO_NAMESPACES
static final int LOCAL_NAMESPACES
static final int ALL_NAMESPACES
TreeInfo getTreeInfo()
Configuration getConfiguration()
int getNodeKind()
Type.ELEMENT
or Type.ATTRIBUTE
. There are seven kinds of node: documents, elements, attributes,
text, comments, processing-instructions, and namespaces.Type
boolean isSameNodeInfo(NodeInfo other)
other
- the node to be compared with this nodeboolean equals(java.lang.Object other)
equals
in class java.lang.Object
other
- the node to be compared with this nodeint hashCode()
hashCode
in class java.lang.Object
java.lang.String getSystemId()
getSystemId
in interface Location
getSystemId
in interface org.xml.sax.Locator
getSystemId
in interface javax.xml.transform.Source
getSystemId
in interface javax.xml.transform.SourceLocator
java.lang.String getPublicId()
Locator
or SourceLocator
, and many implementations return null.getPublicId
in interface Location
getPublicId
in interface org.xml.sax.Locator
getPublicId
in interface javax.xml.transform.SourceLocator
java.lang.String getBaseURI()
int getLineNumber()
getLineNumber
in interface Location
getLineNumber
in interface org.xml.sax.Locator
getLineNumber
in interface javax.xml.transform.SourceLocator
int getColumnNumber()
getColumnNumber
in interface Location
getColumnNumber
in interface org.xml.sax.Locator
getColumnNumber
in interface javax.xml.transform.SourceLocator
int compareOrder(NodeInfo other)
other
- The other node, whose position is to be compared with this
nodeint comparePosition(NodeInfo other)
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 namespacejava.lang.String getStringValue()
getStringValue
in interface Item
Item.getStringValueCS()
boolean hasFingerprint()
getFingerprint()
method must
return the fingerprint of the node. If the answer is false, then the getFingerprint()
method should throw an UnsupportedOperationException
. In the case of unnamed nodes
such as text nodes, the result can be either true (in which case getFingerprint() should
return -1) or false (in which case getFingerprint may throw an exception).FingerprintedNode
as a marker interface.int getFingerprint()
java.lang.UnsupportedOperationException
- if this kind of node does not hold
namepool fingerprints (specifically, if hasFingerprint()
returns false).java.lang.String getLocalPart()
java.lang.String getURI()
java.lang.String getDisplayName()
java.lang.String getPrefix()
SchemaType getSchemaType()
Types derived from a DTD are not reflected in the result of this method.
AtomicSequence atomize() throws XPathException
atomize
in interface Item
XPathException
- if the node has no typed value, for example if
it is an element node with element-only contentNodeInfo getParent()
AxisIterator iterateAxis(byte axisNumber)
axisNumber
- an integer identifying the axis; one of the constants
defined in class AxisInfo
java.lang.UnsupportedOperationException
- if the namespace axis is
requested and this axis is not supported for this implementation.AxisInfo
AxisIterator iterateAxis(byte axisNumber, NodeTest nodeTest)
axisNumber
- an integer identifying the axis; one of the constants
defined in class AxisInfo
nodeTest
- A condition to be satisfied by the returned nodes; nodes
that do not satisfy this condition are not included in the resultjava.lang.UnsupportedOperationException
- if the namespace axis is
requested and this axis is not supported for this implementation.AxisInfo
java.lang.String getAttributeValue(java.lang.String uri, java.lang.String local)
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.NodeInfo getRoot()
boolean hasChildNodes()
iterateAxis(Axis.CHILD).next() != null
void generateId(FastStringBuffer buffer)
buffer
- a buffer which will be updated to hold a string
that uniquely identifies this node, across all documents.Changed in Saxon 8.7 to generate the ID value in a client-supplied buffer
void copy(Receiver out, int copyOptions, Location locationId) throws XPathException
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 occursNamespaceBinding[] getDeclaredNamespaces(NamespaceBinding[] buffer)
iterateAxis(Axis.NAMESPACE)
.
(However, not all implementations support the namespace axis, whereas all implementations are
required to support this method.)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.
boolean isId()
boolean isIdref()
boolean isNilled()
boolean isStreamed()
Copyright (c) 2004-2018 Saxonica Limited. All rights reserved.