JdbcCursorItemReader (Spring Batch API)

java.lang.Object
- org.springframework.batch.item.ItemStreamSupport
- - org.springframework.batch.item.support.AbstractItemStreamItemReader<T>
  - - org.springframework.batch.item.support.AbstractItemCountingItemStreamItemReader<T>
    - - org.springframework.batch.item.database.AbstractCursorItemReader<T>
      - org.springframework.batch.item.database.JdbcCursorItemReader<T>

実装されたすべてのインターフェース:
ItemReader<T>, ItemStream, ItemStreamReader<T>, org.springframework.beans.factory.InitializingBean
```
public class JdbcCursorItemReader<T>
extends AbstractCursorItemReader<T>
```
JDBC カーソルを開き、ResultSet の次の行を継続的に取得する単純なアイテムリーダーの実装。
非読み取り専用カーソルはテーブルまたは行を不必要にロックする可能性があるため、カーソルを開くために使用されるステートメントは "READ_ONLY" オプションで作成されます。また、"TYPE_FORWARD_ONLY" オプションで開かれます。デフォルトでは、カーソルは別の接続を使用して開かれます。つまり、ステップ処理の一部として作成されたトランザクションには参加しません。
AbstractItemCountingItemStreamItemReader.read() への各呼び出しは、提供された RowMapper を呼び出し、ResultSet を渡します。
作成者:
Lucas Ward, Peter Zozom, Robert Kasanicky, Thomas Risberg, Mahmoud Ben Hassine

フィールドサマリー
- クラス org.springframework.batch.item.database.AbstractCursorItemReader から継承されたフィールド
  log, rs, VALUE_NOT_SET

コンストラクターのサマリー
コンストラクター
コンストラクターと説明
JdbcCursorItemReader()

コンストラクター
コンストラクターと説明
`JdbcCursorItemReader()`

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド非推奨のメソッド
修飾子と型	メソッドと説明
`void`	`afterPropertiesSet()` 必須プロパティが設定されていることを確認します。
`protected void`	`cleanupOnClose()` 使用すべきではありません。このメソッドは `cleanupOnClose(java.sql.Connection)` を優先して非推奨になり、将来のリリースで削除される予定です。
`protected void`	`cleanupOnClose(java.sql.Connection connection)` カーソルとデータベース接続を閉じます。
`java.lang.String`	`getSql()`
`protected void`	`openCursor(java.sql.Connection con)`
`protected T`	`readCursor(java.sql.ResultSet rs, int currentRow)` カーソルを読み取り、このリーダーが返すオブジェクトの型にマッピングします。
`void`	`setPreparedStatementSetter(org.springframework.jdbc.core.PreparedStatementSetter preparedStatementSetter)` 指定されたクエリで設定する必要があるパラメーター値がある場合に使用する PreparedStatementSetter を設定します。
`void`	`setRowMapper(org.springframework.jdbc.core.RowMapper<T> rowMapper)` read() へのすべての呼び出しに使用される RowMapper を設定します。
`void`	`setSql(java.lang.String sql)` カーソルの作成時に使用される SQL ステートメントを設定します。

クラス org.springframework.batch.item.database.AbstractCursorItemReader から継承されたメソッド
applyStatementSettings, doClose, doOpen, doRead, getDataSource, getExceptionTranslator, handleWarnings, initializeConnection, isUseSharedExtendedConnection, jumpToItem, setConnectionAutoCommit, setDataSource, setDriverSupportsAbsolute, setFetchSize, setIgnoreWarnings, setMaxRows, setQueryTimeout, setUseSharedExtendedConnection, setVerifyCursorPosition, translateSqlException

クラス org.springframework.batch.item.support.AbstractItemCountingItemStreamItemReader から継承されたメソッド
close, getCurrentItemCount, isSaveState, open, read, setCurrentItemCount, setMaxItemCount, setSaveState, update

クラス org.springframework.batch.item.ItemStreamSupport から継承されたメソッド
getExecutionContextKey, setExecutionContextName, setName

クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクターの詳細
  - JdbcCursorItemReader
