net.sf.saxon.tinytree

Class TinyNodeImpl

public abstract class TinyNodeImpl extends Object implements NodeInfo, FingerprintedNode, SourceLocator

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

Field Summary
protected intnodeNr
static char[]NODE_LETTER
Chararacteristic letters to identify each type of node, indexed using the node type values.
protected TinyNodeImplparent
protected TinyTreetree
Method Summary
intcompareOrder(NodeInfo other)
Determine the relative position of this node and another node, in document order.
booleanequals(Object other)
The equals() method compares nodes for identity.
voidgenerateId(FastStringBuffer buffer)
Get a character string that uniquely identifies this node
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 (a lexical QName).
longgetDocumentNumber()
Get the document number of the document containing this node (Needed when the document isn't a real node, for sorting free-standing elements)
DocumentInfogetDocumentRoot()
Get the root (document) node
intgetFingerprint()
Get the fingerprint of the node, used for matching names
intgetLineNumber()
Get the line number of the node within its source document entity
StringgetLocalPart()
Get the local part of the name of this node.
intgetNameCode()
Get the name code of the node, used for matching names
NamePoolgetNamePool()
Get the NamePool for the tree containing this node
intgetNodeNumber()
Get the node number of this node within the TinyTree.
NodeInfogetParent()
Find the parent node of this node.
static intgetParentNodeNr(TinyTree tree, int nodeNr)
Static method to get the parent of a given node, without instantiating the node as an object.
StringgetPrefix()
Get the prefix part of the name of this node.
StringgetPublicId()
Get the public identifier of the document entity containing this node.
NodeInfogetRoot()
Get the root node of the tree (not necessarily a document node)
protected longgetSequenceNumber()
Get the node sequence number (in document order).
CharSequencegetStringValueCS()
Get the value of the item as a CharSequence.
StringgetSystemId()
Get the system ID for the entity containing the node.
TinyTreegetTree()
Get the TinyTree object containing this node
intgetTypeAnnotation()
Get the type annotation of this node, if any
StringgetURI()
Get the URI part of the name of this node.
booleanhasChildNodes()
Determine whether the node has any children.
inthashCode()
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()
booleanisAncestorOrSelf(TinyNodeImpl d)
Test if this node is an ancestor-or-self of another
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 iterator over all the nodes reached by the given axis from this node
AxisIteratoriterateAxis(byte axisNumber, NodeTest nodeTest)
Return an iterator over the nodes reached by the given axis from this node
protected voidsetParentNode(TinyNodeImpl parent)
Set the parent of this node.
voidsetSystemId(String uri)
Set the system id of this node.

Field Detail

nodeNr

protected int nodeNr

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 TinyNodeImpl parent

tree

protected TinyTree tree

Method Detail

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

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

Parameters: buffer buffer, which on return will contain a character string that uniquely identifies this node.

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 gets the base URI of the parent node.

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

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

getDocumentNumber

public final long getDocumentNumber()
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()
Get the root (document) node

Returns: the DocumentInfo representing the containing document

getFingerprint

public int getFingerprint()
Get the fingerprint of the node, used for matching names

getLineNumber

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

getLocalPart

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

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

getNameCode

public int getNameCode()
Get the name code of the node, used for matching names

getNamePool

public NamePool getNamePool()
Get the NamePool for the tree containing this node

Returns: the NamePool

getNodeNumber

public int getNodeNumber()
Get the node number of this node within the TinyTree. This method is intended for internal use.

Returns: the internal node number

getParent

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

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

getParentNodeNr

static int getParentNodeNr(TinyTree tree, int nodeNr)
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 nodeNr the node number of the starting node within the tree

Returns: the node number of the parent node, or -1 if there is no parent.

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

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 of the tree (not necessarily a document node)

Returns: the NodeInfo representing the root of this tree

getSequenceNumber

protected long getSequenceNumber()
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.

Returns: the sequence number

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 entity containing the node.

getTree

public TinyTree getTree()
Get the TinyTree object containing this node

Returns: the TinyTree. Note that this may also contain other unrelated trees

getTypeAnnotation

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

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 an unnamed node, or for an element or attribute in the default namespace, return an empty string.

hasChildNodes

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

Returns: true if this node has any attributes, false otherwise.

hashCode

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

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.

isAncestorOrSelf

public boolean isAncestorOrSelf(TinyNodeImpl d)
Test if this node is an ancestor-or-self of another

Parameters: d the putative descendant-or-self node

Returns: true if this node is an ancestor-or-self of d

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

Returns: a AxisIteratorImpl that scans the nodes reached by the axis in turn.

iterateAxis

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. Axis.CHILD or Axis.PARENT nodeTest A pattern to be matched by the returned nodes.

Returns: a AxisIteratorImpl that scans the nodes reached by the axis in turn.

setParentNode

protected void setParentNode(TinyNodeImpl parent)
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.

Parameters: parent the parent of this node

setSystemId

public void setSystemId(String uri)
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.