| java.lang.Object
 net.sf.saxon.tree.NodeImpl
All known Subclasses: net.sf.saxon.tree.ParentNodeImpl, net.sf.saxon.tree.CommentImpl, net.sf.saxon.tree.ProcInstImpl, net.sf.saxon.tree.AttributeImpl, net.sf.saxon.tree.TextImpl,
| NodeImpl | | abstract public class NodeImpl implements NodeInfo,FingerprintedNode,SourceLocator(Code) | | A node in the XML parse tree 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 | |
| final public static char[] | NODE_LETTER
Chararacteristic letters to identify each type of node, indexed using the node type
values. | | protected int | index
| | protected ParentNodeImpl | parent
|
| NODE_LETTER | | final public static char[] NODE_LETTER(Code) | | 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()
|
| index | | protected int index(Code) | | |
| atomize | | public Value atomize() throws XPathException(Code) | | Get the typed value. The result of this method will always be consistent with the method
net.sf.saxon.om.Item.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.
the typed value. If requireSingleton is set to true, the result will always be anAtomicValue. In other cases it may be a Value representing a sequence whose items are atomicvalues.
since:
8.5 |
| compareOrder | | final public int compareOrder(NodeInfo other)(Code) | | 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 -1 if this node precedes the other node, +1 if it follows the othernode, or 0 if they are the same node. (In this case, isSameNode() will alwaysreturn true, and the two nodes will produce the same result for generateId()) |
| generateId | | public String generateId()(Code) | | Get a character string that uniquely identifies this node within this document
(The calling code will prepend a document identifier)
a string. |
| getAttributeValue | | public String getAttributeValue(int fingerprint)(Code) | | Get the value of a given attribute of this node
Parameters:
fingerprint - The fingerprint of the attribute name the attribute value if it exists or null if not |
| getBaseURI | | public String getBaseURI()(Code) | | Get the base URI for the node. Default implementation for child nodes.
|
| getColumnNumber | | public int getColumnNumber()(Code) | | Get the column number of the node.
The default implementation returns -1, meaning unknown
|
| getDeclaredNamespaces | | public int[] getDeclaredNamespaces(int[] buffer)(Code) | | 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 resultmay overwrite the contents of this array, to avoid the cost of allocating a new array on the heap. An array of integers representing the namespace declarations and undeclarations present onthis element. For a node other than an element, return null. Otherwise, the returned array is asequence of namespace codes, whose meaning may be interpreted by reference to the name pool. Thetop 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()(Code) | | Get the display name of this node. For elements and attributes this is [prefix:]localname.
For unnamed nodes, it is an empty string.
The display name of this node.For a node with no name, return an empty string. |
| getDocumentNumber | | public int getDocumentNumber()(Code) | | Get the document number of the document containing this node. For a free-standing
orphan node, just return the hashcode.
|
| getDocumentRoot | | public DocumentInfo getDocumentRoot()(Code) | | Get the root (document) node
the DocumentInfo representing the containing document |
| getFingerprint | | public int getFingerprint()(Code) | | 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()(Code) | | Get first child - default implementation used for leaf nodes
null |
| getLastChild | | public NodeInfo getLastChild()(Code) | | Get last child - default implementation used for leaf nodes
null |
| getLineNumber | | public int getLineNumber()(Code) | | Get the line number of the node within its source document entity
|
| getLocalPart | | public String getLocalPart()(Code) | | Get the local name of this node.
The local name of this node.For a node with no name, return "",. |
| getNameCode | | public int getNameCode()(Code) | | Get the nameCode of the node. This is used to locate the name in the NamePool
|
| getNextInDocument | | public NodeImpl getNextInDocument(NodeImpl anchor)(Code) | | Get the next node in document order
Parameters:
anchor - the scan stops when it reaches a node that is not a descendant of the specifiedanchor node the next node in the document, or null if there is no such node |
| getNextSibling | | public NodeInfo getNextSibling()(Code) | | Get next sibling node
The next sibling node of the required type. Returns null if the current node is the lastchild of its parent. |
| getParent | | final public NodeInfo getParent()(Code) | | Find the parent node of this node.
The Node object describing the containing element or root node. |
| getPrefix | | public String getPrefix()(Code) | | Get the prefix part of the name of this node. This is the name before the ":" if any.
the prefix part of the name. For an unnamed node, return an empty string. |
| getPreviousInDocument | | public NodeImpl getPreviousInDocument()(Code) | | Get the previous node in document order
the previous node in the document, or null if there is no such node |
| getPreviousSibling | | public NodeInfo getPreviousSibling()(Code) | | Get the previous sibling of the node
The previous sibling node. Returns null if the current node is the firstchild of its parent. |
| getPublicId | | public String getPublicId()(Code) | | Get the public identifier of the document entity containing this node.
The default implementation returns null, meaning unknown
|
| getRoot | | public NodeInfo getRoot()(Code) | | Get the root node
the NodeInfo representing the containing document |
| getSequenceNumber | | protected long getSequenceNumber()(Code) | | 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.
|
| getStringValueCS | | public CharSequence getStringValueCS()(Code) | | 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()(Code) | | Get the system ID for the node. Default implementation for child nodes.
|
| getTypeAnnotation | | public int getTypeAnnotation()(Code) | | Get the type annotation of this node, if any
|
| getTypedValue | | public SequenceIterator getTypedValue() throws XPathException(Code) | | Get the typed value of this node.
If there is no type annotation, we return the string value, as an instance
of xdt:untypedAtomic
|
| getURI | | public String getURI()(Code) | | 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.
The URI of the namespace of this node. For the default namespace, return anempty string. For an unnamed node, return the empty string. |
| hasChildNodes | | public boolean hasChildNodes()(Code) | | Determine whether the node has any children.
true if the node has any children,false if the node has no children. |
| isSameNodeInfo | | public boolean isSameNodeInfo(NodeInfo other)(Code) | | Determine whether this is the same node as another node
true if this Node object and the supplied Node object represent thesame node in the tree. |
| iterateAxis | | public AxisIterator iterateAxis(byte axisNumber)(Code) | | Return an enumeration over the nodes reached by the given axis from this node
Parameters:
axisNumber - The axis to be iterated over an AxisIterator that scans the nodes reached by the axis in turn. |
| iterateAxis | | public AxisIterator iterateAxis(byte axisNumber, NodeTest nodeTest)(Code) | | Return an enumeration over the nodes reached by the given axis from this node
Parameters:
axisNumber - The axis to be iterated over
Parameters:
nodeTest - A pattern to be matched by the returned nodes an AxisIterator that scans the nodes reached by the axis in turn. |
| sendNamespaceDeclarations | | public void sendNamespaceDeclarations(Receiver out, boolean includeAncestors) throws XPathException(Code) | | Output all namespace nodes associated with this element. Does nothing if
the node is not an element.
Parameters:
out - The relevant outputter
Parameters:
includeAncestors - True if namespaces declared on ancestor elements must |
| setSystemId | | public void setSystemId(String uri)(Code) | | 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
|
|
|