|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.saxonica.stream.om.FleetingNode
public class FleetingNode
A FleetingNode is a node that exists transiently in the course of streaming processing. The node has a parent (unless it is the root), and the case of an element node it also has attributes and namespaces; but it has no descendants or following or preceding nodes.
| Field Summary | |
|---|---|
protected FleetingDocumentNode |
root
|
| Fields inherited from interface net.sf.saxon.om.NodeInfo |
|---|
ALL_NAMESPACES, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES |
| Fields inherited from interface net.sf.saxon.om.ValueRepresentation |
|---|
EMPTY_VALUE_ARRAY |
| Constructor Summary | |
|---|---|
FleetingNode()
|
|
| 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. |
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. |
CharSequence |
getStringValueCS()
Get the string value of the item as a CharSequence. |
String |
getSystemId()
Get the System ID for the node. |
int |
getTypeAnnotation()
Get the type annotation of this node, if any. |
SequenceIterator |
getTypedValue()
Get the typed value of the item. |
String |
getURI()
Get the URI part of the name of this node. |
boolean |
hasChildNodes()
Determine whether the node has any children. |
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 |
void |
setNodeKind(int nodeKind)
|
void |
setNodeName(NodeName name)
|
void |
setParent(FleetingNode parent)
|
void |
setStringValue(CharSequence stringValue)
|
void |
setSystemId(String systemId)
Set the system identifier for this Source. |
void |
setTypeAnnotation(SchemaType typeAnnotation)
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface net.sf.saxon.om.NodeInfo |
|---|
equals, hashCode |
| Field Detail |
|---|
protected FleetingDocumentNode root
| Constructor Detail |
|---|
public FleetingNode()
| Method Detail |
|---|
public void setParent(FleetingNode parent)
public void setNodeName(NodeName name)
public void setNodeKind(int nodeKind)
public void setStringValue(CharSequence stringValue)
public void setTypeAnnotation(SchemaType typeAnnotation)
public 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 NodeInfoTypepublic boolean isSameNodeInfo(NodeInfo other)
isSameNodeInfo in interface NodeInfoother - the node to be compared with this node
public String getSystemId()
getSystemId in interface SourcegetSystemId in interface NodeInfopublic String getBaseURI()
getBaseURI in interface NodeInfopublic int getLineNumber()
getLineNumber in interface NodeInfopublic int getColumnNumber()
getColumnNumber in interface NodeInfopublic int compareOrder(NodeInfo other)
compareOrder in interface NodeInfoother - The other node, whose position is to be compared with this
node
public String getStringValue()
getStringValue in interface Item<NodeInfo>getStringValue in interface NodeInfogetStringValue in interface ValueRepresentation<NodeInfo>Item.getStringValueCS()public int getNameCode()
NamePool.FP_MASK, you get a
fingerprint: two nodes with the same fingerprint have the same local name
and namespace URI.
getNameCode in interface NodeInfoallocate,
getFingerprintpublic int getFingerprint()
getFingerprint in interface NodeInfopublic String getLocalPart()
getLocalPart in interface NodeInfopublic String getURI()
getURI in interface NodeInfopublic String getDisplayName()
getDisplayName in interface NodeInfopublic String getPrefix()
getPrefix in interface NodeInfopublic Configuration getConfiguration()
getConfiguration in interface NodeInfopublic NamePool getNamePool()
getNamePool in interface NodeInfopublic 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.
getTypeAnnotation in interface NodeInfoFor 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 NodeInfo
public 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.
atomize in interface NodeInfoXPathException - if the node has no typed value, for example if
it is an element node with element-only contentpublic NodeInfo getParent()
getParent in interface NodeInfopublic AxisIterator iterateAxis(byte axisNumber)
iterateAxis in interface NodeInfoaxisNumber - 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
public AxisIterator iterateAxis(byte axisNumber,
NodeTest nodeTest)
iterateAxis in interface NodeInfoaxisNumber - an integer identifying the axis; one of the constants
defined in class AxisnodeTest - 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.Axispublic String getAttributeValue(int fingerprint)
getAttributeValue in interface NodeInfofingerprint - The fingerprint of the attribute name
public String getAttributeValue(String uri,
String local)
getAttributeValue in interface NodeInfouri - 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 NodeInfopublic DocumentInfo getDocumentRoot()
getDocumentRoot in interface NodeInfopublic boolean hasChildNodes()
iterateAxis(Axis.CHILD).next() != null
hasChildNodes in interface NodeInfopublic void generateId(FastStringBuffer buffer)
generateId in interface NodeInfobuffer - 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 long getDocumentNumber()
getDocumentNumber in interface NodeInfo
public void copy(Receiver out,
int copyOptions,
int locationId)
throws XPathException
copy in interface NodeInfoout - 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 information
for the original node is to be copied; in this case the Receiver must be
XPathException - 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 NodeInfobuffer - 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 NodeInfopublic boolean isIdref()
isIdref in interface NodeInfopublic boolean isNilled()
isNilled in interface NodeInfopublic void setSystemId(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 SourcesystemId - The system identifier as a URL string.public 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<NodeInfo>getStringValueCS in interface ValueRepresentation<NodeInfo>getStringValue()
public SequenceIterator getTypedValue()
throws XPathException
getTypedValue in interface Item<NodeInfo>XPathException - where no typed value is available, for example in the case of
an element with complex content
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||