com.bigdata.btree
Interface ITupleIterator<E>

All Superinterfaces:

Iterator<ITuple<E>>

All Known Subinterfaces:

ITupleCursor<E>, ITupleCursor2<E>, LookaheadTupleFilter.ILookaheadTupleIterator<E>

All Known Implementing Classes:

AbstractBTreeTupleCursor, AbstractBTreeTupleCursor.MutableBTreeTupleCursor, AbstractBTreeTupleCursor.ReadOnlyBTreeTupleCursor, AbstractChunkedTupleIterator, ChunkedLocalRangeIterator, DataServiceTupleIterator, EmptyTupleIterator, FusedTupleCursor, FusedTupleIterator, IndexSegment.IndexSegmentTupleCursor, IndexSegmentMultiBlockIterator, LeafTupleIterator, PartitionedTupleIterator, RawDataServiceTupleIterator, ReadOnlyEntryIterator, Reverserator, TupleFilter.TupleFilterator, TupleUpdater.Updaterator, WrappedTupleIterator

public interface ITupleIterator<E>
extends Iterator<ITuple<E>>

Interface visits ITuples populated with the data and metadata for visited index entries.

Version:

$Id: ITupleIterator.java 2265 2009-10-26 12:51:06Z thompsonbry $

Author:

Bryan Thompson

See Also:

IRangeQuery

Method Summary

ITuple<E>

next() Advance the iterator and return the ITuple from which you can extract the data and metadata for next entry.

Methods inherited from interface java.util.Iterator

hasNext, remove

Method Detail

next

ITuple<E> next()

Advance the iterator and return the ITuple from which you can extract the data and metadata for next entry.

Note: An ITupleIterators will generally return the same ITuple reference on on each invocation of this method. The caller is responsible for copying out any data or metadata of interest before calling next() again. See TupleFilter which is aware of this and can be used to stack filters safely.

Specified by:

next in interface Iterator<ITuple<E>>

Returns:

The ITuple containing the data and metadata for the current index entry.

Throws:

NoSuchElementException - if there is no next entry.