net.sf.saxon.tree

Class NodeImpl

public abstract class NodeImpl extends Object implements MutableNodeInfo, FingerprintedNode, SiblingCountingNode, SourceLocator

A node in the "linked" tree representing any kind of node except a namespace node. Specific node kinds are represented by concrete subclasses.

Author: Michael H. Kay

Field Summary
protected intindex
static char[]NODE_LETTER
Chararacteristic letters to identify each type of node, indexed using the node type values.
protected ParentNodeImplparent
Method Summary
voidaddAttribute(int nameCode, int typeCode, CharSequence value, int properties)
Add an attribute to this element node.
voidaddNamespace(int nscode, boolean inherit)
Valueatomize()
Get the typed value.
intcompareOrder(NodeInfo other)
Determine the relative position of this node and another node, in document order.
voiddelete()
Delete this node (that is, detach it from its parent)
booleanequals(Object other)
The equals() method compares nodes for identity.
voidgenerateId(FastStringBuffer buffer)
Get a character string that uniquely identifies this node within this document (The calling code will prepend a document identifier)
StringgetAttributeValue(int fingerprint)
Get the value of a given attribute of this node
StringgetBaseURI()
Get the base URI for the node.
intgetColumnNumber()
Get the column number of the node.
ConfigurationgetConfiguration()
Get the configuration
int[]getDeclaredNamespaces(int[] buffer)
Get all namespace undeclarations and undeclarations defined on this element.
StringgetDisplayName()
Get the display name of this node.
longgetDocumentNumber()
Get the document number of the document containing this node.
DocumentInfogetDocumentRoot()
Get the root (document) node
intgetFingerprint()
Get the fingerprint of the node.
NodeInfogetFirstChild()
Get first child - default implementation used for leaf nodes
NodeInfogetLastChild()
Get last child - default implementation used for leaf nodes
intgetLineNumber()
Get the line number of the node within its source document entity
StringgetLocalPart()
Get the local name of this node.
intgetNameCode()
Get the nameCode of the node.
NamePoolgetNamePool()
Get the NamePool
NodeImplgetNextInDocument(NodeImpl anchor)
Get the next node in document order
NodeInfogetNextSibling()
Get next sibling node
NodeInfogetParent()
Find the parent node of this node.
DocumentImplgetPhysicalRoot()
Get the physical root of the tree.
StringgetPrefix()
Get the prefix part of the name of this node.
NodeImplgetPreviousInDocument()
Get the previous node in document order
NodeInfogetPreviousSibling()
Get the previous sibling of the node
StringgetPublicId()
Get the public identifier of the document entity containing this node.
NodeInfogetRoot()
Get the root node
protected longgetSequenceNumber()
Get the node sequence number (in document order).
intgetSiblingPosition()
Get the index position of this node among its siblings (starting from 0)
CharSequencegetStringValueCS()
Get the value of the item as a CharSequence.
StringgetSystemId()
Get the system ID for the node.
intgetTypeAnnotation()
Get the type annotation of this node, if any
SequenceIteratorgetTypedValue()
Get the typed value of this node.
StringgetURI()
Get the URI part of the name of this node.
booleanhasChildNodes()
Determine whether the node has any children.
voidinsertChildren(NodeInfo[] source, boolean atStart, boolean inherit)
Insert copies of a sequence of nodes as children of this node.
voidinsertSiblings(NodeInfo[] source, boolean before, boolean inherit)
Insert copies of a sequence of nodes as siblings of this node.
booleanisDeleted()
Test whether this MutableNodeInfo object represents a node that has been deleted.
booleanisId()
Determine whether this node has the is-id property
booleanisIdref()
Determine whether this node has the is-idref property
booleanisNilled()
Determine whether the node has the is-nilled property
booleanisSameNodeInfo(NodeInfo other)
Determine whether this is the same node as another node
AxisIteratoriterateAxis(byte axisNumber)
Return an enumeration over the nodes reached by the given axis from this node
AxisIteratoriterateAxis(byte axisNumber, NodeTest nodeTest)
Return an enumeration over the nodes reached by the given axis from this node
BuildernewBuilder()
Get a Builder suitable for building nodes that can be attached to this document.
voidremoveAttribute(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.

voidremoveTypeAnnotation()
Remove type information from this node (and its ancestors, recursively).
voidrename(int newNameCode)
Rename this node
voidreplace(NodeInfo[] replacement, boolean inherit)
Replace this node with a given sequence of nodes.
voidsetSystemId(String uri)
Set the system ID of this node.
voidsetTypeAnnotation(int typeCode)
Set the type annotation on a node.

Field Detail

index

protected int index

NODE_LETTER

public static final char[] NODE_LETTER
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()

parent

protected ParentNodeImpl parent

Method Detail

addAttribute

public void addAttribute(int nameCode, int typeCode, CharSequence value, int properties)
Add an attribute to this element 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.

addNamespace

public void addNamespace(int nscode, boolean inherit)

atomize

public Value atomize()
Get the typed value. The result of this method will always be consistent with the method 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.

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

compareOrder

public final 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

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())

