com.github.mygreen.supercsv.io

クラス CsvAnnotationBeanReader<T>

java.lang.Object

org.supercsv.io.AbstractCsvReader

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

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

型パラメータ:

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

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

Closeable, AutoCloseable, ICsvReader

public class CsvAnnotationBeanReader<T>
extends AbstractCsvAnnotationBeanReader<T>

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

バージョン:

2.１

作成者:

T.TSUCHIE

フィールドのサマリー

クラスから継承されたフィールド com.github.mygreen.supercsv.io.AbstractCsvAnnotationBeanReader

beanMappingCache, cache, errorMessages, exceptionConverter, processedColumns, validators

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

コンストラクタ

コンストラクタと説明
CsvAnnotationBeanReader(BeanMapping<T> beanMapping, ITokenizer tokenizer, CsvPreference preferences) Beanのマッピング情報を指定して、CsvAnnotationBeanReaderを作成するコンストラクタ。
CsvAnnotationBeanReader(BeanMapping<T> beanMapping, Reader reader, CsvPreference preference) Beanのマッピング情報を指定して、CsvAnnotationBeanReaderを作成するコンストラクタ。
CsvAnnotationBeanReader(Class<T> beanType, ITokenizer tokenizer, CsvPreference preference, Class<?>... groups) Beanのクラスタイプを指定して、CsvAnnotationBeanReaderを作成するコンストラクタ。
CsvAnnotationBeanReader(Class<T> beanType, Reader reader, CsvPreference preference, Class<?>... groups) Beanのクラスタイプを指定して、CsvAnnotationBeanReaderを作成するコンストラクタ。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
String[]	getHeader(boolean firstLineCheck)
List<T>	readAll() レコードを全て読み込みます。
List<T>	readAll(boolean continueOnError) レコードを全て読み込みます。

クラスから継承されたメソッド com.github.mygreen.supercsv.io.AbstractCsvAnnotationBeanReader

addValidator, executeCellProcessor, getBeanMapping, getBeanMappingCache, getDefinedHeader, getErrorMessages, getExceptionConverter, getValidators, instantiateBean, lines, populateBean, processErrors, read, read, setBeanMappingCache, setExceptionConverter, validateHeader

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

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

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

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

コンストラクタの詳細

CsvAnnotationBeanReader

public CsvAnnotationBeanReader(Class<T> beanType,
                               Reader reader,
                               CsvPreference preference,
                               Class<?>... groups)

Beanのクラスタイプを指定して、CsvAnnotationBeanReaderを作成するコンストラクタ。

BufferedReaderにラップして実行されるため、ラップする必要はありません。

パラメータ:

beanType - Beanのクラスタイプ。

reader - the Reader。

preference - the CSV preferences.

groups - グループ情報。適用するアノテーションを切り替える際に指定します。

例外:

NullPointerException - if beanType or reader or preferences are null.

CsvAnnotationBeanReader

public CsvAnnotationBeanReader(BeanMapping<T> beanMapping,
                               Reader reader,
                               CsvPreference preference)

Beanのマッピング情報を指定して、CsvAnnotationBeanReaderを作成するコンストラクタ。

BufferedReaderにラップして実行されるため、ラップする必要はありません。

Beanのマッピング情報を独自にカスタマイズして、BeanMappingFactoryから作成する場合に利用します。

パラメータ:

beanMapping - Beanのマッピング情報。

reader - the Reader。

preference - the CSV preferences.

例外:

NullPointerException - if beanMapping or reader or preferences are null.

CsvAnnotationBeanReader

public CsvAnnotationBeanReader(Class<T> beanType,
                               ITokenizer tokenizer,
                               CsvPreference preference,
                               Class<?>... groups)

Beanのクラスタイプを指定して、CsvAnnotationBeanReaderを作成するコンストラクタ。

BufferedReaderにラップして実行されるため、ラップする必要はありません。

パラメータ:

beanType - Beanのクラスタイプ。

tokenizer - the tokenizer.

preference - the CSV preferences.

groups - グループ情報。適用するアノテーションを切り替える際に指定します。

例外:

NullPointerException - if beanType or tokenizer or preferences are null.

CsvAnnotationBeanReader

public CsvAnnotationBeanReader(BeanMapping<T> beanMapping,
                               ITokenizer tokenizer,
                               CsvPreference preferences)

Beanのマッピング情報を指定して、CsvAnnotationBeanReaderを作成するコンストラクタ。

BufferedReaderにラップして実行されるため、ラップする必要はありません。

Beanのマッピング情報を独自にカスタマイズして、BeanMappingFactoryから作成する場合に利用します。

パラメータ:

beanMapping - Beanのマッピング情報。

tokenizer - the tokenizer.

preferences - the CSV preferences.

例外:

NullPointerException - if beanMapping or tokenizer or preferences are null.

メソッドの詳細

getHeader

public String[] getHeader(boolean firstLineCheck)
                   throws IOException

定義:

getHeader インタフェース内 ICsvReader

オーバーライド:

getHeader クラス内 AbstractCsvReader

パラメータ:

firstLineCheck - 1行目の読み込み時に呼ばれるかチェックします。 trueのとき、1行目の読み込み時以外に呼ばれた場合、例外SuperCsvExceptionをスローします。

戻り値:

ヘッダー行の値を配列で返します。

例外:

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

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

SuperCsvException - 引数firstLineCheck=trueのとき、このメソッドが1行目以外の読み込み時に呼ばれた場合。

IOException - ファイルの読み込みに失敗した場合。

readAll

public List<T> readAll()
                throws IOException

レコードを全て読み込みます。

ヘッダー行も自動的に処理されます。

レコード処理中に例外が発生した場合、その時点で処理を終了します。

戻り値:

読み込んだレコード情報。

例外:

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

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

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

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

readAll

public List<T> readAll(boolean continueOnError)
                throws IOException

レコードを全て読み込みます。

ヘッダー行も自動的に処理されます。

パラメータ:

continueOnError - レコードの処理中に、 例外SuperCsvNoMatchColumnSizeException、SuperCsvNoMatchColumnSizeException、SuperCsvBindingException が発生しても続行するかどう指定します。 trueの場合、例外が発生しても、次の処理を行います。

戻り値:

読み込んだレコード情報。

例外:

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

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

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

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