net.sf.saxon.tree.wrapper

Class VirtualCopy.VirtualCopier

java.lang.Object

net.sf.saxon.tree.wrapper.VirtualCopy.VirtualCopier

All Implemented Interfaces:

SequenceIterator, AxisIterator, UnfailingIterator

Direct Known Subclasses:

VirtualUntypedCopy.VirtualUntypedCopier

Enclosing class:

VirtualCopy

protected class VirtualCopy.VirtualCopier
extends Object
implements AxisIterator

VirtualCopier implements the XPath axes as applied to a VirtualCopy node. It works by applying the requested axis to the node of which this is a copy. There are two complications: firstly, all nodes encountered must themselves be (virtually) copied to give them a new identity. Secondly, axes that stray outside the subtree rooted at the original copied node must be truncated.

Field Summary

Fields

Modifier and Type	Field and Description
protected AxisIterator	base
protected NodeInfo	subtreeRoot

Fields inherited from interface net.sf.saxon.om.SequenceIterator

ATOMIZING, GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD

Constructor Summary

Constructors

Constructor and Description
VirtualCopy.VirtualCopier(AxisIterator base, VirtualCopy parent, NodeInfo subtreeRoot)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close the iterator.
protected VirtualCopy	createCopy(NodeInfo node, NodeInfo root) Method to create the virtual copy of a node encountered when navigating.
AxisIterator	getAnother() Get another iterator over the same sequence of items, positioned at the start of the sequence
int	getProperties() Get properties of this iterator, as a bit-significant integer.
NodeInfo	next() Get the next item in the sequence.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

base

protected AxisIterator base

subtreeRoot

protected NodeInfo subtreeRoot

Constructor Detail

VirtualCopy.VirtualCopier

public VirtualCopy.VirtualCopier(AxisIterator base,
                         VirtualCopy parent,
                         NodeInfo subtreeRoot)

Method Detail

next

public NodeInfo next()

Get the next item in the sequence.

Specified by:

next in interface SequenceIterator

Specified by:

next in interface AxisIterator

Specified by:

next in interface UnfailingIterator

Returns:

the next Item. If there are no more nodes, return null.

close

public void close()

Description copied from interface: SequenceIterator

Close the iterator. This indicates to the supplier of the data that the client does not require any more items to be delivered by the iterator. This may enable the supplier to release resources. After calling close(), no further calls on the iterator should be made; if further calls are made, the effect of such calls is undefined.

(Currently, closing an iterator is important only when the data is being "pushed" in another thread. Closing the iterator terminates that thread and means that it needs to do no additional work. Indeed, failing to close the iterator may cause the push thread to hang waiting for the buffer to be emptied.)

Specified by:

close in interface SequenceIterator

getAnother

public AxisIterator getAnother()

Get another iterator over the same sequence of items, positioned at the start of the sequence

Specified by:

getAnother in interface SequenceIterator

Specified by:

getAnother in interface AxisIterator

Specified by:

getAnother in interface UnfailingIterator

Returns:

a new iterator over the same sequence

getProperties

public int getProperties()

Get properties of this iterator, as a bit-significant integer.

Specified by:

getProperties in interface SequenceIterator

Returns:

the properties of this iterator. This will be some combination of properties such as SequenceIterator.GROUNDED, SequenceIterator.LAST_POSITION_FINDER, and SequenceIterator.LOOKAHEAD. It is always acceptable to return the value zero, indicating that there are no known special properties. It is acceptable for the properties of the iterator to change depending on its state.

createCopy

protected VirtualCopy createCopy(NodeInfo node,
                     NodeInfo root)

Method to create the virtual copy of a node encountered when navigating. This method is separated out so that it can be overridden in a subclass.

Parameters:

node - the node to be copied

root - the root of the tree

Returns:

the virtual copy