com.feedzai.commons.sql.abstraction.dml.result

Class ResultIterator

java.lang.Object

com.feedzai.commons.sql.abstraction.dml.result.ResultIterator

Direct Known Subclasses:

DB2ResultIterator, H2ResultIterator, MySqlResultIterator, OracleResultIterator, PostgreSqlResultIterator, SqlServerResultIterator

public abstract class ResultIterator
extends Object

The abstract result iterator. Extending classes will create the specific ResultColumn implementation given the engine in place.

Since:

2.0.0

Author:

Rui Vilao (rui.vilao@feedzai.com)

Constructor Summary

Constructors

Constructor and Description
ResultIterator(PreparedStatement statement) Creates a new instance of ResultIterator for PreparedStatement.
ResultIterator(Statement statement, String sql) Creates a new instance of ResultIterator for regular Statement.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the ResultSet and the Statement if applicable.
abstract ResultColumn	createResultColumn(String name, Object value) Creates a ResultColumn for the given engine in place.
boolean	isClosed() Checks if this result iterator is closed.
Map<String,ResultColumn>	next() Retrieves the next row in the result set.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ResultIterator

public ResultIterator(Statement statement,
              String sql)
               throws DatabaseEngineException

Creates a new instance of ResultIterator for regular Statement.

Parameters:

statement - The statement.

sql - The SQL sentence.

Throws:

DatabaseEngineException - If a database access error occurs.

ResultIterator

public ResultIterator(PreparedStatement statement)
               throws DatabaseEngineException

Creates a new instance of ResultIterator for PreparedStatement.

Parameters:

statement - The prepared statement.

Throws:

DatabaseEngineException - If a database access error occurs.

Method Detail

next

public Map<String,ResultColumn> next()
                              throws DatabaseEngineException

Retrieves the next row in the result set.

This method also closes the result set upon the last call on the result set.

If the statement in place is not a PreparedStatement it also closes the statement.

If an exception is thrown the calling thread is responsible for repeating the action in place.

Returns:

The result row.

Throws:

DatabaseEngineException - If a database access error occurs.

isClosed

public boolean isClosed()

Checks if this result iterator is closed.

Returns:

true if the result set is closed, false otherwise.

close

public void close()

Closes the ResultSet and the Statement if applicable.

createResultColumn

public abstract ResultColumn createResultColumn(String name,
                              Object value)

Creates a ResultColumn for the given engine in place.

Parameters:

name - The name of the column.

value - The value on the column.

Returns:

A specific result column given the implementation.