Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
net.sf.saxon.tinytree.TinyNodeImpl
public abstract class TinyNodeImpl
extends java.lang.Object
implements NodeInfo, ExtendedNodeInfo, FingerprintedNode, SourceLocator
Field Summary | |
static char[] |
|
protected int | |
protected TinyNodeImpl | |
protected TinyTree |
Fields inherited from interface net.sf.saxon.om.NodeInfo | |
ALL_NAMESPACES , EMPTY_NAMESPACE_LIST , IS_DTD_TYPE , IS_NILLED , LOCAL_NAMESPACES , NO_NAMESPACES |
Fields inherited from interface net.sf.saxon.om.ValueRepresentation | |
EMPTY_VALUE_ARRAY |
Method Summary | |
Value |
|
int |
|
boolean |
|
void |
|
String |
|
String |
|
int |
|
Configuration |
|
int[] |
|
String |
|
int |
|
DocumentInfo |
|
int |
|
int |
|
String |
|
int |
|
NamePool |
|
int |
|
NodeInfo |
|
String |
|
String |
|
NodeInfo |
|
protected long |
|
CharSequence |
|
String |
|
int |
|
SequenceIterator |
|
String |
|
boolean |
|
int |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
AxisIterator |
|
AxisIterator |
|
protected void |
|
void |
|
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()
protected int nodeNr
public Value atomize() throws XPathException
Get the typed value. The result of this method will always be consistent with the methodItem.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
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.
- Specified by:
- compareOrder in interface NodeInfo
- 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())
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.
public void generateId(FastStringBuffer buffer)
Get a character string that uniquely identifies this node
- Specified by:
- generateId in interface NodeInfo
- Parameters:
buffer
- buffer, which on return will contain a character string that uniquely identifies this node.
public String getAttributeValue(int fingerprint)
Get the value of a given attribute of this node
- Specified by:
- getAttributeValue in interface NodeInfo
- Parameters:
fingerprint
- The fingerprint of the attribute name
- Returns:
- the attribute value if it exists or null if not
public String getBaseURI()
Get the base URI for the node. Default implementation for child nodes gets the base URI of the parent node.
- Specified by:
- getBaseURI in interface NodeInfo
public int getColumnNumber()
Get the column number of the node. The default implementation returns -1, meaning unknown
public Configuration getConfiguration()
Get the configuration
- Specified by:
- getConfiguration in interface NodeInfo
public int[] getDeclaredNamespaces(int[] buffer)
Get all namespace undeclarations and undeclarations defined on this element.
- Specified by:
- getDeclaredNamespaces in interface NodeInfo
- 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.
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.
- Specified by:
- getDisplayName in interface NodeInfo
- Returns:
- The display name of this node. For a node with no name, return an empty string.
public final int 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)
- Specified by:
- getDocumentNumber in interface NodeInfo
public DocumentInfo getDocumentRoot()
Get the root (document) node
- Specified by:
- getDocumentRoot in interface NodeInfo
- Returns:
- the DocumentInfo representing the containing document
public int getFingerprint()
Get the fingerprint of the node, used for matching names
- Specified by:
- getFingerprint in interface NodeInfo
public int getLineNumber()
Get the line number of the node within its source document entity
- Specified by:
- getLineNumber in interface NodeInfo
public String getLocalPart()
Get the local part of the name of this node.
- Specified by:
- getLocalPart in interface NodeInfo
- Returns:
- The local name of this node. For a node with no name, return "".
public int getNameCode()
Get the name code of the node, used for matching names
- Specified by:
- getNameCode in interface NodeInfo
public NamePool getNamePool()
Get the NamePool for the tree containing this node
- Specified by:
- getNamePool in interface NodeInfo
- Returns:
- the NamePool
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
public NodeInfo getParent()
Find the parent node of this node.
- Returns:
- The Node object describing the containing element or root node.
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 "".
public String getPublicId()
Get the public identifier of the document entity containing this node. The default implementation returns null, meaning unknown
public NodeInfo getRoot()
Get the root node of the tree (not necessarily a document node)
- Returns:
- the NodeInfo representing the root of this tree
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
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.
- Specified by:
- getStringValueCS in interface Item
- getStringValueCS in interface ValueRepresentation
public String getSystemId()
Get the system ID for the entity containing the node.
- Specified by:
- getSystemId in interface NodeInfo
public int getTypeAnnotation()
Get the type annotation of this node, if any
- Specified by:
- getTypeAnnotation in interface NodeInfo
public SequenceIterator getTypedValue() throws XPathException
Get the typed value of this node. If there is no type annotation, we return the string value, as an instance of xs:untypedAtomic
- Specified by:
- getTypedValue in interface Item
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.
public boolean hasChildNodes()
Determine whether the node has any children.
- Specified by:
- hasChildNodes in interface NodeInfo
- Returns:
true
if this node has any attributes,false
otherwise.
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.
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
public boolean isId()
Determine whether this node has the is-id property
- Specified by:
- isId in interface ExtendedNodeInfo
- Returns:
- true if the node is an ID
public boolean isIdref()
Determine whether this node has the is-idref property
- Specified by:
- isIdref in interface ExtendedNodeInfo
- Returns:
- true if the node is an IDREF or IDREFS element or attribute
public boolean isNilled()
Determine whether the node has the is-nilled property
- Specified by:
- isNilled in interface ExtendedNodeInfo
- Returns:
- true if the node has the is-nilled property
public boolean isSameNodeInfo(NodeInfo other)
Determine whether this is the same node as another node
- Specified by:
- isSameNodeInfo in interface NodeInfo
- Returns:
- true if this Node object and the supplied Node object represent the same node in the tree.
public AxisIterator iterateAxis(byte axisNumber)
Return an iterator over all the nodes reached by the given axis from this node
- Specified by:
- iterateAxis in interface NodeInfo
- 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.
public AxisIterator iterateAxis(byte axisNumber, NodeTest nodeTest)
Return an iterator over the nodes reached by the given axis from this node
- Specified by:
- iterateAxis in interface NodeInfo
- Parameters:
axisNumber
- Identifies the required axis, eg. Axis.CHILD or Axis.PARENTnodeTest
- A pattern to be matched by the returned nodes.
- Returns:
- a AxisIteratorImpl that scans the nodes reached by the axis in turn.
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
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.