类 AbstractCursorItemReader<T>

字段详细资料

• log

  protected final org.apache.commons.logging.Log log

  Logger available to subclasses

• VALUE_NOT_SET

  public static final int VALUE_NOT_SET

  另请参阅:

  常量字段值

• rs

  protected java.sql.ResultSet rs

构造器详细资料

• AbstractCursorItemReader

  public AbstractCursorItemReader()

方法详细资料

• afterPropertiesSet

  public void afterPropertiesSet()
                          throws java.lang.Exception

  Assert that mandatory properties are set.

  指定者:

  afterPropertiesSet 在接口中 org.springframework.beans.factory.InitializingBean

  抛出:

  java.lang.IllegalArgumentException - if either data source or SQL properties not set.

  java.lang.Exception

• setDataSource

  public void setDataSource​(javax.sql.DataSource dataSource)

  Public setter for the data source for injection purposes.

  参数:

  dataSource - DataSource to be used

• getDataSource

  public javax.sql.DataSource getDataSource()

  Public getter for the data source.

  返回:

  the dataSource

• applyStatementSettings

  protected void applyStatementSettings​(java.sql.PreparedStatement stmt)
                                 throws java.sql.SQLException

  Prepare the given JDBC Statement (or PreparedStatement or CallableStatement), applying statement settings such as fetch size, max rows, and query timeout. @param stmt the JDBC Statement to prepare

  参数:

  stmt - PreparedStatement to be configured

  抛出:

  java.sql.SQLException - if interactions with provided stmt fail

  另请参阅:

  setFetchSize(int), setMaxRows(int), setQueryTimeout(int)

• getExceptionTranslator

  protected org.springframework.jdbc.support.SQLExceptionTranslator getExceptionTranslator()

  Creates a default SQLErrorCodeSQLExceptionTranslator for the specified DataSource if none is set.

  返回:

  the exception translator for this instance.

• handleWarnings

  protected void handleWarnings​(java.sql.Statement statement)
                         throws org.springframework.jdbc.SQLWarningException,
                                java.sql.SQLException

  Throw a SQLWarningException if we're not ignoring warnings, else log the warnings (at debug level).

  参数:

  statement - the current statement to obtain the warnings from, if there are any.

  抛出:

  java.sql.SQLException - if interaction with provided statement fails.

  org.springframework.jdbc.SQLWarningException

  另请参阅:

  SQLWarningException

• setFetchSize

  public void setFetchSize​(int fetchSize)

  Gives the JDBC driver a hint as to the number of rows that should be fetched from the database when more rows are needed for this ResultSet object. If the fetch size specified is zero, the JDBC driver ignores the value.

  参数:

  fetchSize - the number of rows to fetch

  另请参阅:

  ResultSet.setFetchSize(int)

• setMaxRows

  public void setMaxRows​(int maxRows)

  Sets the limit for the maximum number of rows that any ResultSet object can contain to the given number.

  参数:

  maxRows - the new max rows limit; zero means there is no limit

  另请参阅:

  Statement.setMaxRows(int)

• setQueryTimeout

  public void setQueryTimeout​(int queryTimeout)

  Sets the number of seconds the driver will wait for a Statement object to execute to the given number of seconds. If the limit is exceeded, an SQLException is thrown.

  参数:

  queryTimeout - seconds the new query timeout limit in seconds; zero means there is no limit

  另请参阅:

  Statement.setQueryTimeout(int)

• setIgnoreWarnings

  public void setIgnoreWarnings​(boolean ignoreWarnings)

  Set whether SQLWarnings should be ignored (only logged) or exception should be thrown.

  参数:

  ignoreWarnings - if TRUE, warnings are ignored

• setVerifyCursorPosition

  public void setVerifyCursorPosition​(boolean verifyCursorPosition)

  Allow verification of cursor position after current row is processed by RowMapper or RowCallbackHandler. Default value is TRUE.

  参数:

  verifyCursorPosition - if true, cursor position is verified

