net.sf.saxon.tree
public abstract class NodeImpl extends Object implements NodeInfo, FingerprintedNode, SourceLocator
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.
Field Summary | |
---|---|
protected int | index |
static char[] | NODE_LETTER
Chararacteristic letters to identify each type of node, indexed using the node type
values. |
protected ParentNodeImpl | parent |
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.
|
boolean | equals(Object other)
The equals() method compares nodes for identity. |
void | generateId(FastStringBuffer buffer)
Get a character string that uniquely identifies this node within this document
(The calling code will prepend a document identifier) |
String | getAttributeValue(int fingerprint)
Get the value of a given attribute of this node
|
String | getBaseURI()
Get the base URI for the node. |
int | getColumnNumber()
Get the column number of the node.
|
Configuration | getConfiguration()
Get the configuration |
int[] | getDeclaredNamespaces(int[] buffer)
Get all namespace undeclarations and undeclarations defined on this element.
|
String | getDisplayName()
Get the display name of this node. |
int | getDocumentNumber()
Get the document number of the document containing this node. |
DocumentInfo | getDocumentRoot()
Get the root (document) node
|
int | getFingerprint()
Get the fingerprint of the node. |
NodeInfo | getFirstChild()
Get first child - default implementation used for leaf nodes
|
NodeInfo | getLastChild()
Get last child - default implementation used for leaf nodes
|
int | getLineNumber()
Get the line number of the node within its source document entity |
String | getLocalPart()
Get the local name of this node.
|
int | getNameCode()
Get the nameCode of the node. |
NamePool | getNamePool()
Get the NamePool |
NodeImpl | getNextInDocument(NodeImpl anchor)
Get the next node in document order
|
NodeInfo | getNextSibling()
Get next sibling node
|
NodeInfo | getParent()
Find the parent node of this node.
|
String | getPrefix()
Get the prefix part of the name of this node. |
NodeImpl | getPreviousInDocument()
Get the previous node in document order
|
NodeInfo | getPreviousSibling()
Get the previous sibling of the node
|
String | getPublicId()
Get the public identifier of the document entity containing this node.
|
NodeInfo | getRoot()
Get the root node
|
protected long | getSequenceNumber()
Get the node sequence number (in document order). |
CharSequence | getStringValueCS()
Get the 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 this node.
|
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 | isSameNodeInfo(NodeInfo other)
Determine whether this is the same node as another node
|
AxisIterator | iterateAxis(byte axisNumber)
Return an enumeration over the nodes reached by the given axis from this node
|
AxisIterator | iterateAxis(byte axisNumber, NodeTest nodeTest)
Return an enumeration over the nodes reached by the given axis from this node
|
void | sendNamespaceDeclarations(Receiver out, boolean includeAncestors)
Output all namespace nodes associated with this element. |
void | setSystemId(String uri)
Set the system ID of this node. |
Returns: the typed value. If requireSingleton is set to true, the result will always be an AtomicValue. In other cases it may be a Value representing a sequence whose items are atomic values.
Since: 8.5
Parameters: other The other node, whose position is to be compared with this node
Returns: -1 if this node precedes the other node, +1 if it follows the other node, or 0 if they are the same node. (In this case, isSameNode() will always return true, and the two nodes will produce the same result for generateId())
Parameters: other the node to be compared with this node
Returns: true if this NodeInfo object and the supplied NodeInfo object represent the same node in the tree.
Since: 8.7 Previously, the effect of the equals() method was not defined. Callers should therefore be aware that third party implementations of the NodeInfo interface may not implement the correct semantics. It is safer to use isSameNodeInfo() for this reason. The equals() method has been defined because it is useful in contexts such as a Java Set or HashMap.
Parameters: fingerprint The fingerprint of the attribute name
Returns: the attribute value if it exists or null if not
Parameters: 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.
Returns: An array of integers representing the namespace declarations and undeclarations present on
this element. For a node other than an element, return null. Otherwise, the returned array is a
sequence of namespace codes, whose meaning may be interpreted by reference to the name pool. The
top 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.
Returns: The display name of this node. For a node with no name, return an empty string.
Returns: the DocumentInfo representing the containing document
Returns: null
Returns: null
Returns: The local name of this node. For a node with no name, return "",.
Parameters: anchor the scan stops when it reaches a node that is not a descendant of the specified anchor node
Returns: the next node in the document, or null if there is no such node
Returns: The next sibling node of the required type. Returns null if the current node is the last child of its parent.
Returns: The Node object describing the containing element or root node.
Returns: the prefix part of the name. For an unnamed node, return an empty string.
Returns: the previous node in the document, or null if there is no such node
Returns: The previous sibling node. Returns null if the current node is the first child of its parent.
Returns: the NodeInfo representing the containing document
Returns: The URI of the namespace of this node. For the default namespace, return an empty string. For an unnamed node, return the empty string.
Returns: true
if the node has any children,
false
if the node has no children.
Since: 8.7 Previously, the effect of the equals() and hashCode() methods was not defined. Callers should therefore be aware that third party implementations of the NodeInfo interface may not implement the correct semantics.
Returns: true if this Node object and the supplied Node object represent the same node in the tree.
Parameters: axisNumber The axis to be iterated over
Returns: an AxisIterator that scans the nodes reached by the axis in turn.
Parameters: axisNumber The axis to be iterated over nodeTest A pattern to be matched by the returned nodes
Returns: an AxisIterator that scans the nodes reached by the axis in turn.
Parameters: out The relevant outputter includeAncestors True if namespaces declared on ancestor elements must