com.github.mygreen.supercsv.annotation

注釈型 CsvPartial

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Documented
public @interface CsvPartial

部分的にカラムをマッピングする際のカラム情報を補完するためのアノテーションです。

基本的な使い方

• 部分的にマッピングする際には、単純に、マッピングしないカラムの定義を省略します。
• ただし、定義している最大のカラム番号が、実ファイルのカラム番号よりも小さい場合は、 属性columnSize()で、実際のカラムサイズを指定します。
• 見出し行がある場合、定義していない見出しを属性headers()で定義します。

 @CsvBean(header=true, validateHeader=true)
 @CsvPartial(columnSize=5, headers={
     @CsvPartial.Header(number=3, label="電話番号"),
     @CsvPartial.Header(number=5, label="生年月日"))
 public class SampleCsv {
     
     @CsvColumn(number=1)
     private int id;

     @CsvColumn(number=2, label="氏名")
     private String name;

     // カラム番号3は読み込まない場合は、定義を行いません。

     @CsvColumn(number=4, label="メールアドレス")
     private String email;

     // カラム番号5はマッピングしない場合は、定義を行いません。
     
     // getter/setterは省略
 }
 

導入されたバージョン:

2.0

作成者:

T.TSUCHIE

必須要素のサマリー

必須要素

修飾子とタイプ	必須要素と説明
int	columnSize 実際のCSVファイルのカラム数を指定します。

任意要素のサマリー

任意要素

修飾子とタイプ	任意要素と説明
CsvPartial.Header[]	headers ヘッダー情報を定義するためのアノテーションです。

要素の詳細

columnSize

public abstract int columnSize

実際のCSVファイルのカラム数を指定します。

定義しているカラムのCsvColumn.number()より大きい値を指定します。

戻り値:

1以上の値を指定します。

headers

public abstract CsvPartial.Header[] headers

ヘッダー情報を定義するためのアノテーションです。

戻り値:

Beanに定義されていないカラムのヘッダー情報を補足するために使用されます。

デフォルト:

{}