Package org.springframework.batch.item.database

Class JdbcCursorItemReader<T>

  • All Implemented Interfaces:
    ItemReader<T>, ItemStream, ItemStreamReader<T>, org.springframework.beans.factory.InitializingBean
    public class JdbcCursorItemReader<T>
extends AbstractCursorItemReader<T>

    Simple item reader implementation that opens a JDBC cursor and continually retrieves the next row in the ResultSet.

    The statement used to open the cursor is created with the 'READ_ONLY' option since a non read-only cursor may unnecessarily lock tables or rows. It is also opened with 'TYPE_FORWARD_ONLY' option. By default the cursor will be opened using a separate connection which means that it will not participate in any transactions created as part of the step processing.

    Each call to AbstractItemCountingItemStreamItemReader.read() will call the provided RowMapper, passing in the ResultSet.

    Author:
    Lucas Ward, Peter Zozom, Robert Kasanicky, Thomas Risberg

    • Constructor Detail

      • JdbcCursorItemReader

        public JdbcCursorItemReader()

    • Method Detail

      • setRowMapper

        public void setRowMapper​(org.springframework.jdbc.core.RowMapper<T> rowMapper)
        Set the RowMapper to be used for all calls to read().
        Parameters:
        rowMapper - the mapper used to map each item

      • setSql

        public void setSql​(java.lang.String sql)
        Set the SQL statement to be used when creating the cursor. This statement should be a complete and valid SQL statement, as it will be run directly without any modification.
        Parameters:
        sql - SQL statement

      • setPreparedStatementSetter

        public void setPreparedStatementSetter​(org.springframework.jdbc.core.PreparedStatementSetter preparedStatementSetter)
        Set the PreparedStatementSetter to use if any parameter values that need to be set in the supplied query.
        Parameters:
        preparedStatementSetter - PreparedStatementSetter responsible for filling out the statement

      • afterPropertiesSet

        public void afterPropertiesSet()
                        throws java.lang.Exception
        Assert that mandatory properties are set.
        Specified by:
        afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean
        Overrides:
        afterPropertiesSet in class AbstractCursorItemReader<T>
        Throws:
        java.lang.IllegalArgumentException - if either data source or SQL properties not set.
        java.lang.Exception

      • readCursor

        protected T readCursor​(java.sql.ResultSet rs,
                       int currentRow)
                throws java.sql.SQLException
        Description copied from class: AbstractCursorItemReader
        Read the cursor and map to the type of object this reader should return. This method must be overridden by subclasses.
        Specified by:
        readCursor in class AbstractCursorItemReader<T>
        Parameters:
        rs - The current result set
        currentRow - Current position of the result set
        Returns:
        the mapped object at the cursor position
        Throws:
        java.sql.SQLException - if interactions with the current result set fail

      • cleanupOnClose

        protected void cleanupOnClose()
                       throws java.lang.Exception
        Close the cursor and database connection.
        Specified by:
        cleanupOnClose in class AbstractCursorItemReader<T>
        Throws:
        java.lang.Exception