com.orangesignal.csv.io

クラス CsvColumnNameMapReader

java.lang.Object

com.orangesignal.csv.io.CsvColumnNameMapReader

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

Closeable, AutoCloseable

public class CsvColumnNameMapReader
extends Object
implements Closeable

項目名と項目値のマップで区切り文字形式データアクセスを行う区切り文字形式入力ストリームを提供します。

導入されたバージョン:

1.4.0

作成者:

Koji Sugisawa

コンストラクタの概要

コンストラクタ

コンストラクタと説明
CsvColumnNameMapReader(CsvReader reader) 指定された区切り文字形式入力ストリームを使用して、このクラスを構築するコンストラクタです。
CsvColumnNameMapReader(CsvReader reader, List<String> columnNames) 指定された区切り文字形式入力ストリームと項目名のリストを使用して、このクラスを構築するコンストラクタです。

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
void	close()
CsvNamedValueFilter	getFilter() 区切り文字形式データフィルタを返します。
List<String>	getHeader() 項目名のリストを返します。
Map<String,String>	read() 論理行を読込み項目名と項目値のマップとして返します。
List<String>	readValues() 論理行を読込み CSV トークンの値をリストとして返します。
void	setFilter(CsvNamedValueFilter filter) 区切り文字形式データフィルタを設定します。
Map<String,String>	toMap(List<String> values) 指定された CSV トークンの値をリストを項目名と項目値のマップへ変換して返します。

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

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

コンストラクタの詳細

CsvColumnNameMapReader

public CsvColumnNameMapReader(CsvReader reader)

指定された区切り文字形式入力ストリームを使用して、このクラスを構築するコンストラクタです。

パラメータ:

reader - 区切り文字形式入力ストリーム

例外:

IllegalArgumentException - reader が null の場合。

CsvColumnNameMapReader

public CsvColumnNameMapReader(CsvReader reader,
                      List<String> columnNames)

指定された区切り文字形式入力ストリームと項目名のリストを使用して、このクラスを構築するコンストラクタです。

パラメータ:

reader - 区切り文字形式入力ストリーム

columnNames - 項目名のリスト

例外:

IllegalArgumentException - reader が null の場合。

メソッドの詳細

close

public void close()
           throws IOException

定義:

close インタフェース内 Closeable

定義:

close インタフェース内 AutoCloseable

例外:

IOException

getHeader

public List<String> getHeader()
                       throws IOException

項目名のリストを返します。

戻り値:

項目名のリスト

例外:

IOException - 入出力エラーが発生した場合

read

public Map<String,String> read()
                        throws IOException

論理行を読込み項目名と項目値のマップとして返します。

戻り値:

項目名と項目値のマップ。ストリームの終わりに達した場合は null

例外:

IOException - 入出力エラーが発生した場合

readValues

public List<String> readValues()
                        throws IOException

論理行を読込み CSV トークンの値をリストとして返します。

戻り値:

CSV トークンの値をリスト。ストリームの終わりに達している場合は null

例外:

IOException - 入出力エラーが発生した場合

toMap

public Map<String,String> toMap(List<String> values)
                         throws IOException

指定された CSV トークンの値をリストを項目名と項目値のマップへ変換して返します。

パラメータ:

values - CSV トークンの値をリスト

戻り値:

変換された項目名と項目値のマップ

例外:

IOException - 入出力エラーが発生した場合

getFilter

public CsvNamedValueFilter getFilter()

区切り文字形式データフィルタを返します。

戻り値:

区切り文字形式データフィルタ。または null

setFilter

public void setFilter(CsvNamedValueFilter filter)

区切り文字形式データフィルタを設定します。

パラメータ:

filter - 区切り文字形式データフィルタ