com.hp.hpl.jena.util.iterator
Interface ExtendedIterator

All Superinterfaces:
ClosableIterator, java.util.Iterator
All Known Subinterfaces:
NsIterator, ResIterator, StmtIterator
All Known Implementing Classes:
LazyIterator, NiceIterator, SingletonIterator, TripleMatchIterator

public interface ExtendedIterator
extends ClosableIterator

an ExtendedIterator is a ClosableIterator on which other operations are defined for convenience in iterator composition: composition, filtering in, filtering out, and element mapping.
NOTE that the result of each of these operations consumes the base iterator(s); they do not make independant copies.
The canonical implementation of ExtendedIterator is NiceIterator, which also defines static methods for these operations that will work on any ClosableIterators.

Author:
kers

Method Summary
 ExtendedIterator andThen(ClosableIterator other)
          return a new iterator which delivers all the elements of this iterator and then all the elements of the other iterator.
 ExtendedIterator filterDrop(Filter f)
          return a new iterator containing only the elements of _this_ which are rejected by the filter _f_.
 ExtendedIterator filterKeep(Filter f)
          return a new iterator containing only the elements of _this_ which pass the filter _f_.
 ExtendedIterator mapWith(Map1 map1)
          return a new iterator where each element is the result of applying _map1_ to the corresponding element of _this_.
 
Methods inherited from interface com.hp.hpl.jena.util.iterator.ClosableIterator
close
 
Methods inherited from interface java.util.Iterator
hasNext, next, remove
 

Method Detail

andThen

public ExtendedIterator andThen(ClosableIterator other)
return a new iterator which delivers all the elements of this iterator and then all the elements of the other iterator. Does not copy either iterator; they are consumed as the result iterator is consumed.


filterKeep

public ExtendedIterator filterKeep(Filter f)
return a new iterator containing only the elements of _this_ which pass the filter _f_. The order of the elements is preserved. Does not copy _this_, which is consumed as the result is consumed.


filterDrop

public ExtendedIterator filterDrop(Filter f)
return a new iterator containing only the elements of _this_ which are rejected by the filter _f_. The order of the elements is preserved. Does not copy _this_, which is consumed as the reult is consumed.


mapWith

public ExtendedIterator mapWith(Map1 map1)
return a new iterator where each element is the result of applying _map1_ to the corresponding element of _this_. _this_ is not copied; it is consumed as the result is consumed.



Copyright © 2001-2003 Hewlett-Packard. All Rights Reserved.