com.orangesignal.csv.bean.AbstractCsvBeanTemplate 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.
The newest version!
/*
* 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.bean;
import java.io.IOException;
import java.lang.reflect.Field;
import java.text.Format;
import java.text.ParseException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* Java プログラム要素の操作を簡素化するヘルパーの基底クラスを提供します。
*
* @param Java プログラム要素の型
* @param Java プログラム要素の操作を簡素化するヘルパークラスの型
* @author Koji Sugisawa
* @since 1.4.0
*/
public abstract class AbstractCsvBeanTemplate> {
/**
* Java プログラム要素の型を保持します。
*/
private Class type;
/**
* Java プログラム要素のフィールド名と項目値を解析するオブジェクトのマップを保持します。
*/
private Map valueParserMapping = new HashMap();
/**
* 項目名 (または項目位置) と項目値へ書式化するオブジェクトのマップを保持します。
*/
private Map valueFormatterMapping = new HashMap();
/**
* 区切り文字形式データの項目値コンバータを保持します。
*/
private CsvValueConverter valueConverter = new SimpleCsvValueConverter();
// ------------------------------------------------------------------------
// コンストラクタ
/**
* コンストラクタです。
*
* @param type Java プログラム要素の型
* @throws IllegalArgumentException {@code type} が {@code null} の場合。
*/
protected AbstractCsvBeanTemplate(final Class type) {
if (type == null) {
throw new IllegalArgumentException("Class must not be null");
}
this.type = type;
}
// ------------------------------------------------------------------------
// ゲッター / セッター
/**
* Java プログラム要素の型を返します。
*
* @return Java プログラム要素の型
*/
public Class getType() {
return type;
}
/**
* Java プログラム要素のフィールド名と項目値を解析するオブジェクトのマップを設定します。
*
* @param valueParserMapping Java プログラム要素のフィールド名と項目値を解析するオブジェクトのマップ
* @throws IllegalArgumentException {@code valueParserMapping} が {@code null} の場合
*/
public void setValueParserMapping(final Map valueParserMapping) {
if (valueParserMapping == null) {
throw new IllegalArgumentException("CSV value parser mapping must not be null");
}
this.valueParserMapping = valueParserMapping;
}
/**
* Java プログラム要素のフィールド名と項目値を解析するオブジェクトのマップを設定します。
*
* @param valueParserMapping Java プログラム要素のフィールド名と項目値を解析するオブジェクトのマップ
* @return このオブジェクトへの参照
* @throws IllegalArgumentException {@code valueParserMapping} が {@code null} の場合
*/
@SuppressWarnings("unchecked")
public O valueParserMapping(final Map valueParserMapping) {
setValueParserMapping(valueParserMapping);
return (O) this;
}
/**
* 項目名 (または項目位置) と項目値へ書式化するオブジェクトのマップを設定します。
*
* @param valueFormatterMapping 項目名 (または項目位置) と項目値へ書式化するオブジェクトのマップ
* @throws IllegalArgumentException {@code valueFormaterMapping} が {@code null} の場合
*/
public void setValueFormatterMapping(final Map valueFormatterMapping) {
if (valueFormatterMapping == null) {
throw new IllegalArgumentException("CSV value formatter mapping must not be null");
}
this.valueFormatterMapping = valueFormatterMapping;
}
/**
* 項目名 (または項目位置) と項目値へ書式化するオブジェクトのマップを設定します。
*
* @param valueFormatterMapping 項目名 (または項目位置) と項目値へ書式化するオブジェクトのマップ
* @return このオブジェクトへの参照
* @throws IllegalArgumentException {@code valueFormaterMapping} が {@code null} の場合
*/
@SuppressWarnings("unchecked")
public O valueFormatterMapping(final Map valueFormatterMapping) {
setValueFormatterMapping(valueFormatterMapping);
return (O) this;
}
/**
* 区切り文字形式データの項目値コンバータを設定します。
*
* @param valueConverter 区切り文字形式データの項目値コンバータ
* @throws IllegalArgumentException {@code valueConverter} が {@code null} の場合
*/
public void setValueConverter(final CsvValueConverter valueConverter) {
if (valueConverter == null) {
throw new IllegalArgumentException("CsvValueConverter must not be null");
}
this.valueConverter = valueConverter;
}
/**
* 区切り文字形式データの項目値コンバータを設定します。
*
* @param valueConverter 区切り文字形式データの項目値コンバータ
* @return このオブジェクトへの参照
* @throws IllegalArgumentException {@code valueConverter} が {@code null} の場合
*/
@SuppressWarnings("unchecked")
public O valueConverter(final CsvValueConverter valueConverter) {
setValueConverter(valueConverter);
return (O) this;
}
// ------------------------------------------------------------------------
/**
* 指定された Java プログラム要素のフィールドを処理するフォーマットオブジェクトを設定します。
*
* @param name Java プログラム要素のフィールド名
* @param format フィールドを処理するフォーマットオブジェクト
* @return このオブジェクトへの参照
*/
@SuppressWarnings("unchecked")
public O format(final String name, final Format format) {
setValueParser(name, format);
setValueFormatter(name, format);
return (O) this;
}
/**
* 指定された Java プログラム要素のフィールド名と項目値を解析するオブジェクトをマップへ追加します。
*
* 指定されたフィールド名に既に項目値を解析するオブジェクトが設定されている場合、
* 既存の項目値解析オブジェクトへパラメータで指定された項目値解析オブジェクトのパターン文字列を追加します。
*
*
* @param field Java プログラム要素のフィールド名
* @param parser 項目値を解析するオブジェクト
*/
public void setValueParser(final String field, final Format parser) {
final Format src = valueParserMapping.get(field);
if (src != null) {
valueParserMapping.put(field, FormatUtils.mergeFormatPattern(src, parser));
} else {
valueParserMapping.put(field, parser);
}
}
/**
* 指定された項目名 (または項目位置) と項目値へ書式化するオブジェクトをマップへ追加します。
*
* @param column 項目名 (または項目位置)
* @param formatter 項目値へ書式化するオブジェクト
*/
public void setValueFormatter(final Object column, final Format formatter) {
valueFormatterMapping.put(column, formatter);
}
/**
* Java プログラム要素の型が表すクラスの新しいインスタンスを生成します。
*
* @return Java プログラム要素の型が表す、クラスの新しく割り当てられたインスタンス
* @throws IOException Java プログラム要素のインスタンス化に失敗した場合
*/
public T createBean() throws IOException {
try {
return type.newInstance();
} catch (final IllegalAccessException e) {
throw new IOException("Cannot create " + type.getName() + ": " + e.getMessage(), e);
} catch (final InstantiationException e) {
throw new IOException("Cannot create " + type.getName() + ": " + e.getMessage(), e);
}
}
/**
* 指定された項目名 (または項目位置) と Java プログラム要素のフィールド名のマップと Java プログラム要素の型から、
* Java プログラム要素のフィールド名と項目名群のマップを構築して返します。
*
* @param map 項目名 (または項目位置) と Java プログラム要素のフィールド名のマップ
* @return Java プログラム要素のフィールド名と項目名群のマップ
*/
public Map createFieldAndColumnsMap(final Map map) {
final Map results = new HashMap();
for (final Field f : type.getDeclaredFields()) {
final String fieldName = f.getName();
final List