org.apache.commons.dbutils
Class ResultSetIterator

java.lang.Object
  extended by org.apache.commons.dbutils.ResultSetIterator
All Implemented Interfaces:
java.util.Iterator

public class ResultSetIterator
extends java.lang.Object
implements java.util.Iterator

Wraps a ResultSet in an Iterator. This is useful when you want to present a non-database application layer with domain neutral data.

This implementation requires the ResultSet.isLast() method to be implemented.

Author:
Henri Yandell, David Graham

Field Summary
private  RowProcessor convert
          The processor to use when converting a row into an Object[].
private  java.sql.ResultSet rs
          The wrapped ResultSet.
 
Constructor Summary
ResultSetIterator(java.sql.ResultSet rs)
          Constructor for ResultSetIterator.
ResultSetIterator(java.sql.ResultSet rs, RowProcessor convert)
          Constructor for ResultSetIterator.
 
Method Summary
 boolean hasNext()
           
 java.lang.Object next()
          Returns the next row as an Object[].
 void remove()
          Deletes the current row from the ResultSet.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

rs

private java.sql.ResultSet rs
The wrapped ResultSet.


convert

private RowProcessor convert
The processor to use when converting a row into an Object[].

Constructor Detail

ResultSetIterator

public ResultSetIterator(java.sql.ResultSet rs)
Constructor for ResultSetIterator.

Parameters:
rs - Wrap this ResultSet in an Iterator.

ResultSetIterator

public ResultSetIterator(java.sql.ResultSet rs,
                         RowProcessor convert)
Constructor for ResultSetIterator.

Parameters:
rs - Wrap this ResultSet in an Iterator.
convert - The processor to use when converting a row into an Object[]. Defaults to a BasicRowProcessor.
Method Detail

hasNext

public boolean hasNext()
Specified by:
hasNext in interface java.util.Iterator

next

public java.lang.Object next()
Returns the next row as an Object[].

Specified by:
next in interface java.util.Iterator
Returns:
An Object[] with the same number of elements as columns in the ResultSet.
See Also:
Iterator.next()

remove

public void remove()
Deletes the current row from the ResultSet.

Specified by:
remove in interface java.util.Iterator
See Also:
Iterator.remove()