public class FleetingNode extends java.lang.Object implements NodeInfo
Modifier and Type | Field and Description |
---|---|
protected FleetingDocumentNode |
root |
ALL_NAMESPACES, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES
Constructor and Description |
---|
FleetingNode() |
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.
|
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()
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.
|
int |
getDepth()
Get the depth of this node in the tree.
|
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.
|
NamePool |
getNamePool()
Get the NamePool that holds the namecode for this node
|
int |
getNodeKind()
Get the kind of node.
|
int |
getNodeNumber()
Get the serial number of this node within the containing document
|
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.CharSequence |
getStringValueCS()
Get the string value of the item as a CharSequence.
|
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.
|
NodeInfo |
head()
To implement
Sequence , this method returns the item itself |
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.
|
boolean |
isStreamed()
Ask whether this is a node in a streamed document
|
SequenceIterator |
iterate()
To implement
Sequence , this method returns a singleton iterator
that delivers this item in the form of a sequence |
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
|
Location |
saveLocation()
Get an immutable copy of this Location object.
|
void |
setNodeKind(int nodeKind) |
void |
setNodeName(NodeName name) |
void |
setParent(FleetingNode parent) |
void |
setStringValue(java.lang.CharSequence stringValue) |
void |
setSystemId(java.lang.String systemId)
Set the system identifier for this Source.
|
void |
setTypeAnnotation(SchemaType typeAnnotation) |
protected FleetingDocumentNode root
public SequenceIterator iterate()
Sequence
, this method returns a singleton iterator
that delivers this item in the form of a sequencepublic TreeInfo getTreeInfo()
getTreeInfo
in interface NodeInfo
public int getDepth()
public int getNodeNumber()
public void setParent(FleetingNode parent)
public void setNodeName(NodeName name)
public void setNodeKind(int nodeKind)
public void setStringValue(java.lang.CharSequence stringValue)
public void setTypeAnnotation(SchemaType typeAnnotation)
public final int getNodeKind()
Type.ELEMENT
or Type.ATTRIBUTE
. There are seven kinds of node: documents, elements, attributes,
text, comments, processing-instructions, and namespaces.getNodeKind
in interface NodeInfo
Type
public final boolean isSameNodeInfo(NodeInfo other)
isSameNodeInfo
in interface NodeInfo
other
- the node to be compared with this nodepublic 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
public java.lang.String getPublicId()
getPublicId
in interface javax.xml.transform.SourceLocator
getPublicId
in interface Location
getPublicId
in interface NodeInfo
getPublicId
in interface org.xml.sax.Locator
public java.lang.String getBaseURI()
getBaseURI
in interface NodeInfo
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
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
public Location saveLocation()
saveLocation
in interface Location
public final int compareOrder(NodeInfo other)
compareOrder
in interface NodeInfo
other
- The other node, whose position is to be compared with this
nodepublic final int comparePosition(NodeInfo other)
comparePosition
in interface NodeInfo
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 final java.lang.String getStringValue()
getStringValue
in interface Item
getStringValue
in interface NodeInfo
Item.getStringValueCS()
public 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).hasFingerprint
in interface NodeInfo
FingerprintedNode
as a marker interface.public final int getFingerprint()
getFingerprint
in interface NodeInfo
public final java.lang.String getLocalPart()
getLocalPart
in interface NodeInfo
public final java.lang.String getURI()
public final java.lang.String getDisplayName()
getDisplayName
in interface NodeInfo
public final java.lang.String getPrefix()
public Configuration getConfiguration()
getConfiguration
in interface NodeInfo
public NamePool getNamePool()
public final SchemaType getSchemaType()
Types derived from a DTD are not reflected in the result of this method.
getSchemaType
in interface NodeInfo
public AtomicSequence atomize() throws XPathException
atomize
in interface Item
atomize
in interface NodeInfo
XPathException
- if the node has no typed value, for example if
it is an element node with element-only contentpublic final NodeInfo getParent()
public final AxisIterator iterateAxis(byte axisNumber)
iterateAxis
in interface NodeInfo
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
public AxisIterator iterateAxis(byte axisNumber, NodeTest nodeTest)
iterateAxis
in interface NodeInfo
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
public java.lang.String getAttributeValue(java.lang.String uri, java.lang.String local)
getAttributeValue
in interface NodeInfo
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()
public boolean hasChildNodes()
iterateAxis(Axis.CHILD).next() != null
hasChildNodes
in interface NodeInfo
public void generateId(FastStringBuffer buffer)
generateId
in interface NodeInfo
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
public void copy(Receiver out, int copyOptions, Location locationId) throws XPathException
copy
in interface NodeInfo
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 informationXPathException
- if any downstream error occurspublic NamespaceBinding[] getDeclaredNamespaces(NamespaceBinding[] buffer)
iterateAxis(Axis.NAMESPACE)
.
(However, not all implementations support the namespace axis, whereas all implementations are
required to support this method.)getDeclaredNamespaces
in interface NodeInfo
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()
public boolean isIdref()
public boolean isNilled()
public boolean isStreamed()
isStreamed
in interface NodeInfo
public void setSystemId(java.lang.String systemId)
The system identifier is optional if the source does not get its data from a URL, but it may still be useful to provide one. The application can use a system identifier, for example, to resolve relative URIs and to include in error messages and warnings.
setSystemId
in interface javax.xml.transform.Source
systemId
- The system identifier as a URL string.public java.lang.CharSequence getStringValueCS()
X.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 getStringValue()
method is preferred.getStringValueCS
in interface Item
getStringValue()
Copyright (c) 2004-2018 Saxonica Limited. All rights reserved.