Package nablarch.common.databind.csv

Annotation Interface Csv

@Target(TYPE) @Retention(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 {...}

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    Csv.CsvType
    CsvDataBindConfigのフォーマットを表す列挙型

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String[]
    properties
    CSVの項目に対応したプロパティのリスト。
    Csv.CsvType
    type
    フォーマット定義。

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String[]
    headers
    CSVのヘッダー。

  • Element Details

    • type

      Csv.CsvType type
      フォーマット定義。

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

    • properties

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

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

    • headers

      String[] headers
      CSVのヘッダー。

      type() にヘッダー必須のものを指定した場合は、 必ず指定すること。
      任意の場合は、ヘッダーが必要な際に指定すること。 設定された順序で読込・出力されるため、 CSVの項目順にヘッダー名を列挙する。

      Default:
      {}