com.icl.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 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
voidcopyStringValue(Outputter out)
Copy the string-value of this node to a given outputter
voiddropChildren()
Drop a branch of the tree.
AxisEnumerationenumerateChildren(NodeTest test)
Get an enumeration of the children of this node
NodeListgetChildNodes()
Return a NodeList that contains all children of this node.
NodegetFirstChild()
Get the first child node of the element
NodegetLastChild()
Get the last child node of the element
StringgetNodeValue()
Get the node value as defined in the DOM.
protected NodeImplgetNthChild(int n)
Get the nth child node of the element (numbering from 0)
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.
booleanhasChildNodes()
Determine if the node has any children.
voidremoveChild(int index)
Remove node at given index.
voidrenumberChildren()
Renumber the children of a given parent node.
voiduseChildrenArray(NodeImpl[] array)
Supply an array to be used for the array of children.

Field Detail

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.

compact

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

copyStringValue

public void copyStringValue(Outputter out)
Copy the string-value of this node to a given outputter

dropChildren

public void dropChildren()
Drop a branch of the tree. The target element remains in the tree, but its children are disconnected from the parent. Unless there are other references to the children (e.g. in a variable) they will be deleted from memory next time the garbage collector comes round.

enumerateChildren

public final AxisEnumeration enumerateChildren(NodeTest test)
Get an enumeration of the children of this node

getChildNodes

public final NodeList getChildNodes()
Return a NodeList that contains all children of this node. If there are no children, this is a NodeList containing no nodes.

getFirstChild

public final Node 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 Node getLastChild()
Get the last child node of the element

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

getNodeValue

public String getNodeValue()
Get the node value as defined in the DOM. This is not the same as the XPath string-value.

getNthChild

protected final NodeImpl getNthChild(int n)
Get the nth child node of the element (numbering from 0)

Returns: the last child of the element, or null if there is no n'th child

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

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.

hasChildNodes

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

removeChild

public void removeChild(int index)
Remove node at given index. Will always be followed by a renumberChildren().

renumberChildren

public void renumberChildren()
Renumber the children of a given parent node. For system use only

useChildrenArray

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