com.github.mygreen.supercsv.io

クラス AbstractCsvAnnotationBeanReader<T>

java.lang.Object

org.supercsv.io.AbstractCsvReader

com.github.mygreen.supercsv.io.AbstractCsvAnnotationBeanReader<T>

型パラメータ:

T - マッピング対象のBeanのクラスタイプ

すべての実装されたインタフェース:

Closeable, AutoCloseable, ICsvReader

直系の既知のサブクラス:

CsvAnnotationBeanReader, FixedSizeCsvAnnotationBeanReader, LazyCsvAnnotationBeanReader

public abstract class AbstractCsvAnnotationBeanReader<T>
extends AbstractCsvReader

アノテーションを元にCSVファイルを読み込むための抽象クラス。

導入されたバージョン:

2.1

バージョン:

2.3

作成者:

T.TSUCHIE

関連項目:

CsvBeanReader

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected BeanMappingCache<T>	beanMappingCache Beanのマッピング情報のキャッシュ。
protected MethodCache	cache cache of methods for mapping from columns to fields
protected List<String>	errorMessages processing error messages.
protected CsvExceptionConverter	exceptionConverter exception converter.
protected List<Object>	processedColumns temporary storage of processed columns to be mapped to the bean
protected List<CsvValidator<T>>	validators validator

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

コンストラクタ

コンストラクタと説明
AbstractCsvAnnotationBeanReader(ITokenizer tokenizer, CsvPreference preference)
AbstractCsvAnnotationBeanReader(Reader reader, CsvPreference preference)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	addValidator(CsvValidator<T>... validators) レコードの値を検証するValidatorを追加します。
protected void	executeCellProcessor(List<Object> destination, List<String> source, CellProcessor[] processors, CsvContext context) 行の各カラムの値に対して、CellProcessorを適用します。
BeanMapping<T>	getBeanMapping() Beanのマッピング情報を取得します。
protected BeanMappingCache<T>	getBeanMappingCache() Beanのマッピング情報をキャッシュするクラスを取得します。
String[]	getDefinedHeader() Beanクラスを元に作成したヘッダー情報を取得する。
List<String>	getErrorMessages() エラーメッセージを取得します。
CsvExceptionConverter	getExceptionConverter() 処理中に発生した例外をメッセージに変換するクラスを取得します。
List<CsvValidator<T>>	getValidators() レコードの値を検証するValidatorを取得します。
protected T	instantiateBean(Class<T> clazz) 指定したBeanのクラスのインスタンスを作成する。
Stream<T>	lines() Stream を返します。
protected void	populateBean(T resultBean, String[] nameMapping, CsvBindingErrors bindingErrors) Beanの各フィールドに対して値を設定する。
protected void	processErrors(CsvBindingErrors bindingErrors, CsvContext context, Optional<SuperCsvRowException> rowException) 行の例外情報をメッセージに変換したりします。
T	read() 1レコード分を読み込みます。
CsvReadStatus	read(CsvSuccessHandler<T> successHandler, CsvErrorHandler errorHandler) 成功時、例外発生時の処理を指定して、1レコード分を読み込みます。
protected void	setBeanMappingCache(BeanMappingCache<T> beanMappingCache) Beanのマッピング情報をキャッシュするクラスを設定します。
void	setExceptionConverter(CsvExceptionConverter exceptionConverter) 処理中に発生した例外をメッセージに変換するクラスを設定します。
protected void	validateHeader(String[] sourceHeader, String[] definedHeader) CSVのヘッダーの検証を行います。

クラスから継承されたメソッド org.supercsv.io.AbstractCsvReader

close, executeProcessors, get, getColumns, getHeader, getLineNumber, getPreferences, getRowNumber, getUntokenizedRow, length, readRow

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

beanMappingCache

protected BeanMappingCache<T> beanMappingCache

Beanのマッピング情報のキャッシュ。 ・組み立てたCellProcessorをキャッシュしておきます。

processedColumns

protected final List<Object> processedColumns

temporary storage of processed columns to be mapped to the bean

cache

protected final MethodCache cache

cache of methods for mapping from columns to fields

exceptionConverter

protected CsvExceptionConverter exceptionConverter

exception converter.

errorMessages

protected final List<String> errorMessages

processing error messages.

validators

protected final List<CsvValidator<T>> validators

validator

コンストラクタの詳細

AbstractCsvAnnotationBeanReader

public AbstractCsvAnnotationBeanReader(Reader reader,
                                       CsvPreference preference)

AbstractCsvAnnotationBeanReader

public AbstractCsvAnnotationBeanReader(ITokenizer tokenizer,
                                       CsvPreference preference)

メソッドの詳細

read

public T read()
       throws IOException

1レコード分を読み込みます。

戻り値:

Beanのレコード。読み込むレコードがない場合は、nullを返します。

