HibernatePagingItemReader (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.AbstractPagingItemReader<T>
      - org.springframework.batch.item.database.HibernatePagingItemReader<T>

実装されたすべてのインターフェース:
ItemReader<T>, ItemStream, ItemStreamReader<T>, org.springframework.beans.factory.InitializingBean
```
public class HibernatePagingItemReader<T>
extends AbstractPagingItemReader<T>
implements org.springframework.beans.factory.InitializingBean
```
Hibernate 上に構築されたデータベースレコードを読み取り、一度に最大数のアイテムのみを読み取るための ItemReader。AbstractItemCountingItemStreamItemReader.read() メソッドが呼び出されると、初期化されたページング時に HQL クエリが実行されます。クエリは setQueryString(String) を使用して直接設定するか、名前付きクエリを setQueryName(String) で使用するか、クエリプロバイダー戦略を setQueryProvider(HibernateQueryProvider) を介して提供することができます。
リーダーは、関連付けられたオブジェクトにカスケードする必要のない単純なマッピングに十分な StatelessSession、またはより高度なマッピングまたはキャッシュが必要な場合に標準の休止状態の Session を使用するように構成できます。ステートフルセッションが使用されると、フラッシュされずに AbstractItemCountingItemStreamItemReader.update(ExecutionContext) メソッドでクリアされます（データの変更は予期されません）。
実装は AbstractItemCountingItemStreamItemReader.open(ExecutionContext) の呼び出し間でスレッドセーフですが、マルチスレッドクライアントで使用する場合は saveState=false を使用することを忘れないでください（再起動は利用できません）。
導入:
2.1
作成者:
Dave Syer

フィールドサマリー
- クラス org.springframework.batch.item.database.AbstractPagingItemReader から継承されたフィールド
  logger, results

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

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

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`afterPropertiesSet()` 必須プロパティを確認してください。
`protected void`	`doClose()` `AbstractItemCountingItemStreamItemReader.doOpen()` で開いたリソースを閉じます。
`protected void`	`doJumpToPage(int itemIndex)`
`protected void`	`doOpen()` 入力の読み取りを開始するために必要なリソースを開きます。
`protected void`	`doReadPage()`
`void`	`setFetchSize(int fetchSize)` Hibernate が内部で使用するフェッチサイズ。ラウンドトリップごとにデータベースからフェッチされるデータの量を制限します。
`void`	`setParameterValues(java.util.Map<java.lang.String,java.lang.Object> parameterValues)` クエリに適用するパラメーター値（name:value のマップ）。
`void`	`setQueryName(java.lang.String queryName)` 外部化されたクエリのクエリ名。
`void`	`setQueryProvider(HibernateQueryProvider<? extends T> queryProvider)` クエリプロバイダー。
`void`	`setQueryString(java.lang.String queryString)` HQL のクエリ文字列。
`void`	`setSessionFactory(org.hibernate.SessionFactory sessionFactory)` Hibernate SessionFactory を使用してセッションを作成します。
`void`	`setUseStatelessSession(boolean useStatelessSession)` 初期化されていない状態でのみ設定できます。

クラス org.springframework.batch.item.database.AbstractPagingItemReader から継承されたメソッド
doRead, getPage, getPageSize, jumpToItem, setPageSize

クラス 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

- コンストラクターの詳細
  - HibernatePagingItemReader
```
public HibernatePagingItemReader()
```
- メソッドの詳細
  - setParameterValues
```
public void setParameterValues(java.util.Map<java.lang.String,java.lang.Object> parameterValues)
```
    クエリに適用するパラメーター値（name:value のマップ）。
    パラメーター:
    parameterValues - 設定するパラメーター値
  - setQueryName
```
public void setQueryName(java.lang.String queryName)
```
    外部化されたクエリのクエリ名。これまたは {query string または {query provider のいずれかを設定する必要があります。
    パラメーター:
    queryName - 休止状態の名前付きクエリの名前
  - setFetchSize
```
public void setFetchSize(int fetchSize)
```
    Hibernate が内部で使用するフェッチサイズ。ラウンドトリップごとにデータベースからフェッチされるデータの量を制限します。
    パラメーター:
    fetchSize - Hibernate に渡すフェッチサイズ
  - setQueryProvider
```
public void setQueryProvider(HibernateQueryProvider<? extends T> queryProvider)
```
    クエリプロバイダー。これまたは {query string または {query name のいずれかを設定する必要があります。
    パラメーター:
    queryProvider - Hibernate クエリプロバイダー
  - setQueryString
```
public void setQueryString(java.lang.String queryString)
```
    HQL のクエリ文字列。これまたは {query provider または {query name のいずれかを設定する必要があります。
    パラメーター:
    queryString - HQL クエリ文字列
  - setSessionFactory
```
public void setSessionFactory(org.hibernate.SessionFactory sessionFactory)
```
    Hibernate SessionFactory を使用してセッションを作成します。
    パラメーター:
    sessionFactory - 設定する SessionFactory
  - setUseStatelessSession
```
public void setUseStatelessSession(boolean useStatelessSession)
```
    初期化されていない状態でのみ設定できます。
    パラメーター:
    useStatelessSession - true は StatelessSession を使用します。false は標準の休止状態 Session を使用します
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws java.lang.Exception
```
    クラスからコピーされた説明: AbstractPagingItemReader
    必須プロパティを確認してください。
    次で指定:
    インターフェース org.springframework.beans.factory.InitializingBean の afterPropertiesSet
    オーバーライド:
    クラス AbstractPagingItemReader<T> の afterPropertiesSet
    例外:
    java.lang.Exception
    関連事項:
    InitializingBean.afterPropertiesSet()
  - doOpen
```
protected void doOpen()
               throws java.lang.Exception
```
    クラスからコピーされた説明: AbstractItemCountingItemStreamItemReader
    入力の読み取りを開始するために必要なリソースを開きます。
    オーバーライド:
    クラス AbstractPagingItemReader<T> の doOpen
    例外:
    java.lang.Exception - サブクラスがフレームワークによる解釈のためにチェック済み例外をスローできるようにします
  - doReadPage
```
protected void doReadPage()
```
    次で指定:
    クラス AbstractPagingItemReader<T> の doReadPage
  - doJumpToPage
```
protected void doJumpToPage(int itemIndex)
```
    次で指定:
    クラス AbstractPagingItemReader<T> の doJumpToPage
  - doClose
```
protected void doClose()
                throws java.lang.Exception
```
    クラスからコピーされた説明: AbstractItemCountingItemStreamItemReader
    AbstractItemCountingItemStreamItemReader.doOpen() で開いたリソースを閉じます。
    オーバーライド:
    クラス AbstractPagingItemReader<T> の doClose
    例外:
    java.lang.Exception - サブクラスがフレームワークによる解釈のためにチェック済み例外をスローできるようにします

クラス HibernatePagingItemReader<T>

フィールドサマリー

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

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

メソッドのサマリー

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

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

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

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

コンストラクターの詳細

HibernatePagingItemReader

メソッドの詳細

setParameterValues

setQueryName

setFetchSize

setQueryProvider

setQueryString

setSessionFactory

setUseStatelessSession

afterPropertiesSet

doOpen

doReadPage

doJumpToPage

doClose