net.sf.saxon.tree
public abstract class NodeImpl extends Object implements MutableNodeInfo, FingerprintedNode, SiblingCountingNode, SourceLocator
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 | |
---|---|
void | addAttribute(int nameCode, int typeCode, CharSequence value, int properties)
Add an attribute to this element node.
|
void | addNamespace(int nscode, boolean inherit) |
Value | atomize()
Get the typed value. |
int | compareOrder(NodeInfo other)
Determine the relative position of this node and another node, in document order.
|
void | delete()
Delete this node (that is, detach it from its parent) |
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. |
long | 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.
|
DocumentImpl | getPhysicalRoot()
Get the physical root of the tree. |
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). |
int | getSiblingPosition()
Get the index position of this node among its siblings (starting from 0) |
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.
|
void | insertChildren(NodeInfo[] source, boolean atStart, boolean inherit)
Insert copies of a sequence of nodes as children of this node.
|
void | insertSiblings(NodeInfo[] source, boolean before, boolean inherit)
Insert copies of a sequence of nodes as siblings of this node.
|
boolean | isDeleted()
Test whether this MutableNodeInfo object represents a node that has been deleted.
|
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 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
|
Builder | newBuilder()
Get a Builder suitable for building nodes that can be attached to this document. |
void | removeAttribute(NodeInfo attribute)
Remove an attribute from this element node
If this node is not an element, or if the specified node is not an attribute of this element, this method takes no action. The attribute object itself becomes unusable; any attempt to use this attribute object, or any other object representing the same node, is likely to result in an exception. |
void | removeTypeAnnotation()
Remove type information from this node (and its ancestors, recursively).
|
void | rename(int newNameCode)
Rename this node |
void | replace(NodeInfo[] replacement, boolean inherit)
Replace this node with a given sequence of nodes. |
void | setSystemId(String uri)
Set the system ID of this node. |
void | setTypeAnnotation(int typeCode)
Set the type annotation on a node. |
If this node is not an element, or if the supplied node is not an attribute, the method takes no action. If the element already has an attribute with this name, the method throws an exception.
This method does not perform any namespace fixup. It is the caller's responsibility to ensure that any namespace prefix used in the name of the attribute (or in its value if it has a namespace-sensitive type) is declared on this element.
Parameters: nameCode the name of the new attribute typeCode the type annotation of the new attribute value the string value of the new attribute properties properties including IS_ID and IS_IDREF properties
Throws: IllegalStateException if the element already has an attribute with the given name.
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. If this node is part of a tree that does not have a document node as its root, returns null.
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 document node, which may be imaginary. In the case of a node that has been detached from the tree by means of a delete() operation, this method returns null.
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 logical root of the tree. For this tree implementation the root will either be a document node or an element node.
Returns: the sequence number if there is one, or -1L otherwise.
Returns: 0 for the first child, 1 for the second child, etc.
Returns: the type annotation, as the integer name code of the type name
Returns: The URI of the namespace of this node. For the null 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.
This method takes no action unless the target node is a document node or element node. It also takes no action in respect of any supplied nodes that are not elements, text nodes, comments, or processing instructions.
The supplied nodes will be copied to form the new children. Adjacent text nodes will be merged, and zero-length text nodes removed.
Parameters: source the nodes to be inserted atStart true if the new nodes are to be inserted before existing children; false if they are inherit true if the inserted nodes are to inherit the namespaces that are in-scope for their new parent; false if such namespaces should be undeclared on the children
This method takes no action unless the target node is an element, text node, comment, or processing instruction, and one that has a parent node. It also takes no action in respect of any supplied nodes that are not elements, text nodes, comments, or processing instructions.
The supplied nodes must use the same data model implementation as the tree into which they will be inserted.
Parameters: source the nodes to be inserted before true if the new nodes are to be inserted before the target node; false if they are inherit
Returns: true if this node has been deleted
Returns: true if the node is an ID
Returns: true if the node is an IDREF or IDREFS element or attribute
Returns: true if the node has the is-nilled property
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.
Returns: a new Builder that constructs nodes using the same object model implementation as this one, suitable for attachment to this tree
If this node is not an element, or if the specified node is not an attribute of this element, this method takes no action.
The attribute object itself becomes unusable; any attempt to use this attribute object, or any other object representing the same node, is likely to result in an exception.
Parameters: attribute the attribute node to be removed
Parameters: newNameCode the NamePool code of the new name
Parameters: replacement the replacement nodes inherit true if the replacement nodes are to inherit the namespaces of their new parent; false if such namespaces are to be undeclared
Throws: IllegalArgumentException if any of the replacement nodes is of the wrong kind. When replacing a child node, the replacement nodes must all be elements, text, comment, or PI nodes; when replacing an attribute, the replacement nodes must all be attributes.
Parameters: typeCode the type annotation (possibly including high bits set to indicate the isID, isIDREF, and isNilled properties)