例外:

IOException - レコードの読み込みに失敗した場合。

SuperCsvNoMatchColumnSizeException - レコードのカラムサイズに問題がある場合

SuperCsvBindingException - セルの値に問題がある場合

SuperCsvException - 設定など、その他に問題がある場合

read

public CsvReadStatus read(CsvSuccessHandler<T> successHandler,
                          CsvErrorHandler errorHandler)
                   throws IOException

成功時、例外発生時の処理を指定して、1レコード分を読み込みます。

パラメータ:

successHandler - 読み込み成功時の処理の実装。

errorHandler - CSVに関する例外発生時の処理の実装。

戻り値:

CSVの読み込み処理ステータスを返します。

例外:

IOException - 致命的なレコードの読み込みに失敗した場合にスローされます。

導入されたバージョン:

2.3

lines

public Stream<T> lines()

Stream を返します。要素はCSVの行をBeanにマッピングしたオブジェクトです。

読み込む際には例外 SuperCsvException / UncheckedIOException が発生する可能性があります（読み込みを行った Stream メソッドからスローされます)。

読み込み時にスローされた IOException は、UncheckedIOException にラップされます。

戻り値:

各レコードをBeanに変換した Stream を返します。

導入されたバージョン:

2.3

validateHeader

protected void validateHeader(String[] sourceHeader,
                              String[] definedHeader)

CSVのヘッダーの検証を行います。

パラメータ:

sourceHeader - オリジナルのヘッダー情報。

definedHeader - アノテーションなどの定義を元にしたヘッダー情報

例外:

SuperCsvNoMatchColumnSizeException - ヘッダーのサイズ（カラム数）がBean定義と一致しない場合。

SuperCsvNoMatchHeaderException - ヘッダーの値がBean定義と一致しない場合。

processErrors

protected void processErrors(CsvBindingErrors bindingErrors,
                             CsvContext context,
                             Optional<SuperCsvRowException> rowException)

行の例外情報をメッセージに変換したりします。

パラメータ:

bindingErrors -

context -

rowException -

instantiateBean

protected T instantiateBean(Class<T> clazz)

指定したBeanのクラスのインスタンスを作成する。

パラメータ:

clazz - Beanのクラスタイプ。

戻り値:

Beanのインスタンス。

例外:

SuperCsvReflectionException - Beanのインスタンスの作成に失敗した場合。

executeCellProcessor

protected void executeCellProcessor(List<Object> destination,
                                    List<String> source,
                                    CellProcessor[] processors,
                                    CsvContext context)

行の各カラムの値に対して、CellProcessorを適用します。

パラメータ:

destination -

source -

processors -

context -

例外:

SuperCsvNoMatchColumnSizeException - カラムサイズが定義と一致しない場合

SuperCsvRowException - CellProcessor内で発生した例外

populateBean

protected void populateBean(T resultBean,
                            String[] nameMapping,
                            CsvBindingErrors bindingErrors)

Beanの各フィールドに対して値を設定する。

パラメータ:

resultBean -

nameMapping -

bindingErrors -

getBeanMappingCache

protected BeanMappingCache<T> getBeanMappingCache()

Beanのマッピング情報をキャッシュするクラスを取得します。

戻り値:

Beanのマッピング情報をキャッシュするクラス

setBeanMappingCache

protected void setBeanMappingCache(BeanMappingCache<T> beanMappingCache)

Beanのマッピング情報をキャッシュするクラスを設定します。

パラメータ:

beanMappingCache - Beanのマッピング情報をキャッシュするクラス

getDefinedHeader

public String[] getDefinedHeader()

Beanクラスを元に作成したヘッダー情報を取得する。

戻り値:

ヘッダー一覧。

getBeanMapping

public BeanMapping<T> getBeanMapping()

Beanのマッピング情報を取得します。

戻り値:

Beanのマッピング情報

getErrorMessages

public List<String> getErrorMessages()

エラーメッセージを取得します。

戻り値:

処理中に発生した例外をメッセージに変換した

getExceptionConverter

public CsvExceptionConverter getExceptionConverter()

処理中に発生した例外をメッセージに変換するクラスを取得します。

戻り値:

setExceptionConverter

public void setExceptionConverter(CsvExceptionConverter exceptionConverter)

処理中に発生した例外をメッセージに変換するクラスを設定します。

パラメータ:

exceptionConverter - 独自にカスタマイズした値を設定します。

addValidator

public void addValidator(CsvValidator<T>... validators)

レコードの値を検証するValidatorを追加します。

パラメータ:

validators - CsvValidatorの実装クラスを設定します。

getValidators

public List<CsvValidator<T>> getValidators()

レコードの値を検証するValidatorを取得します。

戻り値:

CsvValidatorの実装クラスを設定します。