LdifReader (Spring Batch API)

java.lang.Object
- org.springframework.batch.item.ItemStreamSupport
- - org.springframework.batch.item.support.AbstractItemStreamItemReader<T>
  - - org.springframework.batch.item.support.AbstractItemCountingItemStreamItemReader<org.springframework.ldap.core.LdapAttributes>
    - - org.springframework.batch.item.ldif.LdifReader

実装されたすべてのインターフェース:
ResourceAwareItemReaderItemStream<org.springframework.ldap.core.LdapAttributes>, ItemReader<org.springframework.ldap.core.LdapAttributes>, ItemStream, ItemStreamReader<org.springframework.ldap.core.LdapAttributes>, org.springframework.beans.factory.InitializingBean
```
public class LdifReader
extends AbstractItemCountingItemStreamItemReader<org.springframework.ldap.core.LdapAttributes>
implements ResourceAwareItemReaderItemStream<org.springframework.ldap.core.LdapAttributes>, org.springframework.beans.factory.InitializingBean
```
LdifReader は、LdifParser を中心に構築された FlatFileItemReader を応用したものです。
FlatFileItemReader とは異なり、LdifReader はマッパーを必要としません。代わりに、このバージョンの LdifReader は、ItemProcessor または任意の出力サービスによって必要に応じて消費および操作できる LdapAttributes オブジェクトを返すだけです。あるいは、RecordMapper インターフェースを実装し、MappingLdifReader に設定して、レコードをオブジェクトにマップして返すこともできます。
LdifReader の使用箇所は、すべての集中的な目的で FlatFileItemReader の使用箇所を模倣しています。ただし、行ではなくレコードを処理するように調整されています。そのため、recordsToSkip 属性は、処理してはならないファイルの先頭からのレコードの数を示します。RecordCallbackHandler インターフェースの実装を使用して、スキップされたレコードに対して操作を実行できます。
FlatFileItemReader と同様に、strict オプションは、処理前にリソースが存在する必要があるかどうかを区別します。false に設定された値の場合、例外がスローされる代わりに警告がログに記録されます。
作成者:
Keith Barlow

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

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

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`afterPropertiesSet()`
`protected void`	`doClose()` `AbstractItemCountingItemStreamItemReader.doOpen()` で開いたリソースを閉じます。
`protected void`	`doOpen()` 入力の読み取りを開始するために必要なリソースを開きます。
`protected org.springframework.ldap.core.LdapAttributes`	`doRead()` 入力から次の項目を読み取ります。
`void`	`setRecordsToSkip(int recordsToSkip)` ファイルの先頭でスキップする行数のパブリック setter。
`void`	`setResource(org.springframework.core.io.Resource resource)` LdifReader の入力として使用されるリソースを確立します。
`void`	`setSkippedRecordsCallback(RecordCallbackHandler skippedRecordsCallback)` `RecordCallbackHandler` 実装を使用して、スキップされたレコードに対してアクションを実行できます。
`void`	`setStrict(boolean strict)` 厳格モードでは、入力リソースが存在しない場合、リーダーは `AbstractItemCountingItemStreamItemReader.open(org.springframework.batch.item.ExecutionContext)` で例外をスローします。

クラス org.springframework.batch.item.support.AbstractItemCountingItemStreamItemReader から継承されたメソッド
close, getCurrentItemCount, isSaveState, jumpToItem, 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

インターフェース org.springframework.batch.item.ItemStream から継承されたメソッド
close, open, update

インターフェース org.springframework.batch.item.ItemReader から継承されたメソッド
read

- コンストラクターの詳細
  - LdifReader
```
public LdifReader()
```
- メソッドの詳細
  - setStrict
```
public void setStrict(boolean strict)
```
    厳格モードでは、入力リソースが存在しない場合、リーダーは AbstractItemCountingItemStreamItemReader.open(org.springframework.batch.item.ExecutionContext) で例外をスローします。
    パラメーター:
    strict - デフォルトで true
  - setSkippedRecordsCallback
```
public void setSkippedRecordsCallback(RecordCallbackHandler skippedRecordsCallback)
```
    RecordCallbackHandler 実装を使用して、スキップされたレコードに対してアクションを実行できます。
    パラメーター:
    skippedRecordsCallback - アイテムが読み込まれる前に、最初のスキップされた行ごとに呼び出されます。
  - setRecordsToSkip
```
public void setRecordsToSkip(int recordsToSkip)
```
    ファイルの先頭でスキップする行数のパブリック setter。ファイルに有用な（列名）情報のないヘッダーが含まれていて、行の先頭にコメント区切り文字がない場合に使用できます。
    パラメーター:
    recordsToSkip - スキップする行数
  - doClose
```
protected void doClose()
                throws java.lang.Exception
```
    クラスからコピーされた説明: AbstractItemCountingItemStreamItemReader
    AbstractItemCountingItemStreamItemReader.doOpen() で開いたリソースを閉じます。
    次で指定:
    クラス AbstractItemCountingItemStreamItemReader<org.springframework.ldap.core.LdapAttributes> の doClose
    例外:
    java.lang.Exception - サブクラスがフレームワークによる解釈のためにチェック済み例外をスローできるようにします
  - doOpen
```
protected void doOpen()
               throws java.lang.Exception
```
    クラスからコピーされた説明: AbstractItemCountingItemStreamItemReader
    入力の読み取りを開始するために必要なリソースを開きます。
    次で指定:
    クラス AbstractItemCountingItemStreamItemReader<org.springframework.ldap.core.LdapAttributes> の doOpen
    例外:
    java.lang.Exception - サブクラスがフレームワークによる解釈のためにチェック済み例外をスローできるようにします
  - doRead
```
@Nullable
protected org.springframework.ldap.core.LdapAttributes doRead()
                                                                 throws java.lang.Exception
```
    クラスからコピーされた説明: AbstractItemCountingItemStreamItemReader
    入力から次の項目を読み取ります。
    次で指定:
    クラス AbstractItemCountingItemStreamItemReader<org.springframework.ldap.core.LdapAttributes> の doRead
    戻り値:
    データソースが使い果たされた場合、アイテムまたは null
    例外:
    java.lang.Exception - サブクラスがフレームワークによる解釈のためにチェック済み例外をスローできるようにします
  - setResource
```
public void setResource(org.springframework.core.io.Resource resource)
```
    LdifReader の入力として使用されるリソースを確立します。
    次で指定:
    インターフェース ResourceAwareItemReaderItemStream<org.springframework.ldap.core.LdapAttributes> の setResource
    パラメーター:
    resource - 読み取られるリソース。
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws java.lang.Exception
```
    次で指定:
    インターフェース org.springframework.beans.factory.InitializingBean の afterPropertiesSet
    例外:
    java.lang.Exception

クラス LdifReader

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

メソッドのサマリー

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

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

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

インターフェース org.springframework.batch.item.ItemStream から継承されたメソッド

インターフェース org.springframework.batch.item.ItemReader から継承されたメソッド

コンストラクターの詳細

LdifReader

メソッドの詳細

setStrict

setSkippedRecordsCallback

setRecordsToSkip

doClose

doOpen

doRead

setResource

afterPropertiesSet