net.sf.basedb.core.query
Interface ResultIterator<I>

All Superinterfaces:

Iterator<I>, QueryResult

All Known Subinterfaces:

SqlResultIterator

All Known Implementing Classes:

DataResultIterator, DynamicResultIterator, ItemResultIterator, PlotServlet.CFResultIterator, ReporterScoreResultIterator

public interface ResultIterator<I>
extends QueryResult, Iterator<I>

Return the result of a query as an iterator. An iterator doesn't load the entire dataset into memory at once, it waits until the client application request the next row. This interface is useful for all types of queries and mostly for queries that might return a large number of items.

Implementors should not allow modifications to the iterator, ie. it is not allowed to call the Iterator.remove() method.

Version:

2.0

Author:

Nicklas

Last modified

$Date: 2009-04-06 14:52:39 +0200 (Mon, 06 Apr 2009) $

Method Summary

void	close() Close the iterator and immediately release all resources associated with it.
boolean	isClosed() Check if the iterator has been closed.

Methods inherited from interface net.sf.basedb.core.query.QueryResult

getTotalCount

Methods inherited from interface java.util.Iterator

hasNext, next, remove

Method Detail

close

void close()

Close the iterator and immediately release all resources associated with it.

isClosed

boolean isClosed()

Check if the iterator has been closed.