クラス FlatFileItemReader<T>

実装されたすべてのインターフェース:
ResourceAwareItemReaderItemStream<T>ItemReader<T>ItemStreamItemStreamReader<T>org.springframework.beans.factory.InitializingBean

public class FlatFileItemReader<T> extends AbstractItemCountingItemStreamItemReader<T> implements ResourceAwareItemReaderItemStream<T>, org.springframework.beans.factory.InitializingBean
入力 setResource(Resource) から行を読み取る再始動可能な ItemReader。行は setRecordSeparatorPolicy(RecordSeparatorPolicy) によって定義され、setLineMapper(LineMapper) を使用してアイテムにマップされます。行マッピング中に例外がスローされると、FlatFileParseException として再スローされ、問題のある行とその行番号に関する情報が追加されます。

このリーダーはスレッドセーフではありません。

作成者:
Robert Kasanicky, Mahmoud Ben Hassine
  • フィールドの詳細

    • DEFAULT_CHARSET

      public static final StringSE DEFAULT_CHARSET
    • DEFAULT_COMMENT_PREFIXES

      public static final StringSE[] DEFAULT_COMMENT_PREFIXES
    • comments

      protected StringSE[] comments
  • コンストラクターの詳細

    • FlatFileItemReader

      public FlatFileItemReader()
  • メソッドの詳細

    • setStrict

      public void setStrict(boolean strict)
      厳格モードでは、入力リソースが存在しない場合、リーダーは AbstractItemCountingItemStreamItemReader.open(org.springframework.batch.item.ExecutionContext) で例外をスローします。
      パラメーター:
      strict - デフォルトで true 
    • setSkippedLinesCallback

      public void setSkippedLinesCallback(LineCallbackHandler skippedLinesCallback)
      パラメーター:
      skippedLinesCallback - アイテムが読み込まれる前に、最初のスキップされた行ごとに呼び出されます。
    • setLinesToSkip

      public void setLinesToSkip(int linesToSkip)
      ファイルの先頭でスキップする行数のパブリック setter。ファイルに有用な(列名)情報のないヘッダーが含まれていて、行の先頭にコメント区切り文字がない場合に使用できます。
      パラメーター:
      linesToSkip - スキップする行数
    • setLineMapper

      public void setLineMapper(LineMapper<T> lineMapper)
      ラインマッパーの Setter。このプロパティを設定する必要があります。
      パラメーター:
      lineMapper - 行をアイテムにマップします
    • setEncoding

      public void setEncoding(StringSE encoding)
      この入力ソースのエンコーディングの Setter。デフォルト値は DEFAULT_CHARSET です。
      パラメーター:
      encoding - この入力ファイルのエンコーディングを含む可能性のあるプロパティオブジェクト。
    • setBufferedReaderFactory

      public void setBufferedReaderFactory(BufferedReaderFactory bufferedReaderFactory)
      ファイルから行を抽出するために使用される BufferedReaderSE のファクトリ。プレーンテキストファイルの場合はデフォルトで問題ありませんが、これは、java.io の標準 BufferedReader が制限されているバイナリファイルの場合に便利な戦略です。
      パラメーター:
      bufferedReaderFactory - 設定する bufferedReaderFactory
    • setComments

      public void setComments(StringSE[] comments)
      Setter(コメント接頭辞)。ヘッダー行を無視するためにも使用できます。プレフィックスとしての列名の最初の 2 つ。デフォルトは DEFAULT_COMMENT_PREFIXES です。
      パラメーター:
      comments - コメント行プレフィックスの配列。
    • setResource

      public void setResource(org.springframework.core.io.Resource resource)
      入力リソースのパブリック setter。
      次で指定:
      インターフェース ResourceAwareItemReaderItemStream<T>setResource 
    • setRecordSeparatorPolicy

      public void setRecordSeparatorPolicy(RecordSeparatorPolicy recordSeparatorPolicy)
      recordSeparatorPolicy のパブリック setter。行末がどこにあるかを判断し、引用符で囲まれた文字列内にある場合、行末を越えて続行するなどの操作を行うために使用されます。
      パラメーター:
      recordSeparatorPolicy - 設定する recordSeparatorPolicy
    • doRead

      @Nullable protected T doRead() throws ExceptionSE
      クラスからコピーされた説明: AbstractItemCountingItemStreamItemReader
      入力から次の項目を読み取ります。
      次で指定:
      クラス AbstractItemCountingItemStreamItemReader<T>doRead 
      戻り値:
      setRecordSeparatorPolicy(RecordSeparatorPolicy) に基づく論理レコードに対応する文字列(ファイル内の複数行にまたがる場合があります)。
      例外:
      ExceptionSE - サブクラスがフレームワークによる解釈のためにチェック済み例外をスローできるようにします
    • isComment

      protected boolean isComment(StringSE line)
    • doClose

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

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

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

      protected void jumpToItem(int itemIndex) throws ExceptionSE
      クラスからコピーされた説明: AbstractItemCountingItemStreamItemReader
      指定されたアイテムインデックスに移動します。AbstractItemCountingItemStreamItemReader.doRead() を使用して入力を再読み取りするよりも効率的に特定のインデックスに移動する方法がある場合、サブクラスはこのメソッドをオーバーライドする必要があります。
      オーバーライド:
      クラス AbstractItemCountingItemStreamItemReader<T>jumpToItem 
      パラメーター:
      itemIndex - ジャンプするアイテムのインデックス(0 ベース)。
      例外:
      ExceptionSE - サブクラスがフレームワークによる解釈のためにチェック済み例外をスローできるようにします