パッケージ org.springframework.batch.item.ldif

クラス LdifReader

java.lang.ObjectSE
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, Mahmoud Ben Hassine

  • コンストラクターの詳細

    • 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 ExceptionSE
      クラスからコピーされた説明: AbstractItemCountingItemStreamItemReader
      AbstractItemCountingItemStreamItemReader.doOpen() で開いたリソースを閉じます。
      次で指定:
      クラス AbstractItemCountingItemStreamItemReader<org.springframework.ldap.core.LdapAttributes> の doClose 
      例外:
      ExceptionSE - サブクラスがフレームワークによる解釈のためにチェック済み例外をスローできるようにします

    • doOpen

      protected void doOpen() throws ExceptionSE
      クラスからコピーされた説明: AbstractItemCountingItemStreamItemReader
      入力の読み取りを開始するために必要なリソースを開きます。
      次で指定:
      クラス AbstractItemCountingItemStreamItemReader<org.springframework.ldap.core.LdapAttributes> の doOpen 
      例外:
      ExceptionSE - サブクラスがフレームワークによる解釈のためにチェック済み例外をスローできるようにします

    • doRead

      @Nullable protected org.springframework.ldap.core.LdapAttributes doRead() throws ExceptionSE
      クラスからコピーされた説明: AbstractItemCountingItemStreamItemReader
      入力から次の項目を読み取ります。
      次で指定:
      クラス AbstractItemCountingItemStreamItemReader<org.springframework.ldap.core.LdapAttributes> の doRead 
      戻り値:
      データソースが使い果たされた場合、アイテムまたは null 
      例外:
      ExceptionSE - サブクラスがフレームワークによる解釈のためにチェック済み例外をスローできるようにします

    • setResource

      public void setResource(org.springframework.core.io.Resource resource)
      LdifReader の入力として使用されるリソースを確立します。
      次で指定:
      インターフェース ResourceAwareItemReaderItemStream<org.springframework.ldap.core.LdapAttributes> の setResource 
      パラメーター:
      resource - 読み取られるリソース。

    • afterPropertiesSet

      public void afterPropertiesSet() throws ExceptionSE
      次で指定:
      インターフェース org.springframework.beans.factory.InitializingBean の afterPropertiesSet 
      例外:
      ExceptionSE