com.orangesignal.csv.io.CsvColumnNameMapReader Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of orangesignal-csv Show documentation
Show all versions of orangesignal-csv Show documentation
OrangeSignal CSV is a very flexible csv (comma-separated values) read and write library for Java.
/*
* Copyright 2013 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.orangesignal.csv.io;
import java.io.Closeable;
import java.io.IOException;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import com.orangesignal.csv.CsvReader;
import com.orangesignal.csv.filters.CsvNamedValueFilter;
/**
* 項目名と項目値のマップで区切り文字形式データアクセスを行う区切り文字形式入力ストリームを提供します。
*
* @author Koji Sugisawa
* @since 1.4.0
*/
public class CsvColumnNameMapReader implements Closeable {
/**
* 区切り文字形式入力ストリームを保持します。
*/
private CsvReader reader;
/**
* 項目名のリストを保持します。
*/
private List columnNames;
/**
* 項目名の数を一時的に保存します。
*/
private int columnCount = -1;
/**
* 項目名のマップを一時的に保存します。
*/
private Map base;
/**
* 区切り文字形式データフィルタを保持します。
*/
private CsvNamedValueFilter filter;
// ------------------------------------------------------------------------
// コンストラクタ
/**
* 指定された区切り文字形式入力ストリームを使用して、このクラスを構築するコンストラクタです。
*
* @param reader 区切り文字形式入力ストリーム
* @throws IllegalArgumentException {@code reader} が {@code null} の場合。
*/
public CsvColumnNameMapReader(final CsvReader reader) {
this(reader, null);
}
/**
* 指定された区切り文字形式入力ストリームと項目名のリストを使用して、このクラスを構築するコンストラクタです。
*
* @param reader 区切り文字形式入力ストリーム
* @param columnNames 項目名のリスト
* @throws IllegalArgumentException {@code reader} が {@code null} の場合。
*/
public CsvColumnNameMapReader(final CsvReader reader, final List columnNames) {
if (reader == null) {
throw new IllegalArgumentException("CsvReader must not be null");
}
this.reader = reader;
if (columnNames != null) {
this.columnNames = Collections.unmodifiableList(columnNames);
}
}
// ------------------------------------------------------------------------
// プライベート メソッド
/**
* Checks to make sure that the stream has not been closed
*/
private void ensureOpen() throws IOException {
if (reader == null) {
throw new IOException("CsvReader closed");
}
}
private void ensureHeader() throws IOException {
synchronized (this) {
if (columnNames == null) {
columnNames = Collections.unmodifiableList(reader.readValues());
if (columnNames == null) {
// ヘッダがない場合は例外をスローします。
throw new IOException("No header is available");
}
}
if (columnCount == -1) {
// ヘッダ部を処理します。
columnCount = columnNames.size();
base = new LinkedHashMap(columnCount);
for (final String columnName : columnNames) {
base.put(columnName, null);
}
}
}
}
// ------------------------------------------------------------------------
// オーバーライド メソッド
@Override
public void close() throws IOException {
synchronized (this) {
ensureOpen();
reader.close();
reader = null;
columnNames = null;
columnCount = -1;
base = null;
}
}
// ------------------------------------------------------------------------
// パブリック メソッド
/**
* 項目名のリストを返します。
*
* @return 項目名のリスト
* @throws IOException 入出力エラーが発生した場合
*/
public List getHeader() throws IOException {
synchronized (this) {
ensureOpen();
ensureHeader();
return columnNames;
}
}
/**
* 論理行を読込み項目名と項目値のマップとして返します。
*
* @return 項目名と項目値のマップ。ストリームの終わりに達した場合は {@code null}
* @throws IOException 入出力エラーが発生した場合
*/
public Map read() throws IOException {
synchronized (this) {
ensureOpen();
ensureHeader();
final List values = nextValues();
if (values == null) {
return null;
}
return convert(values);
}
}
/**
* 論理行を読込み CSV トークンの値をリストとして返します。
*
* @return CSV トークンの値をリスト。ストリームの終わりに達している場合は {@code null}
* @throws IOException 入出力エラーが発生した場合
*/
public List readValues() throws IOException {
synchronized (this) {
ensureOpen();
ensureHeader();
return nextValues();
}
}
/**
* 指定された CSV トークンの値をリストを項目名と項目値のマップへ変換して返します。
*
* @param values CSV トークンの値をリスト
* @return 変換された項目名と項目値のマップ
* @throws IOException 入出力エラーが発生した場合
*/
public Map toMap(final List values) throws IOException {
synchronized (this) {
ensureOpen();
ensureHeader();
return convert(values);
}
}
private List nextValues() throws IOException {
List values;
while ((values = reader.readValues()) != null) {
if (filter != null && !filter.accept(columnNames, values)) {
continue;
}
return values;
}
return null;
}
private Map convert(final List values) {
final Map map = new LinkedHashMap(base);
final int len = Math.min(columnCount, values.size());
for (int pos = 0; pos < len; pos++) {
map.put(columnNames.get(pos), values.get(pos));
}
return map;
}
// ------------------------------------------------------------------------
// セッター / ゲッター
/**
* 区切り文字形式データフィルタを返します。
*
* @return 区切り文字形式データフィルタ。または {@code null}
*/
public CsvNamedValueFilter getFilter() {
return filter;
}
/**
* 区切り文字形式データフィルタを設定します。
*
* @param filter 区切り文字形式データフィルタ
*/
public void setFilter(final CsvNamedValueFilter filter) {
synchronized (this) {
this.filter = filter;
}
}
}