CsvDataBindConfig (NablarchApi)

java.lang.Object
- nablarch.common.databind.csv.CsvDataBindConfig

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

@Published
public class CsvDataBindConfig
extends Object
implements DataBindConfig

CSVのフォーマットを表すクラス。

デフォルト設定を使用する場合は、CsvDataBindConfig.DEFAULTオブジェクトを使用する。
独自の設定を行う場合は、CsvDataBindConfig.CsvDataBindConfig(char, String, char, boolean, boolean, String[], Charset, QuoteMode, List) を使用しオブジェクトを生成するか、CsvDataBindConfig.DEFAULTオブジェクトのセッタを実行して値を設定する。

下記にデフォルトの設定値を示す。

 列区切り文字                -->  ","
 行区切り文字                -->  "\r\n"(CRLF)
 フィールド囲み文字          -->  """
 空行を無視するか否か        -->  無視する(true)
 ヘッダ行が必須か否か        -->  必須(true)
 ヘッダーに出力するタイトル  -->  空のString型配列
 文字コード                  -->  UTF-8
 フィールド囲み文字で囲む
 フィールドを指定するモード  -->  NORMAL(フィールド囲み文字、フィールド区切り文字、改行が存在するフィールドが対象となる)
 フィールド囲み文字で囲む
 フィールドのリスト          -->  空のリスト

作成者:: Naoki Yamamoto

ネストされたクラスのサマリー

ネストされたクラス
修飾子とタイプ	クラスと説明
`static class`	`CsvDataBindConfig.QuoteMode` 出力時にフィールド囲み文字で囲むフィールドを指定するモードの定義。

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`static CsvDataBindConfig`	`DEFAULT` デフォルトのフォーマット定義
`static CsvDataBindConfig`	`EXCEL` EXCEL形式のCSVフォーマット定義
`static CsvDataBindConfig`	`RFC4180` RFC4180準拠のフォーマット定義
`static CsvDataBindConfig`	`TSV` タブ区切り(TSV)のフォーマット定義

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

コンストラクタ
コンストラクタと説明
`CsvDataBindConfig(char fieldSeparator, String lineSeparator, char quote, boolean ignoreEmptyLine, boolean requiredHeader, String[] headerTitles, Charset charset, CsvDataBindConfig.QuoteMode quoteMode, List quotedColumnNames)` CSVのフォーマット定義を生成する。

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`Charset`	`getCharset()` 文字コードを取得する。
`char`	`getFieldSeparator()` 列区切り文字を取得する。
`String[]`	`getHeaderTitles()` ヘッダー行(タイトル行)に出力するタイトルのリスト。
`String`	`getLineSeparator()` 行区切り文字を取得する。
`char`	`getQuote()` フィールド囲み文字を取得する。
`List`	`getQuotedColumnNames()` 出力時にフィールド囲み文字(`CsvDataBindConfig.getQuote()`)で囲むフィールドのリストを取得する。
`CsvDataBindConfig.QuoteMode`	`getQuoteMode()` フィールド囲み文字で囲むフィールドを取得する。
`boolean`	`isIgnoreEmptyLine()` 空行を無視するか否かを取得する。
`boolean`	`isRequiredHeader()` ヘッダー行(タイトル行)が必須か否か。
`CsvDataBindConfig`	`withCharset(Charset newCharset)` 文字コードを設定する。
`CsvDataBindConfig`	`withCharset(String newCharset)` 文字コードを設定する。
`CsvDataBindConfig`	`withFieldSeparator(char newFieldSeparator)` 列区切り文字を設定する。
`CsvDataBindConfig`	`withHeaderTitles(String... newHeaderTitles)` ヘッダー行(タイトル行)に出力するタイトルを設定する。
`CsvDataBindConfig`	`withIgnoreEmptyLine()` 空行を無視する。
`CsvDataBindConfig`	`withIgnoreEmptyLine(boolean newOption)` 空行を無視するか否かを設定する。
`CsvDataBindConfig`	`withLineSeparator(String newLineSeparator)` 改行文字を設定する。
`CsvDataBindConfig`	`withQuote(char newQuote)` フィールド囲み文字を設定する。
`CsvDataBindConfig`	`withQuotedColumnNames(String... fieldNames)` フィールド囲み文字(`CsvDataBindConfig.getQuote()`で囲むフィールドのリストを設定する。
`CsvDataBindConfig`	`withQuoteMode(CsvDataBindConfig.QuoteMode newQuoteMode)` 出力時にフィールド囲み文字で囲むフィールドを設定する。
`CsvDataBindConfig`	`withRequiredHeader()` ヘッダー行(タイトル行)を必須に設定する。
`CsvDataBindConfig`	`withRequiredHeader(boolean newOption)` ヘッダー行(タイトル行)を必須とするか否かを設定する。

- フィールドの詳細
  - DEFAULT
```
public static final CsvDataBindConfig DEFAULT
```
    デフォルトのフォーマット定義
  - RFC4180
```
public static final CsvDataBindConfig RFC4180
```
    RFC4180準拠のフォーマット定義
  - EXCEL
```
public static final CsvDataBindConfig EXCEL
```
    EXCEL形式のCSVフォーマット定義
  - TSV
```
public static final CsvDataBindConfig TSV
```
    タブ区切り(TSV)のフォーマット定義
- コンストラクタの詳細
  - CsvDataBindConfig
```
public CsvDataBindConfig(char fieldSeparator,
                         String lineSeparator,
                         char quote,
                         boolean ignoreEmptyLine,
                         boolean requiredHeader,
                         String[] headerTitles,
                         Charset charset,
                         CsvDataBindConfig.QuoteMode quoteMode,
                         List quotedColumnNames)
```
    CSVのフォーマット定義を生成する。
    
    パラメータ:
    
    fieldSeparator - 列区切り文字
    
    lineSeparator - 行区切り文字(\r\n(CRLF) or \r(CR) or \n(LF)であること)
    
    quote - フィールド囲み文字
    
    ignoreEmptyLine - 空行を無視するか否か
    
    requiredHeader - ヘッダ行(タイトル行)が必須か否か
    
    headerTitles - ヘッダーに出力するタイトル
    
    charset - 文字コード
    
    quoteMode - 出力時にフィールド囲み文字で囲むフィールドを指定するモード
    
    quotedColumnNames - フィールド囲み文字で囲むフィールドのリスト
    
    例外:
    
    IllegalArgumentException - 行区切り文字が「\r\n(CRLF)・\r(CR)・\n(LF)」以外の場合
- メソッドの詳細
  - getFieldSeparator
```
public char getFieldSeparator()
```
    列区切り文字を取得する。
    
    戻り値:
    
    列区切り文字
  - withFieldSeparator
```
public CsvDataBindConfig withFieldSeparator(char newFieldSeparator)
```
    列区切り文字を設定する。
    
    パラメータ:
    
    newFieldSeparator - 新しい列区切り文字
    
    戻り値:
    
    新しいCsvDataBindConfig
  - getLineSeparator
```
public String getLineSeparator()
```
    行区切り文字を取得する。
    
    戻り値:
    
    行区切り文字
  - withLineSeparator
```
public CsvDataBindConfig withLineSeparator(String newLineSeparator)
```
    改行文字を設定する。
    改行文字が(CR|LF|CRLF)以外の場合はエラーとする。
    
    パラメータ:
    
    newLineSeparator - 改行文字
    
    戻り値:
    
    新しいCsvDataBindConfig
  - getQuote
```
public char getQuote()
```
    フィールド囲み文字を取得する。
    
    戻り値:
    
    フィールド囲み文字
  - withQuote
```
public CsvDataBindConfig withQuote(char newQuote)
```
    フィールド囲み文字を設定する。
    
    パラメータ:
    
    newQuote - フィールド囲み文字
    
    戻り値:
    
    新しいCsvDataBindConfig
  - isIgnoreEmptyLine
```
public boolean isIgnoreEmptyLine()
```
    空行を無視するか否かを取得する。
    
    戻り値:
    
    空行を無視する場合true
  - withIgnoreEmptyLine
```
public CsvDataBindConfig withIgnoreEmptyLine()
```
    空行を無視する。
    
    戻り値:
    
    新しいCsvDataBindConfig
  - withIgnoreEmptyLine
```
public CsvDataBindConfig withIgnoreEmptyLine(boolean newOption)
```
    空行を無視するか否かを設定する。
    
    パラメータ:
    
    newOption - 空行を無視する場合true
    
    戻り値:
    
    新しいCsvDataBindConfig
  - isRequiredHeader
```
public boolean isRequiredHeader()
```
    ヘッダー行(タイトル行)が必須か否か。
    
    戻り値:
    
    ヘッダー行(タイトル行)が必須の場合true
  - withRequiredHeader
```
public CsvDataBindConfig withRequiredHeader()
```
    ヘッダー行(タイトル行)を必須に設定する。
    
    戻り値:
    
    新しいCsvDataBindConfig
  - withRequiredHeader
```
public CsvDataBindConfig withRequiredHeader(boolean newOption)
```
    ヘッダー行(タイトル行)を必須とするか否かを設定する。
    
    パラメータ:
    
    newOption - ヘッダーが必須な場合true
    
    戻り値:
    
    新しいCsvDataBindConfig
  - getHeaderTitles
```
public String[] getHeaderTitles()
```
    ヘッダー行(タイトル行)に出力するタイトルのリスト。
    
    戻り値:
    
    ヘッダー行に出力するタイトル
  - withHeaderTitles
```
public CsvDataBindConfig withHeaderTitles(String... newHeaderTitles)
```
    ヘッダー行(タイトル行)に出力するタイトルを設定する。
    
    パラメータ:
    
    newHeaderTitles - ヘッダー行(タイトル行)に出力するタイトル
    
    戻り値:
    
    新しいCsvDataBindConfig
  - getCharset
```
public Charset getCharset()
```
    文字コードを取得する。
    
    戻り値:
    
    文字コード
  - withCharset
```
public CsvDataBindConfig withCharset(String newCharset)
```
    文字コードを設定する。
    
    パラメータ:
    
    newCharset - 文字コード
    
    戻り値:
    
    新しいCsvDataBindConfig
  - withCharset
```
public CsvDataBindConfig withCharset(Charset newCharset)
```
    文字コードを設定する。
    
    パラメータ:
    
    newCharset - 文字コード
    
    戻り値:
    
    新しいCsvDataBindConfig
  - getQuoteMode
```
public CsvDataBindConfig.QuoteMode getQuoteMode()
```
    フィールド囲み文字で囲むフィールドを取得する。
    
    戻り値:
    
    フィールド囲み文字で囲むフィールド
  - withQuoteMode
```
public CsvDataBindConfig withQuoteMode(CsvDataBindConfig.QuoteMode newQuoteMode)
```
    出力時にフィールド囲み文字で囲むフィールドを設定する。
    
    パラメータ:
    
    newQuoteMode - フィールド囲み文字で囲むフィールドを指定するモード
    
    戻り値:
    
    新しいCsvDataBindConfig
  - getQuotedColumnNames
```
public List getQuotedColumnNames()
```
    出力時にフィールド囲み文字(CsvDataBindConfig.getQuote())で囲むフィールドのリストを取得する。
    
    戻り値:
    
    フィールド囲み文字で囲むフィールドのリスト
  - withQuotedColumnNames
```
public CsvDataBindConfig withQuotedColumnNames(String... fieldNames)
```
    フィールド囲み文字(CsvDataBindConfig.getQuote()で囲むフィールドのリストを設定する。
    CsvDataBindConfig.getQuoteMode()がCsvDataBindConfig.QuoteMode.CUSTOMの場合に、設定したフィールドがフィールド囲み文字で囲まれる。
    
    パラメータ:
    
    fieldNames - フィールド囲み文字で囲むフィールド名称
    
    戻り値:
    
    新しいCsvDataBindConfig

クラス CsvDataBindConfig

ネストされたクラスのサマリー

フィールドのサマリー

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

メソッドのサマリー

フィールドの詳細

DEFAULT

RFC4180

EXCEL

TSV

コンストラクタの詳細

CsvDataBindConfig

メソッドの詳細

getFieldSeparator

withFieldSeparator

getLineSeparator

withLineSeparator

getQuote

withQuote

isIgnoreEmptyLine

withIgnoreEmptyLine

withIgnoreEmptyLine

isRequiredHeader

withRequiredHeader

withRequiredHeader

getHeaderTitles

withHeaderTitles

getCharset

withCharset

withCharset

getQuoteMode

withQuoteMode

getQuotedColumnNames

withQuotedColumnNames