• setDriverSupportsAbsolute

  public void setDriverSupportsAbsolute​(boolean driverSupportsAbsolute)

  Indicate whether the JDBC driver supports setting the absolute row on a ResultSet. It is recommended that this is set to true for JDBC drivers that supports ResultSet.absolute() as it may improve performance, especially if a step fails while working with a large data set.

  参数:

  driverSupportsAbsolute - false by default

  另请参阅:

  ResultSet.absolute(int)

• setUseSharedExtendedConnection

  public void setUseSharedExtendedConnection​(boolean useSharedExtendedConnection)

  Indicate whether the connection used for the cursor should be used by all other processing thus sharing the same transaction. If this is set to false, which is the default, then the cursor will be opened using in its connection and will not participate in any transactions started for the rest of the step processing. If you set this flag to true then you must wrap the DataSource in a ExtendedConnectionDataSourceProxy to prevent the connection from being closed and released after each commit. When you set this option to true then the statement used to open the cursor will be created with both 'READ_ONLY' and 'HOLD_CURSORS_OVER_COMMIT' options. This allows holding the cursor open over transaction start and commits performed in the step processing. To use this feature you need a database that supports this and a JDBC driver supporting JDBC 3.0 or later.

  参数:

  useSharedExtendedConnection - false by default

• isUseSharedExtendedConnection

  public boolean isUseSharedExtendedConnection()

• setConnectionAutoCommit

  public void setConnectionAutoCommit​(boolean autoCommit)

  Set whether "autoCommit" should be overridden for the connection used by the cursor. If not set, defaults to Connection / Datasource default configuration.

  参数:

  autoCommit - value used for Connection.setAutoCommit(boolean).

  从以下版本开始:

  4.0

• getSql

  public abstract java.lang.String getSql()

• doClose

  protected void doClose()
                  throws java.lang.Exception

  Close the cursor and database connection. Make call to cleanupOnClose so sub classes can cleanup any resources they have allocated.

  指定者:

  doClose 在类中 AbstractItemCountingItemStreamItemReader<T>

  抛出:

  java.lang.Exception - Allows subclasses to throw checked exceptions for interpretation by the framework

• cleanupOnClose

  protected abstract void cleanupOnClose()
                                  throws java.lang.Exception

  抛出:

  java.lang.Exception

• doOpen

  protected void doOpen()
                 throws java.lang.Exception

  Execute the statement to open the cursor.

  指定者:

  doOpen 在类中 AbstractItemCountingItemStreamItemReader<T>

  抛出:

  java.lang.Exception - Allows subclasses to throw checked exceptions for interpretation by the framework

• initializeConnection

  protected void initializeConnection()

• openCursor

  protected abstract void openCursor​(java.sql.Connection con)

• doRead

  protected T doRead()
              throws java.lang.Exception

  Read next row and map it to item, verify cursor position if setVerifyCursorPosition(boolean) is true.

  指定者:

  doRead 在类中 AbstractItemCountingItemStreamItemReader<T>

  返回:

  an item or null if the data source is exhausted

  抛出:

  java.lang.Exception - Allows subclasses to throw checked exceptions for interpretation by the framework

• readCursor

  @Nullable
  protected abstract T readCursor​(java.sql.ResultSet rs,
                                  int currentRow)
                           throws java.sql.SQLException

  Read the cursor and map to the type of object this reader should return. This method must be overridden by subclasses.

  参数:

  rs - The current result set

  currentRow - Current position of the result set

  返回:

  the mapped object at the cursor position

  抛出:

  java.sql.SQLException - if interactions with the current result set fail

• jumpToItem

  protected void jumpToItem​(int itemIndex)
                     throws java.lang.Exception

  Use ResultSet.absolute(int) if possible, otherwise scroll by calling ResultSet.next().

  覆盖:

  jumpToItem 在类中 AbstractItemCountingItemStreamItemReader<T>

  参数:

  itemIndex - index of item (0 based) to jump to.

  抛出:

  java.lang.Exception - Allows subclasses to throw checked exceptions for interpretation by the framework