Class NodeImpl
- All Implemented Interfaces:
Source
,SourceLocator
,PullEvent
,FingerprintedNode
,Item
,MutableNodeInfo
,NodeInfo
,SiblingCountingNode
,ValueRepresentation
- Direct Known Subclasses:
DocumentImpl
,ElementImpl
- Author:
- Michael H. Kay
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected int
static final char[]
Chararacteristic letters to identify each type of node, indexed using the node type values.protected net.sf.saxon.tree.ParentNodeImpl
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
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addNamespace
(int nscode, boolean inherit) Add a namespace binding (that is, a namespace node) to this element.atomize()
Get the typed value.final 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
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)getAttributeValue
(int fingerprint) Get the value of a given attribute of this nodeGet the base URI for the node.int
Get the column number of the node.Get the configurationint[]
getDeclaredNamespaces
(int[] buffer) Get all namespace undeclarations and undeclarations defined on this element.Get the display name of this node.int
Get the document number of the document containing this node.Get the root (document) nodeint
Get the fingerprint of the node.Get first child - default implementation used for leaf nodesGet last child - default implementation used for leaf nodesint
Get the line number of the node within its source document entityGet the local name of this node.int
Get the nameCode of the node.Get the NamePoolgetNextInDocument
(NodeImpl anchor) Get the next node in document orderGet next sibling nodefinal NodeInfo
Find the parent node of this node.Get the physical root of the tree.Get the prefix part of the name of this node.Get the previous node in document orderGet the previous sibling of the nodeGet the public identifier of the document entity containing this node.getRoot()
Get the root nodeprotected long
Get the node sequence number (in document order).int
Get the index position of this node among its siblings (starting from 0)Get the value of the item as a CharSequence.Get the system ID for the node.int
Get the type annotation of this node, if anyGet the typed value of this node.getURI()
Get the URI part of the name of this node.boolean
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
isId()
Determine whether this node has the is-id propertyboolean
isIdref()
Determine whether this node has the is-idref propertyboolean
isNilled()
Determine whether the node has the is-nilled propertyboolean
isSameNodeInfo
(NodeInfo other) Determine whether this is the same node as another nodeiterateAxis
(byte axisNumber) Return an enumeration over the nodes reached by the given axis from this nodeiterateAxis
(byte axisNumber, NodeTest nodeTest) Return an enumeration over the nodes reached by the given axis from this nodeGet a Builder suitable for building nodes that can be attached to this document.void
putAttribute
(int nameCode, int typeCode, CharSequence value, int properties) Add an attribute to this element node.void
removeAttribute
(int nameCode) Remove an attribute from this element nodevoid
Remove type information from this node (and its ancestors, recursively).void
rename
(int newNameCode) Rename this nodevoid
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.Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface net.sf.saxon.om.MutableNodeInfo
replaceStringValue
Methods inherited from interface net.sf.saxon.om.NodeInfo
copy, getNodeKind, getStringValue, hashCode
-
Field Details
-
parent
protected net.sf.saxon.tree.ParentNodeImpl parent -
index
protected int index -
NODE_LETTER
public static final char[] NODE_LETTERChararacteristic 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()
-
-
Constructor Details
-
NodeImpl
public NodeImpl()
-
-
Method Details
-
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 interfaceItem
- Specified by:
getStringValueCS
in interfaceValueRepresentation
- Returns:
- the string value of the item
- See Also:
-
getTypeAnnotation
public int getTypeAnnotation()Get the type annotation of this node, if any- Specified by:
getTypeAnnotation
in interfaceNodeInfo
- Returns:
- the type annotation, as the integer name code of the type name
-
getColumnNumber
public int getColumnNumber()Get the column number of the node. The default implementation returns -1, meaning unknown- Specified by:
getColumnNumber
in interfaceNodeInfo
- Specified by:
getColumnNumber
in interfaceSourceLocator
- Returns:
- the column number of the node in its original source document; or -1 if not available
-
getPublicId
Get the public identifier of the document entity containing this node. The default implementation returns null, meaning unknown- Specified by:
getPublicId
in interfaceSourceLocator
-
getDocumentNumber
public int getDocumentNumber()Get the document number of the document containing this node. For a free-standing orphan node, just return the hashcode.- Specified by:
getDocumentNumber
in interfaceNodeInfo
- Returns:
- the document number of the document containing this node
-
getSiblingPosition
public int getSiblingPosition()Get the index position of this node among its siblings (starting from 0)- Specified by:
getSiblingPosition
in interfaceSiblingCountingNode
- Returns:
- 0 for the first child, 1 for the second child, etc.
-
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- Specified by:
getTypedValue
in interfaceItem
- Returns:
- an iterator over the items in the typed value of the node or atomic value. The items returned by this iterator will always be atomic values.
- Throws:
XPathException
- where no typed value is available, for example in the case of an element with complex content
-
atomize
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.- Specified by:
atomize
in interfaceNodeInfo
- 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.
- Throws:
XPathException
- Since:
- 8.5
-
setSystemId
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- Specified by:
setSystemId
in interfaceSource
-
isSameNodeInfo
Determine whether this is the same node as another node- Specified by:
isSameNodeInfo
in interfaceNodeInfo
- Parameters:
other
- the node to be compared with this node- Returns:
- true if this Node object and the supplied Node object represent the same node in the tree.
-
equals
The equals() method compares nodes for identity. It is defined to give the same result as isSameNodeInfo().- Specified by:
equals
in interfaceNodeInfo
- Overrides:
equals
in classObject
- 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.
-
getNameCode
public int getNameCode()Get the nameCode of the node. This is used to locate the name in the NamePool- Specified by:
getNameCode
in interfaceNodeInfo
- Returns:
- an integer name code, which may be used to obtain the actual node name from the name pool. For unnamed nodes (text nodes, comments, document nodes, and namespace nodes for the default namespace), returns -1.
- See Also:
-
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.- Specified by:
getFingerprint
in interfaceNodeInfo
- Returns:
- an integer fingerprint; two nodes with the same fingerprint have the same expanded QName. For unnamed nodes (text nodes, comments, document nodes, and namespace nodes for the default namespace), returns -1.
-
generateId
Get a character string that uniquely identifies this node within this document (The calling code will prepend a document identifier)- Specified by:
generateId
in interfaceNodeInfo
- Parameters:
buffer
- a buffer which will be updated to hold a string that uniquely identifies this node, across all documents.
-
getSystemId
Get the system ID for the node. Default implementation for child nodes.- Specified by:
getSystemId
in interfaceNodeInfo
- Specified by:
getSystemId
in interfaceSource
- Specified by:
getSystemId
in interfaceSourceLocator
- Returns:
- the System Identifier of the entity in the source document containing the node, or null if not known or not applicable.
-
getBaseURI
Get the base URI for the node. Default implementation for child nodes.- Specified by:
getBaseURI
in interfaceNodeInfo
- Returns:
- the base URI of the node. This may be null if the base URI is unknown.
-
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.
-
compareOrder
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 interfaceNodeInfo
- 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())
-
getConfiguration
Get the configuration- Specified by:
getConfiguration
in interfaceNodeInfo
- Returns:
- the Configuration
-
getNamePool
Get the NamePool- Specified by:
getNamePool
in interfaceNodeInfo
- Returns:
- the namepool
-
getPrefix
Get the prefix part of the name of this node. This is the name before the ":" if any. -
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. -
getDisplayName
Get the display name of this node. For elements and attributes this is [prefix:]localname. For unnamed nodes, it is an empty string.- Specified by:
getDisplayName
in interfaceNodeInfo
- Returns:
- The display name of this node. For a node with no name, return an empty string.
-
getLocalPart
Get the local name of this node.- Specified by:
getLocalPart
in interfaceNodeInfo
- Returns:
- The local name of this node. For a node with no name, return "",.
-
getLineNumber
public int getLineNumber()Get the line number of the node within its source document entity- Specified by:
getLineNumber
in interfaceNodeInfo
- Specified by:
getLineNumber
in interfaceSourceLocator
- Returns:
- the line number of the node in its original source document; or -1 if not available
-
getParent
Find the parent node of this node. -
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.
-
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.
-
getFirstChild
Get first child - default implementation used for leaf nodes- Returns:
- null
-
getLastChild
Get last child - default implementation used for leaf nodes- Returns:
- null
-
iterateAxis
Return an enumeration over the nodes reached by the given axis from this node- Specified by:
iterateAxis
in interfaceNodeInfo
- Parameters:
axisNumber
- The axis to be iterated over- Returns:
- an AxisIterator that scans the nodes reached by the axis in turn.
- See Also:
-
iterateAxis
Return an enumeration over the nodes reached by the given axis from this node- Specified by:
iterateAxis
in interfaceNodeInfo
- Parameters:
axisNumber
- The axis to be iterated overnodeTest
- A pattern to be matched by the returned nodes- Returns:
- an AxisIterator that scans the nodes reached by the axis in turn.
- See Also:
-
getAttributeValue
Get the value of a given attribute of this node- Specified by:
getAttributeValue
in interfaceNodeInfo
- Parameters:
fingerprint
- The fingerprint of the attribute name- Returns:
- the attribute value if it exists or null if not
-
getRoot
Get the root node -
getDocumentRoot
Get the root (document) node- Specified by:
getDocumentRoot
in interfaceNodeInfo
- 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.
-
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.
-
getNextInDocument
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
-
getPreviousInDocument
Get the previous node in document order- Returns:
- the previous node in the document, or null if there is no such node
-
getDeclaredNamespaces
public int[] getDeclaredNamespaces(int[] buffer) Get all namespace undeclarations and undeclarations defined on this element.- Specified by:
getDeclaredNamespaces
in interfaceNodeInfo
- 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.
-
hasChildNodes
public boolean hasChildNodes()Determine whether the node has any children.- Specified by:
hasChildNodes
in interfaceNodeInfo
- Returns:
true
if the node has any children,false
if the node has no children.
-
isId
public boolean isId()Determine whether this node has the is-id property -
isIdref
public boolean isIdref()Determine whether this node has the is-idref property -
isNilled
public boolean isNilled()Determine whether the node has the is-nilled property -
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.- Specified by:
setTypeAnnotation
in interfaceMutableNodeInfo
- Parameters:
typeCode
- the type annotation (possibly including high bits set to indicate the isID, isIDREF, and isNilled properties)
-
delete
public void delete()Delete this node (that is, detach it from its parent)- Specified by:
delete
in interfaceMutableNodeInfo
-
removeAttribute
public void removeAttribute(int nameCode) Remove an attribute from this element nodeIf this node is not an element, or if it has no attribute with the specified name, this method takes no action.
The attribute node itself is not modified in any way.
- Specified by:
removeAttribute
in interfaceMutableNodeInfo
- Parameters:
nameCode
- the name of the attribute to be removed
-
putAttribute
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 existing attribute is replaced.
- Specified by:
putAttribute
in interfaceMutableNodeInfo
- Parameters:
nameCode
- the name of the new attributetypeCode
- the type annotation of the new attributevalue
- the string value of the new attributeproperties
- properties including IS_ID and IS_IDREF properties
-
rename
public void rename(int newNameCode) Rename this node- Specified by:
rename
in interfaceMutableNodeInfo
- Parameters:
newNameCode
- the NamePool code of the new name
-
addNamespace
public void addNamespace(int nscode, boolean inherit) Description copied from interface:MutableNodeInfo
Add a namespace binding (that is, a namespace node) to this element. This call has no effect if applied to a node other than an element.- Specified by:
addNamespace
in interfaceMutableNodeInfo
- Parameters:
nscode
- The namespace code representing the (prefix, uri) pair of the namespace binding to be added. If the target element already has a namespace binding with this (prefix, uri) pair, the call has no effect. If the target element currently has a namespace binding with this prefix and a different URI, an exception is raised.inherit
- If true, the new namespace binding will be inherited by any children of the target element that do not already have a namespace binding for the specified prefix, recursively. If false, the new namespace binding will not be inherited.
-
replace
Replace this node with a given sequence of nodes *- Specified by:
replace
in interfaceMutableNodeInfo
- Parameters:
replacement
- the replacement nodesinherit
- set to true if new child elements are to inherit the in-scope namespaces of their new parent- Throws:
IllegalArgumentException
- if any of the replacement nodes is not an element, text, comment, or processing instruction node
-
insertChildren
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.
- Specified by:
insertChildren
in interfaceMutableNodeInfo
- Parameters:
source
- the nodes to be insertedatStart
- true if the new nodes are to be inserted before existing children; false if they areinherit
- 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
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.
- Specified by:
insertSiblings
in interfaceMutableNodeInfo
- Parameters:
source
- the nodes to be insertedbefore
- true if the new nodes are to be inserted before the target node; false if they areinherit
-
-
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- Specified by:
removeTypeAnnotation
in interfaceMutableNodeInfo
-
newBuilder
Get a Builder suitable for building nodes that can be attached to this document.- Specified by:
newBuilder
in interfaceMutableNodeInfo
- Returns:
- a new Builder that constructs nodes using the same object model implementation as this one, suitable for attachment to this tree
-