delete

public void delete()
Delete this node (that is, detach it from its parent)

equals

public boolean equals(Object other)
The equals() method compares nodes for identity. It is defined to give the same result as isSameNodeInfo().

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.

generateId

public void generateId(FastStringBuffer buffer)
Get a character string that uniquely identifies this node within this document (The calling code will prepend a document identifier)

getAttributeValue

public String getAttributeValue(int fingerprint)
Get the value of a given attribute of this node

Parameters: fingerprint The fingerprint of the attribute name

Returns: the attribute value if it exists or null if not

getBaseURI

public String getBaseURI()
Get the base URI for the node. Default implementation for child nodes.

getColumnNumber

public int getColumnNumber()
Get the column number of the node. The default implementation returns -1, meaning unknown

getConfiguration

public Configuration getConfiguration()
Get the configuration

getDeclaredNamespaces

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 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.

getDisplayName

public String getDisplayName()
Get the display name of this node. For elements and attributes this is [prefix:]localname. For unnamed nodes, it is an empty string.

Returns: The display name of this node. For a node with no name, return an empty string.

getDocumentNumber

public long getDocumentNumber()
Get the document number of the document containing this node. For a free-standing orphan node, just return the hashcode.

getDocumentRoot

public DocumentInfo getDocumentRoot()
Get the root (document) node

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.

getFingerprint

public int getFingerprint()
Get the fingerprint of the node. This is used to compare whether two nodes have equivalent names. Return -1 for a node with no name.

getFirstChild

public NodeInfo getFirstChild()
Get first child - default implementation used for leaf nodes

Returns: null

getLastChild

public NodeInfo getLastChild()
Get last child - default implementation used for leaf nodes

Returns: null

getLineNumber

public int getLineNumber()
Get the line number of the node within its source document entity

getLocalPart

public String getLocalPart()
Get the local name of this node.

Returns: The local name of this node. For a node with no name, return "",.

getNameCode

public int getNameCode()
Get the nameCode of the node. This is used to locate the name in the NamePool

getNamePool

public NamePool getNamePool()
Get the NamePool

getNextInDocument

public NodeImpl getNextInDocument(NodeImpl anchor)
Get the next node in document order

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

getNextSibling

public NodeInfo getNextSibling()
Get next sibling node

Returns: The next sibling node of the required type. Returns null if the current node is the last child of its parent.

getParent

public final NodeInfo getParent()
Find the parent node of this node.

Returns: The Node object describing the containing element or root node.

getPhysicalRoot

public DocumentImpl getPhysicalRoot()
Get the physical root of the tree. This may be an imaginary document node: this method should be used only when control information held at the physical root is required

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.

getPrefix

public String getPrefix()
Get the prefix part of the name of this node. This is the name before the ":" if any.

Returns: the prefix part of the name. For an unnamed node, return an empty string.

getPreviousInDocument

public NodeImpl getPreviousInDocument()
Get the previous node in document order

Returns: the previous node in the document, or null if there is no such node

getPreviousSibling

public NodeInfo getPreviousSibling()
Get the previous sibling of the node

Returns: The previous sibling node. Returns null if the current node is the first child of its parent.

getPublicId

public String getPublicId()
Get the public identifier of the document entity containing this node. The default implementation returns null, meaning unknown

