org.apache.xalan.xsltc.dom
Class MultiDOM.AxisIterator

java.lang.Object
  org.apache.xml.dtm.ref.DTMAxisIteratorBase
      org.apache.xalan.xsltc.dom.MultiDOM.AxisIterator

All Implemented Interfaces:

java.lang.Cloneable, DTMAxisIterator

Enclosing class:

MultiDOM

private final class MultiDOM.AxisIterator
extends DTMAxisIteratorBase

Field Summary

private int	_axis
private int	_dtmId
private DTMAxisIterator	_source
private int	_type

Fields inherited from class org.apache.xml.dtm.ref.DTMAxisIteratorBase

_includeSelf, _isRestartable, _last, _markedNode, _position, _startNode

Fields inherited from interface org.apache.xml.dtm.DTMAxisIterator

END

Constructor Summary

MultiDOM.AxisIterator(int axis, int type)

Method Summary

DTMAxisIterator	cloneIterator() Returns a deep copy of this iterator.
int	getLast() Returns the position of the last node within the iteration, as defined by XPath.
int	getPosition()
void	gotoMark() Restores the current node remembered by setMark().
boolean	isReverse()
int	next() Get the next node in the iteration.
DTMAxisIterator	reset() Resets the iterator to the last start node.
void	setMark() Remembers the current node for the next call to gotoMark().
void	setRestartable(boolean flag) Set if restartable.
DTMAxisIterator	setStartNode(int node) Set start to END should 'close' the iterator, i.e.

Methods inherited from class org.apache.xml.dtm.ref.DTMAxisIteratorBase

getAxis, getNodeByPosition, getStartNode, includeSelf, isDocOrdered, resetPosition, returnNode

Methods inherited from class java.lang.Object

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

Field Detail

_axis

private final int _axis

_type

private final int _type

_source

private DTMAxisIterator _source

_dtmId

private int _dtmId

Constructor Detail

MultiDOM.AxisIterator

public MultiDOM.AxisIterator(int axis,
                             int type)

Method Detail

next

public int next()

Description copied from interface: DTMAxisIterator

Get the next node in the iteration.

Returns:

The next node handle in the iteration, or END.

setRestartable

public void setRestartable(boolean flag)

Description copied from interface: DTMAxisIterator

Set if restartable.

Specified by:

setRestartable in interface DTMAxisIterator

Overrides:

setRestartable in class DTMAxisIteratorBase

setStartNode

public DTMAxisIterator setStartNode(int node)

Description copied from interface: DTMAxisIterator

Set start to END should 'close' the iterator, i.e. subsequent call to next() should return END.

Parameters:

node - Sets the root of the iteration.

Returns:

A DTMAxisIterator set to the start of the iteration.

reset

public DTMAxisIterator reset()

Description copied from interface: DTMAxisIterator

Resets the iterator to the last start node.

Specified by:

reset in interface DTMAxisIterator

Overrides:

reset in class DTMAxisIteratorBase

Returns:

A DTMAxisIterator which has been reset to the start node, which may or may not be the same as this iterator.

getLast

public int getLast()

Description copied from class: DTMAxisIteratorBase

Returns the position of the last node within the iteration, as defined by XPath. In a forward iterator, I believe this equals the number of nodes which this iterator will yield. In a reverse iterator, I believe it should return 1 (since the "last" is the first produced.) This may be an expensive operation when called the first time, since it may have to iterate through a large part of the document to produce its answer.

Specified by:

getLast in interface DTMAxisIterator

Overrides:

getLast in class DTMAxisIteratorBase

Returns:

The number of nodes in this iterator (forward) or 1 (reverse).

getPosition

public int getPosition()

Specified by:

getPosition in interface DTMAxisIterator

Overrides:

getPosition in class DTMAxisIteratorBase

Returns:

The position of the current node within the set, as defined by XPath. Note that this is one-based, not zero-based.

isReverse

public boolean isReverse()

Specified by:

isReverse in interface DTMAxisIterator

Overrides:

isReverse in class DTMAxisIteratorBase

Returns:

true if this iterator has a reversed axis, else false

setMark

public void setMark()

Description copied from interface: DTMAxisIterator

Remembers the current node for the next call to gotoMark().

gotoMark

public void gotoMark()

Description copied from interface: DTMAxisIterator

Restores the current node remembered by setMark().

cloneIterator

public DTMAxisIterator cloneIterator()

Description copied from class: DTMAxisIteratorBase

Returns a deep copy of this iterator. Cloned iterators may not be restartable. The iterator being cloned may or may not become non-restartable as a side effect of this operation.

Specified by:

cloneIterator in interface DTMAxisIterator

Overrides:

cloneIterator in class DTMAxisIteratorBase

Returns:

a deep copy of this iterator.