net.sf.saxon.tree.tiny.SiblingEnumeration Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of saxon-he Show documentation
Show all versions of saxon-he Show documentation
An OSGi bundle for Saxon-HE
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Copyright (c) 2013 Saxonica Limited.
// This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
// If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
// This Source Code Form is "Incompatible With Secondary Licenses", as defined by the Mozilla Public License, v. 2.0.
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
package net.sf.saxon.tree.tiny;
import net.sf.saxon.om.NodeInfo;
import net.sf.saxon.om.Sequence;
import net.sf.saxon.pattern.NodeTest;
import net.sf.saxon.trans.XPathException;
import net.sf.saxon.tree.iter.AxisIterator;
import net.sf.saxon.tree.iter.AxisIteratorImpl;
import net.sf.saxon.tree.iter.LookaheadIterator;
import net.sf.saxon.type.Type;
import net.sf.saxon.value.UntypedAtomicValue;
/**
* This class supports both the child:: and following-sibling:: axes, which are
* identical except for the route to the first candidate node.
* It enumerates either the children or the following siblings of the specified node.
* In the case of children, the specified node must always
* be a node that has children: to ensure this, construct the enumeration
* using NodeInfo#getEnumeration()
*/
final class SiblingEnumeration extends AxisIteratorImpl implements LookaheadIterator {
// NOTE: have experimented with a dedicated iterator for the child axis matching against
// elements only, by fingerprint - no measurable improvement obtained.
private TinyTree tree;
private int nextNodeNr;
/*@Nullable*/ private NodeTest test;
private TinyNodeImpl startNode;
private TinyNodeImpl parentNode;
private boolean getChildren;
private boolean needToAdvance = false;
/**
* Return an enumeration over children or siblings of the context node
* @param tree The TinyTree containing the context node
* @param node The context node, the start point for the iteration
* @param nodeTest Test that the selected nodes must satisfy, or null indicating
* that all nodes are selected
* @param getChildren True if children of the context node are to be returned, false
* if following siblings are required
*/
SiblingEnumeration(/*@NotNull*/ TinyTree tree, /*@NotNull*/ TinyNodeImpl node,
/*@Nullable*/ NodeTest nodeTest, boolean getChildren) {
this.tree = tree;
test = nodeTest;
startNode = node;
this.getChildren = getChildren;
if (getChildren) { // child:: axis
parentNode = node;
// move to first child
// ASSERT: we don't invoke this code unless the node has children
nextNodeNr = node.nodeNr + 1;
} else { // following-sibling:: axis
parentNode = (TinyNodeImpl)node.getParent();
if (parentNode == null) {
nextNodeNr = -1;
} else {
// move to next sibling
nextNodeNr = tree.next[node.nodeNr];
while (tree.nodeKind[nextNodeNr] == Type.PARENT_POINTER) {
// skip dummy nodes
nextNodeNr = tree.next[nextNodeNr];
}
if (nextNodeNr < node.nodeNr) {
// if "next" pointer goes backwards, it's really an owner pointer from the last sibling
nextNodeNr = -1;
}
}
}
// check if this matches the conditions
if (nextNodeNr >= 0 && nodeTest != null) {
if (!nodeTest.matches(this.tree, nextNodeNr)) {
needToAdvance = true;
}
}
}
public boolean moveNext() {
// if needToAdvance == false, nextNodeNr already identifies the correct node.
current = null;
if (needToAdvance) {
final int thisNode = nextNodeNr;
final NodeTest nTest = test;
final int[] tNext = tree.next;
if (nTest==null) {
do {
nextNodeNr = tNext[nextNodeNr];
} while (tree.nodeKind[nextNodeNr] == Type.PARENT_POINTER);
} else {
do {
nextNodeNr = tNext[nextNodeNr];
} while ( nextNodeNr >= thisNode && !nTest.matches(tree, nextNodeNr));
}
if (nextNodeNr < thisNode) { // indicates we've got to the last sibling
nextNodeNr = -1;
needToAdvance = false;
current = null;
position = -1;
return false;
}
}
if (nextNodeNr == -1) {
return false;
}
needToAdvance = true;
position++;
return true;
}
/**
* Return the next node in the sequence
* @return the next node, or null if the end of the sequence is reached
*/
/*@Nullable*/ public NodeInfo next() {
if (needToAdvance) {
final int thisNode = nextNodeNr;
final int[] tNext = tree.next;
final NodeTest nTest = test;
if (nTest==null) {
do {
nextNodeNr = tNext[nextNodeNr];
} while (tree.nodeKind[nextNodeNr] == Type.PARENT_POINTER);
} else {
do {
nextNodeNr = tNext[nextNodeNr];
} while ( nextNodeNr >= thisNode && !nTest.matches(tree, nextNodeNr));
}
if (nextNodeNr < thisNode) { // indicates we've got to the last sibling
nextNodeNr = -1;
needToAdvance = false;
current = null;
position = -1;
return null;
}
}
if (nextNodeNr == -1) {
return null;
}
needToAdvance = true;
position++;
TinyNodeImpl nextNode = tree.getNode(nextNodeNr);
nextNode.setParentNode(parentNode);
return (current = nextNode);
}
/**
* Get the current node in the sequence.
* @return the node returned by the most recent call on next(), or the one on which we have positioned
* using moveNext().
*/
/*@Nullable*/ public NodeInfo current() {
if (current == null) {
if (nextNodeNr == -1) {
return null;
} else {
TinyNodeImpl nextNode = tree.getNode(nextNodeNr);
nextNode.setParentNode(parentNode);
return (current = nextNode);
}
}
return current;
}
/**
* Test whether there are any more nodes to come. This method is used only when testing whether the
* current item is the last in the sequence. It's not especially efficient, but is more efficient than
* the alternative strategy which involves counting how many nodes there are in the sequence.
* @return true if there are more items in the sequence
*/
public boolean hasNext() {
int n = nextNodeNr;
if (needToAdvance) {
final NodeTest nTest = test;
final int[] tNext = tree.next;
if (nTest==null) {
do {
n = tNext[n];
} while (tree.nodeKind[n] == Type.PARENT_POINTER);
} else {
do {
n = tNext[n];
} while ( n >= nextNodeNr && !nTest.matches(tree, n));
}
if (n < nextNodeNr) { // indicates we've got to the last sibling
return false;
}
}
return (n != -1);
}
/**
* Return the atomized value of the current node. This is achieved in common cases without
* actually instantiating the NodeInfo object
*
* @return the atomized value.
* @throws NullPointerException if there is no current node
*/
public Sequence atomize() throws XPathException {
int kind;
try {
kind = tree.nodeKind[nextNodeNr];
} catch (ArrayIndexOutOfBoundsException err) {
throw new NullPointerException();
}
switch (kind) {
case Type.TEXT: {
return new UntypedAtomicValue(TinyTextImpl.getStringValue(tree, nextNodeNr));
}
case Type.WHITESPACE_TEXT: {
return new UntypedAtomicValue(WhitespaceTextImpl.getStringValueCS(tree, nextNodeNr));
}
case Type.ELEMENT: {
return tree.getTypedValueOfElement(nextNodeNr);
}
case Type.COMMENT:
case Type.PROCESSING_INSTRUCTION:
return tree.getAtomizedValueOfUntypedNode(nextNodeNr);
default:
return current().atomize();
}
}
/**
* Return the string value of the current node.
*
* @return the string value, as an instance of CharSequence.
* @throws NullPointerException if there is no current node
*/
public CharSequence getStringValue() {
int kind;
try {
kind = tree.nodeKind[nextNodeNr];
} catch (ArrayIndexOutOfBoundsException err) {
throw new NullPointerException();
}
switch (kind) {
case Type.TEXT: {
return TinyTextImpl.getStringValue(tree, nextNodeNr);
}
case Type.WHITESPACE_TEXT: {
return WhitespaceTextImpl.getStringValueCS(tree, nextNodeNr);
}
case Type.ELEMENT: {
return TinyParentNodeImpl.getStringValueCS(tree, nextNodeNr);
}
default:
return current().getStringValueCS();
}
}
/**
* Get another enumeration of the same nodes
*/
/*@NotNull*/ public AxisIterator getAnother() {
return new SiblingEnumeration(tree, startNode, test, getChildren);
}
public int getProperties() {
return LOOKAHEAD;
}
}