```
public JdbcCursorItemReader()
```
- メソッドの詳細
  - setRowMapper
```
public void setRowMapper(org.springframework.jdbc.core.RowMapper<T> rowMapper)
```
    read() へのすべての呼び出しに使用される RowMapper を設定します。
    パラメーター:
    rowMapper - 各アイテムのマッピングに使用されるマッパー
  - setSql
```
public void setSql(java.lang.String sql)
```
    カーソルの作成時に使用される SQL ステートメントを設定します。このステートメントは、変更なしで直接実行されるため、完全で有効な SQL ステートメントである必要があります。
    パラメーター:
    sql - SQL ステートメント
  - setPreparedStatementSetter
```
public void setPreparedStatementSetter(org.springframework.jdbc.core.PreparedStatementSetter preparedStatementSetter)
```
    指定されたクエリで設定する必要があるパラメーター値がある場合に使用する PreparedStatementSetter を設定します。
    パラメーター:
    preparedStatementSetter - ステートメントの記入を担当する PreparedStatementSetter
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws java.lang.Exception
```
    必須プロパティが設定されていることを確認します。
    次で指定:
    インターフェース org.springframework.beans.factory.InitializingBean の afterPropertiesSet
    オーバーライド:
    クラス AbstractCursorItemReader<T> の afterPropertiesSet
    例外:
    java.lang.IllegalArgumentException - データソースまたは SQL プロパティが設定されていない場合。
    java.lang.Exception
  - openCursor
```
protected void openCursor(java.sql.Connection con)
```
    次で指定:
    クラス AbstractCursorItemReader<T> の openCursor
  - readCursor
```
@Nullable
protected T readCursor(java.sql.ResultSet rs,
                                 int currentRow)
                          throws java.sql.SQLException
```
    クラスからコピーされた説明: AbstractCursorItemReader
    カーソルを読み取り、このリーダーが返すオブジェクトの型にマッピングします。このメソッドはサブクラスでオーバーライドする必要があります。
    次で指定:
    クラス AbstractCursorItemReader<T> の readCursor
    パラメーター:
    rs - 現在の結果セット
    currentRow - 結果セットの現在の位置
    戻り値:
    カーソル位置のマップされたオブジェクト
    例外:
    java.sql.SQLException - 現在の結果セットとの相互作用が失敗した場合
  - cleanupOnClose
```
@Deprecated
protected void cleanupOnClose()
                                   throws java.lang.Exception
```
    非推奨。このメソッドは cleanupOnClose(java.sql.Connection) を優先して非推奨になり、将来のリリースで削除される予定です。
    カーソルとデータベース接続を閉じます。
    次で指定:
    クラス AbstractCursorItemReader<T> の cleanupOnClose
    例外:
    java.lang.Exception - リソースをクリーンアップできない場合
  - cleanupOnClose
```
protected void cleanupOnClose(java.sql.Connection connection)
                       throws java.lang.Exception
```
    カーソルとデータベース接続を閉じます。
    次で指定:
    クラス AbstractCursorItemReader<T> の cleanupOnClose
    パラメーター:
    connection - データベースへ
    例外:
    java.lang.Exception - リソースをクリーンアップできない場合
  - getSql
```
public java.lang.String getSql()
```
    次で指定:
    クラス AbstractCursorItemReader<T> の getSql

クラス JdbcCursorItemReader<T>

フィールドサマリー

クラス org.springframework.batch.item.database.AbstractCursorItemReader から継承されたフィールド

コンストラクターのサマリー

メソッドのサマリー

クラス org.springframework.batch.item.database.AbstractCursorItemReader から継承されたメソッド

クラス org.springframework.batch.item.support.AbstractItemCountingItemStreamItemReader から継承されたメソッド

クラス org.springframework.batch.item.ItemStreamSupport から継承されたメソッド

クラス java.lang.Object から継承されたメソッド

コンストラクターの詳細

JdbcCursorItemReader

メソッドの詳細

setRowMapper

setSql

setPreparedStatementSetter

afterPropertiesSet

openCursor

readCursor

cleanupOnClose

cleanupOnClose

getSql