| java.lang.Object
 net.sf.saxon.tinytree.TinyNodeImpl
All known Subclasses: net.sf.saxon.tinytree.TinyTextImpl, net.sf.saxon.tinytree.TinyParentNodeImpl, net.sf.saxon.tinytree.TinyCommentImpl, net.sf.saxon.tinytree.TinyProcInstImpl, net.sf.saxon.tinytree.TinyAttributeImpl,
| TinyNodeImpl | | abstract public class TinyNodeImpl implements NodeInfo,FingerprintedNode,SourceLocator(Code) | | A node in a TinyTree representing an XML element, character content, or attribute.
This is the top-level class in the implementation class hierarchy; it essentially contains
all those methods that can be defined using other primitive methods, without direct access
to data.
author:
Michael H. Kay |
| Method Summary | |
| public Value | atomize()
Get the typed value. | | final public int | compareOrder(NodeInfo other)
Determine the relative position of this node and another node, in document order.
The other node will always be in the same document.
Parameters:
other - The other node, whose position is to be compared with this node -1 if this node precedes the other node, +1 if it follows the othernode, or 0 if they are the same node. | | public String | generateId()
| | public String | getAttributeValue(int fingerprint)
| | public String | getBaseURI()
Get the base URI for the node. | | public int | getColumnNumber()
Get the column number of the node. | | public Configuration | getConfiguration()
| | public int[] | getDeclaredNamespaces(int[] buffer)
Get all namespace undeclarations and undeclarations defined on this element.
Parameters:
buffer - If this is non-null, and the result array fits in this buffer, then the resultmay overwrite the contents of this array, to avoid the cost of allocating a new array on the heap. | | public String | getDisplayName()
Get the display name of this node (a lexical QName). | | final public int | getDocumentNumber()
| | public DocumentInfo | getDocumentRoot()
| | public int | getFingerprint()
| | public int | getLineNumber()
| | public String | getLocalPart()
Get the local part of the name of this node. | | public int | getNameCode()
| | public NamePool | getNamePool()
| | public NodeInfo | getParent()
Find the parent node of this node. | | final static int | getParentNodeNr(TinyTree tree, int nodeNr)
Static method to get the parent of a given node, without instantiating the node as an object. | | public String | getPrefix()
Get the prefix part of the name of this node. | | public String | getPublicId()
Get the public identifier of the document entity containing this node. | | public NodeInfo | getRoot()
| | protected long | getSequenceNumber()
Get the node sequence number (in document order). | | public CharSequence | getStringValueCS()
Get the value of the item as a CharSequence. | | public String | getSystemId()
Get the system ID for the entity containing the node. | | public int | getTypeAnnotation()
| | public SequenceIterator | getTypedValue()
Get the typed value of this node. | | public String | getURI()
Get the URI part of the name of this node. | | public boolean | hasChildNodes()
Determine whether the node has any children. | | public boolean | isSameNodeInfo(NodeInfo other)
| | public AxisIterator | iterateAxis(byte axisNumber)
Return an iterator over all the nodes reached by the given axis from this node
Parameters:
axisNumber - Identifies the required axis, eg. | | public AxisIterator | iterateAxis(byte axisNumber, NodeTest nodeTest)
Return an iterator over the nodes reached by the given axis from this node
Parameters:
axisNumber - Identifies the required axis, eg. | | public void | sendNamespaceDeclarations(Receiver out, boolean includeAncestors)
Output all namespace nodes associated with this element. | | protected void | setParentNode(TinyNodeImpl parent)
Set the parent of this node. | | public void | setSystemId(String uri)
Set the system id of this node. |
| NODE_LETTER | | final public static char[] NODE_LETTER(Code) | | Chararacteristic letters to identify each type of node, indexed using the node type
values. These are used as the initial letter of the result of generate-id()
|
| nodeNr | | protected int nodeNr(Code) | | |
| atomize | | public Value atomize() throws XPathException(Code) | | Get the typed value. The result of this method will always be consistent with the method
net.sf.saxon.om.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.
the typed value. If requireSingleton is set to true, the result will always be anAtomicValue. In other cases it may be a Value representing a sequence whose items are atomicvalues.
since:
8.5 |
| compareOrder | | final public int compareOrder(NodeInfo other)(Code) | | Determine the relative position of this node and another node, in document order.
The other node will always be in the same document.
Parameters:
other - The other node, whose position is to be compared with this node -1 if this node precedes the other node, +1 if it follows the othernode, or 0 if they are the same node. (In this case, isSameNode() will alwaysreturn true, and the two nodes will produce the same result for generateId()) |
| generateId | | public String generateId()(Code) | | Get a character string that uniquely identifies this node
a string. |
| getAttributeValue | | public String getAttributeValue(int fingerprint)(Code) | | Get the value of a given attribute of this node
Parameters:
fingerprint - The fingerprint of the attribute name the attribute value if it exists or null if not |
| getBaseURI | | public String getBaseURI()(Code) | | Get the base URI for the node. Default implementation for child nodes gets
the base URI of the parent node.
|
| getColumnNumber | | public int getColumnNumber()(Code) | | Get the column number of the node.
The default implementation returns -1, meaning unknown
|
| getDeclaredNamespaces | | public int[] getDeclaredNamespaces(int[] buffer)(Code) | | Get all namespace undeclarations and undeclarations defined on this element.
Parameters:
buffer - If this is non-null, and the result array fits in this buffer, then the resultmay overwrite the contents of this array, to avoid the cost of allocating a new array on the heap. An array of integers representing the namespace declarations and undeclarations present onthis element. For a node other than an element, return null. Otherwise, the returned array is asequence of namespace codes, whose meaning may be interpreted by reference to the name pool. Thetop half word of each namespace code represents the prefix, the bottom half represents the URI.If the bottom half is zero, then this is a namespace undeclaration rather than a declaration.The XML namespace is never included in the list. If the supplied array is larger than required,then the first unused entry will be set to -1.For a node other than an element, the method returns null. |
| getDisplayName | | public String getDisplayName()(Code) | | Get the display name of this node (a lexical QName). For elements and attributes this is [prefix:]localname.
The original prefix is retained. For unnamed nodes, the result is an empty string.
The display name of this node.For a node with no name, return an empty string. |
| getDocumentNumber | | final public int getDocumentNumber()(Code) | | Get the document number of the document containing this node
(Needed when the document isn't a real node, for sorting free-standing elements)
|
| getDocumentRoot | | public DocumentInfo getDocumentRoot()(Code) | | Get the root (document) node
the DocumentInfo representing the containing document |
| getFingerprint | | public int getFingerprint()(Code) | | Get the fingerprint of the node, used for matching names
|
| getLineNumber | | public int getLineNumber()(Code) | | Get the line number of the node within its source document entity
|
| getLocalPart | | public String getLocalPart()(Code) | | Get the local part of the name of this node.
The local name of this node.For a node with no name, return "". |
| getNameCode | | public int getNameCode()(Code) | | Get the name code of the node, used for matching names
|
| getNamePool | | public NamePool getNamePool()(Code) | | Get the NamePool for the tree containing this node
the NamePool |
| getParent | | public NodeInfo getParent()(Code) | | Find the parent node of this node.
The Node object describing the containing element or root node. |
| getParentNodeNr | | final static int getParentNodeNr(TinyTree tree, int nodeNr)(Code) | | Static method to get the parent of a given node, without instantiating the node as an object.
The starting node is any node other than an attribute or namespace node.
Parameters:
tree - the tree containing the starting node
Parameters:
nodeNr - the node number of the starting node within the tree the node number of the parent node, or -1 if there is no parent. |
| getPrefix | | public String getPrefix()(Code) | | Get the prefix part of the name of this node. This is the name before the ":" if any.
the prefix part of the name. For an unnamed node, return "". |
| getPublicId | | public String getPublicId()(Code) | | Get the public identifier of the document entity containing this node.
The default implementation returns null, meaning unknown
|
| getRoot | | public NodeInfo getRoot()(Code) | | Get the root node of the tree (not necessarily a document node)
the NodeInfo representing the root of this tree |
| getSequenceNumber | | protected long getSequenceNumber()(Code) | | Get the node sequence number (in document order). Sequence numbers are monotonic but not
consecutive. The sequence number must be unique within the document (not, as in
previous releases, within the whole document collection).
For document nodes, elements, text nodes, comment nodes, and PIs, the sequence number
is a long with the sequential node number in the top half and zero in the bottom half.
The bottom half is used only for attributes and namespace.
|
| getStringValueCS | | public CharSequence getStringValueCS()(Code) | | Get the value of the item as a CharSequence. This is in some cases more efficient than
the version of the method that returns a String.
|
| getSystemId | | public String getSystemId()(Code) | | Get the system ID for the entity containing the node.
|
| getTypeAnnotation | | public int getTypeAnnotation()(Code) | | Get the type annotation of this node, if any
|
| getTypedValue | | public SequenceIterator getTypedValue() throws XPathException(Code) | | Get the typed value of this node.
If there is no type annotation, we return the string value, as an instance
of xdt:untypedAtomic
|
| getURI | | public String getURI()(Code) | | Get the URI part of the name of this node. This is the URI corresponding to the
prefix, or the URI of the default namespace if appropriate.
The URI of the namespace of this node. For an unnamed node, or foran element or attribute in the default namespace, return an empty string. |
| hasChildNodes | | public boolean hasChildNodes()(Code) | | Determine whether the node has any children.
true if this node has any attributes,false otherwise. |
| isSameNodeInfo | | public boolean isSameNodeInfo(NodeInfo other)(Code) | | Determine whether this is the same node as another node
true if this Node object and the supplied Node object represent thesame node in the tree. |
| iterateAxis | | public AxisIterator iterateAxis(byte axisNumber)(Code) | | Return an iterator over all the nodes reached by the given axis from this node
Parameters:
axisNumber - Identifies the required axis, eg. Axis.CHILD or Axis.PARENT a AxisIteratorImpl that scans the nodes reached by the axis in turn. |
| iterateAxis | | public AxisIterator iterateAxis(byte axisNumber, NodeTest nodeTest)(Code) | | Return an iterator over the nodes reached by the given axis from this node
Parameters:
axisNumber - Identifies the required axis, eg. Axis.CHILD or Axis.PARENT
Parameters:
nodeTest - A pattern to be matched by the returned nodes. a AxisIteratorImpl that scans the nodes reached by the axis in turn. |
| sendNamespaceDeclarations | | public void sendNamespaceDeclarations(Receiver out, boolean includeAncestors) throws XPathException(Code) | | Output all namespace nodes associated with this element. Does nothing if
the node is not an element.
Parameters:
out - The relevant outputter
Parameters:
includeAncestors - True if namespaces declared on ancestor elements must |
| setParentNode | | protected void setParentNode(TinyNodeImpl parent)(Code) | | Set the parent of this node. Providing this information is useful,
if it is known, because otherwise getParent() has to search backwards
through the document.
|
| setSystemId | | public void setSystemId(String uri)(Code) | | Set the system id of this node.
This method is present to ensure that
the class implements the javax.xml.transform.Source interface, so a node can
be used as the source of a transformation.
|
|
|