getRoot

public NodeInfo getRoot()
Get the root node

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.

getSequenceNumber

protected long getSequenceNumber()
Get the node sequence number (in document order). Sequence numbers are monotonic but not consecutive. In the current implementation, parent nodes (elements and roots) have a zero least-significant word, while namespaces, attributes, text nodes, comments, and PIs have the top word the same as their owner and the bottom half reflecting their relative position. This is the default implementation for child nodes. For nodes added by XQUery Update, the sequence number is -1L

Returns: the sequence number if there is one, or -1L otherwise.

getSiblingPosition

public int getSiblingPosition()
Get the index position of this node among its siblings (starting from 0)

Returns: 0 for the first child, 1 for the second child, etc.

getStringValueCS

public CharSequence getStringValueCS()
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()
Get the system ID for the node. Default implementation for child nodes.

getTypeAnnotation

public int getTypeAnnotation()
Get the type annotation of this node, if any

Returns: the type annotation, as the integer name code of the type name

getTypedValue

public SequenceIterator getTypedValue()
Get the typed value of this node. If there is no type annotation, we return the string value, as an instance of xs:untypedAtomic

getURI

public String getURI()
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.

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.

hasChildNodes

public boolean hasChildNodes()
Determine whether the node has any children.

Returns: true if the node has any children, false if the node has no children.

insertChildren

public void insertChildren(NodeInfo[] source, boolean atStart, boolean inherit)
Insert copies of a sequence of nodes as children of this node.

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

insertSiblings

public void insertSiblings(NodeInfo[] source, boolean before, boolean inherit)
Insert copies of a sequence of nodes as siblings of this node.

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

isDeleted

public boolean isDeleted()
Test whether this MutableNodeInfo object represents a node that has been deleted. Generally, such a node is unusable, and any attempt to use it will result in an exception being thrown

Returns: true if this node has been deleted

isId

public boolean isId()
Determine whether this node has the is-id property

Returns: true if the node is an ID

isIdref

public boolean isIdref()
Determine whether this node has the is-idref property

Returns: true if the node is an IDREF or IDREFS element or attribute

isNilled

public boolean isNilled()
Determine whether the node has the is-nilled property

Returns: true if the node has the is-nilled property

isSameNodeInfo

public boolean isSameNodeInfo(NodeInfo other)
Determine whether this is the same node as another node

Returns: true if this Node object and the supplied Node object represent the same node in the tree.

iterateAxis

public AxisIterator iterateAxis(byte axisNumber)
Return an enumeration over the nodes reached by the given axis from this node

Parameters: axisNumber The axis to be iterated over

Returns: an AxisIterator that scans the nodes reached by the axis in turn.

iterateAxis

public AxisIterator iterateAxis(byte axisNumber, NodeTest nodeTest)
Return an enumeration over the nodes reached by the given axis from this node

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.

newBuilder

public Builder newBuilder()
Get a Builder suitable for building nodes that can be attached to this document.

Returns: a new Builder that constructs nodes using the same object model implementation as this one, suitable for attachment to this tree

removeAttribute

public 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.

Parameters: attribute the attribute node to be removed

removeTypeAnnotation

public void removeTypeAnnotation()
Remove type information from this node (and its ancestors, recursively). This method implements the upd:removeType() primitive defined in the XQuery Update specification

rename

public void rename(int newNameCode)
Rename this node

Parameters: newNameCode the NamePool code of the new name

replace

public void replace(NodeInfo[] replacement, boolean inherit)
Replace this node with a given sequence of nodes. This node is effectively deleted, and the replacement nodes are attached to the parent of this node in its place.

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.

setSystemId

public void setSystemId(String uri)
Set the system ID of this node. This method is provided so that a NodeInfo implements the javax.xml.transform.Source interface, allowing a node to be used directly as the Source of a transformation

setTypeAnnotation

public void setTypeAnnotation(int typeCode)
Set the type annotation on a node. This must only be called when the caller has verified (by validation) that the node is a valid instance of the specified type. The call is ignored if the node is not an element or attribute node.

Parameters: typeCode the type annotation (possibly including high bits set to indicate the isID, isIDREF, and isNilled properties)