nablarch.common.databind.csv

Annotation Type Csv

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Published
public @interface Csv

CSVにバインドするBeanであることを表すアノテーション。

CSVにバインドするBeanに定義することで、CSVのレコードをBeanオブジェクトとして扱うことができる。

CSVを読込む場合の例を以下に示す。 (フォーマットがデフォルト、プロパティ名がage(年齢)、name(氏名)、address(住所)、項目順が年齢、氏名、住所）

  @Csv(type = Csv.CsvType.DEFAULT, properties = {"age", "name", "address"})
   public class Person {...}
 
 

CSVを出力する場合の例を以下に示す。 (フォーマットがデフォルト、プロパティ名がage(年齢)、name(氏名)、address(住所)、項目順が年齢、氏名、住所)

  @Csv(type = Csv.CsvType.DEFAULT, properties = {"age", "name", "address"}, headers = {"年齢", "氏名", "住所"})
   public class Person {...}
 
 

Author:

Naoki Yamamoto

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String[]	properties CSVの項目に対応したプロパティのリスト。 設定された順序で読込・出力されるため、 CSVの項目順にプロパティ名を列挙する。
nablarch.common.databind.csv.Csv.CsvType	type フォーマット定義。 CsvType#CUSTOMを選択した場合、CsvFormatアノテーションを使用し、 フォーマットを指定すること。

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String[]	headers CSVのタイトルに出力する値。 Csv.type() にヘッダー必須のものを指定した場合は、 必ず指定すること。 任意の場合は、ヘッダーが必要な際に指定すること。

Element Detail

type

public abstract nablarch.common.databind.csv.Csv.CsvType type

フォーマット定義。

CsvType#CUSTOMを選択した場合、CsvFormatアノテーションを使用し、 フォーマットを指定すること。

properties

public abstract java.lang.String[] properties

CSVの項目に対応したプロパティのリスト。

設定された順序で読込・出力されるため、 CSVの項目順にプロパティ名を列挙する。

headers

public abstract java.lang.String[] headers

CSVのタイトルに出力する値。

Csv.type() にヘッダー必須のものを指定した場合は、 必ず指定すること。
任意の場合は、ヘッダーが必要な際に指定すること。

Default:

{}