org.sqlproc.engine.SqlRowProcessor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sql-processor Show documentation

SQL Processor - Data Driven Queries

There is a newer version: 3.6.1

package org.sqlproc.engine;

import org.sqlproc.engine.annotation.Beta;

/**
 * A callback to be used with the cursor based queries.
 * 
 * 
 * {@link #processRow} will be called for each database row that is read, and should return {@code false} when you want
 * to stop processing. It is utilized by
 * {@link SqlQueryEngine#query(SqlSession, Class, Object, SqlControl, SqlRowProcessor)}.
 * 
 * 
 * For more info please see the Tutorials.
 * 
 * @author Vladimir Hudec
 */
@Beta
public interface SqlRowProcessor {

    /**
     * This method will be called once for database row.
     *
     * @param result
     *            The result class instance. The object representation of the database row.
     * @param rownum
     *            The database row number starting from 1.
     * @return True to continue processing, false to stop.
     */
    boolean processRow(E result, int rownum) throws SqlRuntimeException;
}