クラス FlatFileItemReaderBuilder<T>
java.lang.ObjectSE
org.springframework.batch.item.file.builder.FlatFileItemReaderBuilder<T>
FlatFileItemReader のビルダー実装。- 導入:
- 4.0
- 作成者:
- Michael Minella, Glenn Renfro, Mahmoud Ben Hassine, Drummond Dawson
- 関連事項:
ネストされたクラスの要約
ネストされたクラス修飾子と型クラス説明static classDelimitedLineTokenizerを構築するためのビルダーstatic classFixedLengthTokenizerを構築するためのビルダーフィールドのサマリー
フィールドコンストラクターの概要
コンストラクターメソッドのサマリー
修飾子と型メソッド説明addComment(StringSE comment) コメント行を示す文字列のリストに文字列を追加します。beanFactory(org.springframework.beans.factory.BeanFactory beanFactory) アイテムとして返される Bean の作成に使用されるBeanFactoryを構成します。beanMapperStrict(boolean beanMapperStrict) true に設定すると、FieldSetに Bean にマップできないフィールドが含まれている場合、マッピングは失敗します。リーダーのカスタムBufferedReaderFactoryを構成します。build()FlatFileItemReaderをビルドします。コメントである(したがって、リーダーによってスキップされた)行を示す文字列の配列を設定します。currentItemCount(int currentItemCount) 現在のアイテムのインデックス。customEditors(MapSE<ClassSE<?>, PropertyEditorSE> customEditors) マッピングされる Bean のカスタム型コンバーターを登録します。DelimitedLineTokenizerを構築するためのFlatFileItemReaderBuilder.DelimitedBuilderのインスタンスを返します。distanceLimit(int distanceLimit) フィールド名とプロパティ名の実際のスペル間の最大許容差を設定します。リーダーが入力ソースを読み取るために使用するエンコードを構成します。fieldSetMapper(FieldSetMapper<T> mapper) 使用するFieldSetMapper実装。FixedLengthTokenizerを構築するためのFlatFileItemReaderBuilder.FixedLengthBuilderのインスタンスを返します。lineMapper(LineMapper<T> lineMapper) 使用するLineMapper実装。linesToSkip(int linesToSkip) ファイルの読み取りの開始時にスキップする行数。lineTokenizer(LineTokenizer tokenizer) 使用するLineTokenizer実装。maxItemCount(int maxItemCount) 読み込むアイテムの最大数を設定します。ExecutionContext内でキーを計算するために使用される名前。prototypeBeanName(StringSE prototypeBeanName) リーダーによって返されるアイテムとして使用される Bean スコープのプロトタイプの ID を構成します。リーダーのカスタムRecordSeparatorPolicyを構成します。resource(org.springframework.core.io.Resource resource) 入力として使用されるResource。saveState(boolean saveState) 再起動のためにItemStreamSupportの状態をExecutionContext内に保持する必要があるかどうかを構成します。skippedLinesCallback(LineCallbackHandler callback) スキップされる行ごとに呼び出されるコールバック。strict(boolean strict) リーダーを厳格モードにする必要があるかどうかを構成します(入力Resourceが存在する必要があります)。targetType(ClassSE<T> targetType) リーダーから返される「アイテム」を表すクラス。
フィールドの詳細
logger
protected org.apache.commons.logging.Log logger
コンストラクターの詳細
FlatFileItemReaderBuilder
public FlatFileItemReaderBuilder()
メソッドの詳細
saveState
再起動のためにItemStreamSupportの状態をExecutionContext内に保持する必要があるかどうかを構成します。- パラメーター:
saveState- デフォルトは true- 戻り値:
- ビルダーの現在のインスタンス。
name
ExecutionContext内でキーを計算するために使用される名前。saveState(boolean)が true に設定されている場合は必須です。- パラメーター:
name- リーダーインスタンスの名前- 戻り値:
- ビルダーの現在のインスタンス。
- 関連事項:
maxItemCount
読み込むアイテムの最大数を設定します。- パラメーター:
maxItemCount- 読み込む最大アイテム- 戻り値:
- ビルダーの現在のインスタンス。
- 関連事項:
currentItemCount
現在のアイテムのインデックス。再起動時に使用して、どこから開始するかを示します。- パラメーター:
currentItemCount- 現在のインデックス- 戻り値:
- メソッド連鎖のためのこのインスタンス
- 関連事項:
addComment
コメント行を示す文字列のリストに文字列を追加します。デフォルトはFlatFileItemReader.DEFAULT_COMMENT_PREFIXESです。- パラメーター:
comment- コメント行を定義する文字列。- 戻り値:
- ビルダーの現在のインスタンス。
- 関連事項:
comments
コメントである(したがって、リーダーによってスキップされた)行を示す文字列の配列を設定します。このメソッドは、デフォルトのコメント接頭辞であるFlatFileItemReader.DEFAULT_COMMENT_PREFIXESをオーバーライドします。- パラメーター:
comments- コメントを識別するための文字列の配列。- 戻り値:
- ビルダーの現在のインスタンス。
- 関連事項:
recordSeparatorPolicy
リーダーのカスタムRecordSeparatorPolicyを構成します。- パラメーター:
policy- カスタムポリシー- 戻り値:
- ビルダーの現在のインスタンス。
- 関連事項:
bufferedReaderFactory
リーダーのカスタムBufferedReaderFactoryを構成します。- パラメーター:
factory- カスタムファクトリ- 戻り値:
- ビルダーの現在のインスタンス。
- 関連事項:
resource
入力として使用されるResource。- パラメーター:
resource- リーダーへの入力。- 戻り値:
- ビルダーの現在のインスタンス。
- 関連事項:
strict
リーダーを厳格モードにする必要があるかどうかを構成します(入力Resourceが存在する必要があります)。- パラメーター:
strict- 入力ファイルが存在する必要がある場合は true。- 戻り値:
- ビルダーの現在のインスタンス。
- 関連事項:
encoding
リーダーが入力ソースを読み取るために使用するエンコードを構成します。デフォルト値はFlatFileItemReader.DEFAULT_CHARSETです。- パラメーター:
encoding- 入力ソースの読み取りに使用します。- 戻り値:
- ビルダーの現在のインスタンス。
- 関連事項:
linesToSkip
ファイルの読み取りの開始時にスキップする行数。- パラメーター:
linesToSkip- スキップする行数。- 戻り値:
- ビルダーの現在のインスタンス。
- 関連事項:
skippedLinesCallback
スキップされる行ごとに呼び出されるコールバック。- パラメーター:
callback- コールバック- 戻り値:
- ビルダーの現在のインスタンス。
- 関連事項:
lineMapper
使用するLineMapper実装。- パラメーター:
lineMapper-LineMapper- 戻り値:
- ビルダーの現在のインスタンス。
- 関連事項:
fieldSetMapper
使用するFieldSetMapper実装。- パラメーター:
mapper-FieldSetMapper- 戻り値:
- ビルダーの現在のインスタンス。
- 関連事項:
lineTokenizer
使用するLineTokenizer実装。- パラメーター:
tokenizer-LineTokenizer- 戻り値:
- ビルダーの現在のインスタンス。
- 関連事項:
delimited
DelimitedLineTokenizerを構築するためのFlatFileItemReaderBuilder.DelimitedBuilderのインスタンスを返します。このビルダーによって構成されたDelimitedLineTokenizerは、lineTokenizerを介して明示的に構成されていない場合にのみ使用されます。fixedLength
FixedLengthTokenizerを構築するためのFlatFileItemReaderBuilder.FixedLengthBuilderのインスタンスを返します。この Builder によって構成されたFixedLengthTokenizerは、lineTokenizerが構成されていない場合にのみ使用されます。targetType
リーダーから返される「アイテム」を表すクラス。このクラスはBeanWrapperFieldSetMapperを介して使用されます。より複雑なロジックが必要な場合は、fieldSetMapperを介して独自のFieldSetMapperを提供する必要があります。- パラメーター:
targetType- マップするクラス- 戻り値:
- ビルダーの現在のインスタンス。
- 関連事項:
prototypeBeanName
リーダーによって返されるアイテムとして使用される Bean スコープのプロトタイプの ID を構成します。- パラメーター:
prototypeBeanName- Bean スコープのプロトタイプの名前- 戻り値:
- ビルダーの現在のインスタンス。
- 関連事項:
beanFactory
public FlatFileItemReaderBuilder<T> beanFactory(org.springframework.beans.factory.BeanFactory beanFactory) アイテムとして返される Bean の作成に使用されるBeanFactoryを構成します。- パラメーター:
beanFactory-BeanFactory- 戻り値:
- ビルダーの現在のインスタンス。
- 関連事項:
customEditors
マッピングされる Bean のカスタム型コンバーターを登録します。- パラメーター:
customEditors- エディターのMapSE- 戻り値:
- ビルダーの現在のインスタンス。
- 関連事項:
distanceLimit
フィールド名とプロパティ名の実際のスペル間の最大許容差を設定します。- パラメーター:
distanceLimit- 設定する距離制限- 戻り値:
- ビルダーの現在のインスタンス。
- 関連事項:
beanMapperStrict
true に設定すると、FieldSetに Bean にマップできないフィールドが含まれている場合、マッピングは失敗します。- パラメーター:
beanMapperStrict- デフォルトは false- 戻り値:
- ビルダーの現在のインスタンス。
- 関連事項:
build
FlatFileItemReaderをビルドします。