sqlj.runtime
Interface NamedIterator

All Superinterfaces:

ResultSetIterator

public interface NamedIterator

extends ResultSetIterator

An interface implemented by all iterators that employ a by-name binding strategy. All such iterators depend on the name of the columns of the data to which they are bound, as opposed to the order of the columns to which they are bound.

In addition to implementing this interface, name-bound iterator implementations will provide:

• A public constructor which takes an RTResultSet object as a parameter. If the construction of a named iterator results in an exception being thrown, it is assumed that the iterator automatically closes the underlying result set. This only applies to exceptions thrown during construction. This constructor is for internal use of the SQLJ runtime only. Please use the SQLJ CAST command instead.
• An accessor method for each column in the expected result. The name of the accessor method will match the expected name of the result column.

A common usage of a NamedIterator is as follows:

#sql iterator StringIter(String the_value);

[...]

IntIter namedIter;


#sql [ctx] namedIter = { SELECT the_value FROM tab WHERE the_key = 1 };

try {
    while (namedIter.next()) {
        String val = namedIter.the_value();
        [...]
    } 
} finally {
    namedIter.close();
}

See Also:

PositionedIterator, ResultSetIterator

Fields inherited from interface sqlj.runtime.ResultSetIterator

ASENSITIVE, FETCH_FORWARD, FETCH_REVERSE, FETCH_UNKNOWN, INSENSITIVE, SENSITIVE

Methods inherited from interface sqlj.runtime.ResultSetIterator

clearWarnings, close, getFetchSize, getResultSet, getRow, getSensitivity, getWarnings, isClosed, next, setFetchSize