Package net.sf.saxon.tree.linked
Class ParentNodeImpl
java.lang.Object
net.sf.saxon.tree.linked.NodeImpl
net.sf.saxon.tree.linked.ParentNodeImpl
- All Implemented Interfaces:
Source
,SourceLocator
,PullEvent
,FingerprintedNode
,Item<NodeInfo>
,MutableNodeInfo
,NodeInfo
,ValueRepresentation<NodeInfo>
,SiblingCountingNode
- Direct Known Subclasses:
DocumentImpl
,ElementImpl
ParentNodeImpl is an implementation of a non-leaf node (specifically, an Element node
or a Document node)
- Author:
- Michael H. Kay
-
Field Summary
Fields inherited from class net.sf.saxon.tree.linked.NodeImpl
NODE_LETTER
Fields inherited from interface net.sf.saxon.om.NodeInfo
ALL_NAMESPACES, 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 TypeMethodDescriptionprotected void
Add a child node to this node.void
compact
(int size) Compact the space used by this nodeprotected final AxisIterator
enumerateChildren
(NodeTest test) Get an enumeration of the children of this nodefinal NodeInfo
Get the first child node of the elementfinal NodeInfo
Get the last child node of the elementprotected final NodeImpl
getNthChild
(int n) Get the nth child node of the element (numbering from 0)final int
Determine how many children the node hasprotected final int
protected final long
Get the node sequence number (in document order).Return the string-value of the node, that is, the concatenation of the character content of all descendent elements and text nodes.Get the value of the item as a CharSequence.final boolean
Determine if the node has any children.void
insertChildren
(NodeInfo[] source, boolean atStart, boolean inherit) Insert a sequence of nodes as children of this node.protected void
insertChildrenAt
(NodeInfo[] source, int index, boolean inherit) Insert children before or after a given existing childprotected void
removeChild
(NodeImpl child) Remove a given childprotected void
replaceChildrenAt
(NodeInfo[] source, int index, boolean inherit) Replace child at a given index by new childrenprotected final void
setChildren
(Object children) Set the children of this nodeprotected final void
setRawSequenceNumber
(int seq) Methods inherited from class net.sf.saxon.tree.linked.NodeImpl
addAttribute, addNamespace, atomize, compareOrder, delete, equals, generateId, getAttributeValue, getAttributeValue, getBaseURI, getColumnNumber, getConfiguration, getDeclaredNamespaces, getDisplayName, getDocumentNumber, getDocumentRoot, getFingerprint, getLineNumber, getLocalPart, getNameCode, getNamePool, getNextInDocument, getNextSibling, getParent, getPhysicalRoot, getPrefix, getPreviousInDocument, getPreviousSibling, getPublicId, getRawParent, getRoot, getSchemaType, getSiblingPosition, getSystemId, getTypeAnnotation, getTypedValue, getURI, insertSiblings, isDeleted, isId, isIdref, isNilled, isSameNodeInfo, iterateAxis, iterateAxis, newBuilder, removeAttribute, removeTypeAnnotation, rename, replace, setRawParent, setSiblingPosition, setSystemId, setTypeAnnotation
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, hashCode
-
Constructor Details
-
ParentNodeImpl
ParentNodeImpl()
-
-
Method Details
-
getSequenceNumber
protected final 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 document nodes) 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. For nodes added by XQUery Update, the sequence number is -1L- Overrides:
getSequenceNumber
in classNodeImpl
- Returns:
- the sequence number if there is one, or -1L otherwise.
-
getRawSequenceNumber
protected final int getRawSequenceNumber() -
setRawSequenceNumber
protected final void setRawSequenceNumber(int seq) -
setChildren
Set the children of this node- Parameters:
children
- null if there are no children, a single NodeInfo if there is one child, an array of NodeInfo if there are multiple children
-
hasChildNodes
public final boolean hasChildNodes()Determine if the node has any children.- Specified by:
hasChildNodes
in interfaceNodeInfo
- Overrides:
hasChildNodes
in classNodeImpl
- Returns:
true
if the node has any children,false
if the node has no children.
-
getNumberOfChildren
public final int getNumberOfChildren()Determine how many children the node has- Returns:
- the number of children of this parent node
-
enumerateChildren
Get an enumeration of the children of this node- Parameters:
test
- A NodeTest to be satisfied by the child nodes, or null if all child node are to be returned- Returns:
- an iterator over the children of this node
-
getFirstChild
Get the first child node of the element- Overrides:
getFirstChild
in classNodeImpl
- Returns:
- the first child node of the required type, or null if there are no children
-
getLastChild
Get the last child node of the element- Overrides:
getLastChild
in classNodeImpl
- Returns:
- the last child of the element, or null if there are no children
-
getNthChild
Get the nth child node of the element (numbering from 0)- Parameters:
n
- identifies the required child- Returns:
- the last child of the element, or null if there is no n'th child
-
removeChild
Remove a given child- Parameters:
child
- the child to be removed
-
getStringValue
Return the string-value of the node, that is, the concatenation of the character content of all descendent elements and text nodes.- Returns:
- the accumulated character content of the element, including descendant elements.
- See Also:
-
getStringValueCS
Description copied from class:NodeImpl
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<NodeInfo>
- Specified by:
getStringValueCS
in interfaceValueRepresentation<NodeInfo>
- Overrides:
getStringValueCS
in classNodeImpl
- Returns:
- the string value of the item
- See Also:
-
addChild
Add a child node to this node. For system use only. Note: normalizing adjacent text nodes is the responsibility of the caller.- Parameters:
node
- the node to be added as a child of this node. This must be an instance ofNodeImpl
. It will be modified as a result of this call (by setting its parent property and sibling position)index
- the position where the child is to be added
-
insertChildren
Insert 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 form the new children. Adjacent text nodes will be merged, and zero-length text nodes removed. The supplied nodes may be modified in situ, for example to change their parent property and to add namespace bindings, or they may be copied, at the discretion of the implementation.
- Specified by:
insertChildren
in interfaceMutableNodeInfo
- Overrides:
insertChildren
in classNodeImpl
- Parameters:
source
- the nodes to be inserted. The implementation determines what implementation classes of node it will accept; this implementation will accept text, comment, and processing instruction nodes belonging to any implementation, but elements must be instances ofElementImpl
. The supplied nodes will be modified in situ, for example to change their parent property and to add namespace bindings, if they are instances ofElementImpl
; otherwise they will be copied. If the nodes are copied, then on return the supplied source array will contain the copy rather than the original.atStart
- true if the new nodes are to be inserted before existing children; false if they are to be inserted after existing childreninherit
- true if the inserted nodes are to inherit the namespaces of their new parent; false if such namespaces are to be undeclared- Throws:
IllegalArgumentException
- if the supplied nodes use a node implementation that this implementation does not accept.
-
insertChildrenAt
Insert children before or after a given existing child- Parameters:
source
- the children to be inserted. We allow any kind of text, comment, or processing instruction node, but element nodes must be instances of this NodeInfo implementation.index
- the position before which they are to be inserted: 0 indicates insertion before the first child, 1 insertion before the second child, and so on.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
-
replaceChildrenAt
Replace child at a given index by new children- Parameters:
source
- the children to be insertedindex
- the position at which they are to be inserted: 0 indicates replacement of the first child, replacement of the second child, and so on. The effect is undefined if index is out of rangeinherit
- set to true if the 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
-
compact
public void compact(int size) Compact the space used by this node- Parameters:
size
- the number of actual children
-