org.apache.xalan.xsltc.dom
Class FilterIterator

java.lang.Object
  extended by org.apache.xml.dtm.ref.DTMAxisIteratorBase
      extended by org.apache.xalan.xsltc.dom.FilterIterator
All Implemented Interfaces:
java.lang.Cloneable, DTMAxisIterator

public final class FilterIterator
extends DTMAxisIteratorBase

Similar to a CurrentNodeListIterator except that the filter has a simpler interface (only needs the node, no position, last, etc.) It takes a source iterator and a Filter object and returns nodes from the source after filtering them by calling filter.test(node).


Field Summary
private  DTMFilter _filter
          Reference to a filter object that to be applied to each node.
private  boolean _isReverse
          A flag indicating if position is reversed.
private  DTMAxisIterator _source
          Reference to source iterator.
 
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
FilterIterator(DTMAxisIterator source, DTMFilter filter)
           
 
Method Summary
 DTMAxisIterator cloneIterator()
          Returns a deep copy of this iterator.
 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 isRestartable)
          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, getLast, getNodeByPosition, getPosition, 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

_source

private DTMAxisIterator _source
Reference to source iterator.


_filter

private final DTMFilter _filter
Reference to a filter object that to be applied to each node.


_isReverse

private final boolean _isReverse
A flag indicating if position is reversed.

Constructor Detail

FilterIterator

public FilterIterator(DTMAxisIterator source,
                      DTMFilter filter)
Method Detail

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

setRestartable

public void setRestartable(boolean isRestartable)
Description copied from interface: DTMAxisIterator
Set if restartable.

Specified by:
setRestartable in interface DTMAxisIterator
Overrides:
setRestartable in class DTMAxisIteratorBase

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.

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.

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.

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.

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