net.sf.saxon.tree

Class ParentNodeImpl

abstract class ParentNodeImpl extends NodeImpl

ParentNodeImpl is an implementation of a non-leaf node (specifically, an Element node or a Document node)

Author: Michael H. Kay

Field Summary
protected Objectchildren
protected intsequence
Method Summary
voidaddChild(NodeImpl node, int index)
Add a child node to this node.
voidcompact(int size)
Compact the space used by this node
protected AxisIteratorenumerateChildren(NodeTest test)
Get an enumeration of the children of this node
NodeInfogetFirstChild()
Get the first child node of the element
NodeInfogetLastChild()
Get the last child node of the element
protected NodeImplgetNthChild(int n)
Get the nth child node of the element (numbering from 0)
intgetNumberOfChildren()
Determine how many children the node has
protected longgetSequenceNumber()
Get the node sequence number (in document order).
StringgetStringValue()
Return the string-value of the node, that is, the concatenation of the character content of all descendent elements and text nodes.
CharSequencegetStringValueCS()
booleanhasChildNodes()
Determine if the node has any children.
voidinsertChildren(NodeInfo[] source, boolean atStart, boolean inherit)
Insert copies of a sequence of nodes as children of this node.
protected voidinsertChildrenAt(NodeInfo[] source, int index, boolean inherit)
Insert children before or after a given existing child
protected voidremoveChild(NodeImpl child)
Remove a given child
protected voidreplaceChildrenAt(NodeInfo[] source, int index, boolean inherit)
Replace child at a given index by new children
protected voiduseChildrenArray(NodeImpl[] array)
Supply an array to be used for the array of children.

Field Detail

children

protected Object children

sequence

protected int sequence

Method Detail

addChild

public void addChild(NodeImpl node, int index)
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 index the position where the child is to be added

compact

public void compact(int size)
Compact the space used by this node

Parameters: size the number of actual children

enumerateChildren

protected final AxisIterator enumerateChildren(NodeTest test)
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

public final NodeInfo getFirstChild()
Get the first child node of the element

Returns: the first child node of the required type, or null if there are no children

getLastChild

public final NodeInfo getLastChild()
Get the last child node of the element

Returns: the last child of the element, or null if there are no children

getNthChild

protected final NodeImpl getNthChild(int n)
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

getNumberOfChildren

public int getNumberOfChildren()
Determine how many children the node has

Returns: the number of children of this parent node

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

Returns: the sequence number if there is one, or -1L otherwise.

getStringValue

public String 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.

getStringValueCS

public CharSequence getStringValueCS()

hasChildNodes

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

insertChildren

public void insertChildren(NodeInfo[] source, boolean atStart, boolean inherit)
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.

Parameters: source the nodes to be inserted atStart true if the new nodes are to be inserted before existing children; false if they are 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

insertChildrenAt

protected void insertChildrenAt(NodeInfo[] source, int index, boolean inherit)
Insert children before or after a given existing child

Parameters: source the children to be inserted 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

removeChild

protected void removeChild(NodeImpl child)
Remove a given child

Parameters: child the child to be removed

replaceChildrenAt

protected void replaceChildrenAt(NodeInfo[] source, int index, boolean inherit)
Replace child at a given index by new children

Parameters: source the children to be inserted index 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 range inherit 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

useChildrenArray

protected void useChildrenArray(NodeImpl[] array)
Supply an array to be used for the array of children. For system use only.

Parameters: array the array to be used