|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface NodeInfo
The NodeInfo interface represents a node in Saxon's implementation of the XPath 2.0 data model.
Note that several NodeInfo objects may represent the same node. To test node identity, the
method 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. The only subclass of NodeInfo that applications should normally use is DocumentInfo
,
which represents a document node. 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.
Field Summary | |
---|---|
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. |
Fields inherited from interface net.sf.saxon.om.ValueRepresentation |
---|
EMPTY_VALUE_ARRAY |
Method Summary | |
---|---|
Value |
atomize()
Get the typed value. |
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 Receiver. |
boolean |
equals(Object other)
The equals() method compares nodes for identity. |
void |
generateId(FastStringBuffer buffer)
Construct a character string that uniquely identifies this node. |
String |
getAttributeValue(int fingerprint)
Get the string 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 |
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 used to build the tree containing this node. |
NamespaceBinding[] |
getDeclaredNamespaces(NamespaceBinding[] buffer)
Get all namespace declarations and undeclarations defined on this element. |
String |
getDisplayName()
Get the display name of this node, in the form of a lexical QName. |
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. |
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 NamePool that holds the namecode for this node |
int |
getNodeKind()
Get the kind of node. |
NodeInfo |
getParent()
Get the NodeInfo object representing the parent of this node |
String |
getPrefix()
Get the prefix of the name of 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. |
String |
getStringValue()
Return the string value of the node as defined in the XPath data model. |
String |
getSystemId()
Get the System ID for the node. |
int |
getTypeAnnotation()
Get the type annotation of this node, if any. |
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. |
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 |
Methods inherited from interface javax.xml.transform.Source |
---|
setSystemId |
Methods inherited from interface net.sf.saxon.om.Item |
---|
getStringValueCS, getTypedValue |
Field Detail |
---|
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
Method Detail |
---|
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)
Note that two different NodeInfo instances can represent the same conceptual node. Therefore the "==" operator should not be used to test node identity. The equals() method should give the same result as isSameNodeInfo(), but since this rule was introduced late it might not apply to all implementations.
Note: a.isSameNodeInfo(b) if and only if generateId(a)==generateId(b).
This method has the same semantics as isSameNode() in DOM Level 3, but works on Saxon NodeInfo objects rather than DOM Node objects.
other
- the node to be compared with this node
boolean equals(Object other)
equals
in class Object
other
- the node to be compared with this node
int hashCode()
hashCode
in class Object
String getSystemId()
getSystemId
in interface Source
String getBaseURI()
int getLineNumber()
The granularity of line numbering is normally the element level: for other nodes such as text nodes and attributes, the line number of the parent element will normally be returned.
In the case of a tree constructed by taking input from a SAX parser, the line number will reflect the SAX rules: that is, the line number of an element is the line number where the start tag ends. This may be a little confusing where elements have many attributes spread over multiple lines, or where single attributes (as can easily happen with XSLT 2.0 stylesheets) occupy several lines.
In the case of a tree constructed by a stylesheet or query, the line number may reflect the line in the stylesheet or query that caused the node to be constructed.
The line number can be read from within an XPath expression using the Saxon extension function saxon:line-number()
int getColumnNumber()
The granularity of column numbering is normally the element level: for other nodes such as text nodes and attributes, the line number of the parent element will normally be returned.
In the case of a tree constructed by taking input from a SAX parser, the column number will reflect the SAX rules: that is, the column number of an element is the column number where the start tag ends. This may be a little confusing where elements have many attributes spread over multiple lines, or where single attributes (as can easily happen with XSLT 2.0 stylesheets) occupy several lines.
In the case of a tree constructed by a stylesheet or query, the column number may reflect the line in the stylesheet or query that caused the node to be constructed.
The column number can be read from within an XPath expression using the Saxon extension function saxon:column-number()
int compareOrder(NodeInfo other)
The other node must always be in the same tree; the effect of calling this method when the two nodes are in different trees is undefined. To obtain a global ordering of nodes, the application should first compare the result of getDocumentNumber(), and only if the document number is the same should compareOrder() be called.
other
- The other node, whose position is to be compared with this
node
String getStringValue()
The interpretation of this depends on the type of node. For an element it is the accumulated character content of the element, including descendant elements.
This method returns the string value as if the node were untyped. Unlike the string value accessor in the XPath 2.0 data model, it does not report an error if the element has a complex type, instead it returns the concatenation of the descendant text nodes as it would if the element were untyped.
getStringValue
in interface Item<NodeInfo>
getStringValue
in interface ValueRepresentation<NodeInfo>
Item.getStringValueCS()
int getNameCode()
NamePool.FP_MASK
, you get a
fingerprint: two nodes with the same fingerprint have the same local name
and namespace URI.
allocate
,
getFingerprint
int getFingerprint()
String getLocalPart()
String getURI()
String getDisplayName()
String getPrefix()
Configuration getConfiguration()
NamePool getNamePool()
int getTypeAnnotation()
Configuration.getSchemaType(int)
.
The bit IS_DTD_TYPE (1<<30) will be set in the case of an attribute node if the type annotation is one of ID, IDREF, or IDREFS and this is derived from DTD rather than schema validation.
For 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).
SchemaType getSchemaType()
Types derived from a DTD are not reflected in the result of this method.
Value atomize() throws XPathException
Item.getTypedValue()
. However, this method is often more convenient and may be
more efficient, especially in the common case where the value is expected to be a singleton.
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 Axis
UnsupportedOperationException
- if the namespace axis is
requested and this axis is not supported for this implementation.Axis
AxisIterator iterateAxis(byte axisNumber, NodeTest nodeTest)
axisNumber
- an integer identifying the axis; one of the constants
defined in class Axis
nodeTest
- A condition to be satisfied by the returned nodes; nodes
that do not satisfy this condition are not included in the result
UnsupportedOperationException
- if the namespace axis is
requested and this axis is not supported for this implementation.Axis
String getAttributeValue(int fingerprint)
fingerprint
- The fingerprint of the attribute name
String getAttributeValue(String uri, 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()
DocumentInfo getDocumentRoot()
boolean hasChildNodes()
Note: the result is equivalent to
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
long getDocumentNumber()
void copy(Receiver out, int copyOptions, int locationId) throws XPathException
This method is primarily for internal use. It should not be considered a stable part of the Saxon API.
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-zero, identifies the location of the instruction
that requested this copy. If zero, indicates that the location information
XPathException
- if any downstream error occursNamespaceBinding[] getDeclaredNamespaces(NamespaceBinding[] buffer)
This method is intended primarily for internal use. User applications needing
information about the namespace context of a node should use 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()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |