com.orangesignal.csv.io.CsvEntityWriter 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 2014 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 static com.orangesignal.csv.bean.CsvEntityTemplate.defaultIfEmpty;
import static com.orangesignal.csv.bean.FieldUtils.getFieldValue;
import java.io.Closeable;
import java.io.Flushable;
import java.io.IOException;
import java.lang.reflect.Array;
import java.lang.reflect.Field;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import com.orangesignal.csv.CsvWriter;
import com.orangesignal.csv.annotation.CsvColumn;
import com.orangesignal.csv.annotation.CsvColumns;
import com.orangesignal.csv.annotation.CsvEntity;
import com.orangesignal.csv.annotation.CsvColumnException;
import com.orangesignal.csv.bean.CsvEntityTemplate;
/**
* 区切り文字形式データ注釈要素 {@link CsvEntity} で注釈付けされた Java プログラム要素で区切り文字形式データアクセスを行う区切り文字形式出力ストリームを提供します。
*
* @author Koji Sugisawa
* @since 1.4.0
*/
public class CsvEntityWriter implements Closeable, Flushable {
/**
* 区切り文字形式出力ストリームを保持します。
*/
private CsvWriter writer;
/**
* Java プログラム要素操作の簡素化ヘルパーを保持します。
*/
private final CsvEntityTemplate template;
/**
* 区切り文字形式データの列見出し (ヘッダ) 行の出力を無効化するかどうかを保持します。
*
* @since 2.2
*/
private final boolean disableWriteHeader;
/**
* 項目名のリストを保持します。
*/
private List columnNames;
private int columnCount = -1;
// ------------------------------------------------------------------------
// 利便性のための静的メソッド
/**
* 新しい {@link CsvEntityWriter} のインスタンスを返します。
* このメソッドは利便性のために提供しています。
*
* @param writer 区切り文字形式出力ストリーム
* @param entityClass 区切り文字形式データ注釈要素 {@link CsvEntity} で注釈付けされた Java プログラム要素の型
* @return 新しい {@link CsvEntityWriter} のインスタンス
* @throws IllegalArgumentException {@code writer} または {@code entityClass} が {@code null} の場合。
*/
public static CsvEntityWriter newInstance(final CsvWriter writer, final Class entityClass) {
return new CsvEntityWriter(writer, entityClass);
}
/**
* 新しい {@link CsvEntityWriter} のインスタンスを返します。
* このメソッドは利便性のために提供しています。
*
* @param writer 区切り文字形式出力ストリーム
* @param entityClass 区切り文字形式データ注釈要素 {@link CsvEntity} で注釈付けされた Java プログラム要素の型
* @param disableWriteHeader 区切り文字形式データの列見出し (ヘッダ) 行の出力を無効化するかどうか
* @return 新しい {@link CsvEntityWriter} のインスタンス
* @throws IllegalArgumentException {@code writer} または {@code entityClass} が {@code null} の場合。
* @since 2.2
*/
public static CsvEntityWriter newInstance(final CsvWriter writer, final Class entityClass, final boolean disableWriteHeader) {
return new CsvEntityWriter(writer, entityClass, disableWriteHeader);
}
/**
* 新しい {@link CsvEntityWriter} のインスタンスを返します。
* このメソッドは利便性のために提供しています。
*
* @param writer 区切り文字形式出力ストリーム
* @param template Java プログラム要素操作の簡素化ヘルパー
* @return 新しい {@link CsvEntityWriter} のインスタンス
* @throws IllegalArgumentException {@code writer} または {@code template} が {@code null} の場合。
*/
public static CsvEntityWriter newInstance(final CsvWriter writer, final CsvEntityTemplate template) {
return new CsvEntityWriter(writer, template);
}
/**
* 新しい {@link CsvEntityWriter} のインスタンスを返します。
* このメソッドは利便性のために提供しています。
*
* @param writer 区切り文字形式出力ストリーム
* @param template Java プログラム要素操作の簡素化ヘルパー
* @param disableWriteHeader 区切り文字形式データの列見出し (ヘッダ) 行の出力を無効化するかどうか
* @return 新しい {@link CsvEntityWriter} のインスタンス
* @throws IllegalArgumentException {@code writer} または {@code template} が {@code null} の場合。
* @since 2.2
*/
public static CsvEntityWriter newInstance(final CsvWriter writer, final CsvEntityTemplate template, final boolean disableWriteHeader) {
return new CsvEntityWriter(writer, template, disableWriteHeader);
}
// ------------------------------------------------------------------------
// コンストラクタ
/**
* 指定された区切り文字形式出力ストリームと Java プログラム要素の型を使用して、このクラスを構築するコンストラクタです。
*
* @param writer 区切り文字形式出力ストリーム
* @param entityClass 区切り文字形式データ注釈要素 {@link CsvEntity} で注釈付けされた Java プログラム要素の型
* @throws IllegalArgumentException {@code writer} または {@code entityClass} が {@code null} の場合。
*/
public CsvEntityWriter(final CsvWriter writer, final Class entityClass) {
this(writer, new CsvEntityTemplate(entityClass), false);
}
/**
* 指定された区切り文字形式出力ストリームと Java プログラム要素の型を使用して、このクラスを構築するコンストラクタです。
*
* @param writer 区切り文字形式出力ストリーム
* @param entityClass 区切り文字形式データ注釈要素 {@link CsvEntity} で注釈付けされた Java プログラム要素の型
* @param disableWriteHeader 区切り文字形式データの列見出し (ヘッダ) 行の出力を無効化するかどうか
* @throws IllegalArgumentException {@code writer} または {@code entityClass} が {@code null} の場合。
* @since 2.2
*/
public CsvEntityWriter(final CsvWriter writer, final Class entityClass, final boolean disableWriteHeader) {
this(writer, new CsvEntityTemplate(entityClass), disableWriteHeader);
}
/**
* 指定された区切り文字形式出力ストリームと Java プログラム要素操作の簡素化ヘルパーを使用して、このクラスを構築するコンストラクタです。
*
* @param writer 区切り文字形式出力ストリーム
* @param template Java プログラム要素操作の簡素化ヘルパー
* @throws IllegalArgumentException {@code writer} または {@code template} が {@code null} の場合。
*/
public CsvEntityWriter(final CsvWriter writer, final CsvEntityTemplate template) {
this(writer, template, false);
}
/**
* 指定された区切り文字形式出力ストリームと Java プログラム要素操作の簡素化ヘルパーを使用して、このクラスを構築するコンストラクタです。
*
* @param writer 区切り文字形式出力ストリーム
* @param template Java プログラム要素操作の簡素化ヘルパー
* @param disableWriteHeader 区切り文字形式データの列見出し (ヘッダ) 行の出力を無効化するかどうか
* @throws IllegalArgumentException {@code writer} または {@code template} が {@code null} の場合。
* @since 2.2
*/
public CsvEntityWriter(final CsvWriter writer, final CsvEntityTemplate template, final boolean disableWriteHeader) {
if (writer == null) {
throw new IllegalArgumentException("CsvWriter must not be null");
}
if (template == null) {
throw new IllegalArgumentException("CsvEntityTemplate must not be null");
}
this.writer = writer;
this.template = template;
this.disableWriteHeader = disableWriteHeader;
}
// ------------------------------------------------------------------------
// プライベート メソッド
/**
* Checks to make sure that the stream has not been closed
*/
private void ensureOpen() throws IOException {
if (writer == null) {
throw new IOException("CsvWriter closed");
}
}
private void ensureHeader() throws IOException {
synchronized (this) {
if (columnNames == null) {
final List names = template.createWritableColumnNames();
// ヘッダ行が有効な場合は項目名の一覧を出力します。
if (!disableWriteHeader && template.getType().getAnnotation(CsvEntity.class).header()) {
writer.writeValues(names);
}
template.prepare(names, template.getType().getDeclaredFields());
columnNames = Collections.unmodifiableList(names);
columnCount = names.size();
}
}
}
// ------------------------------------------------------------------------
// オーバーライド メソッド
@Override
public void flush() throws IOException {
synchronized (this) {
ensureOpen();
writer.flush();
}
}
@Override
public void close() throws IOException {
synchronized (this) {
ensureOpen();
writer.close();
writer = null;
columnNames = null;
columnCount = -1;
}
}
// ------------------------------------------------------------------------
// パブリック メソッド
/**
* 可能であれば項目名を書き込みます。項目名が既に書き込まれている場合や、
* 区切り文字形式データの列見出し (ヘッダ) 行の出力が無効化されている場合、このメソッドは何も行いません。
*
* @throws IOException 入出力エラーが発生した場合
* @see {@link #isDisableWriteHeader()}
*/
public void writeHeader() throws IOException {
synchronized (this) {
ensureOpen();
ensureHeader();
}
}
/**
* 指定された Java プログラム要素を区切り文字形式で書き込みます。
* {@code null} が指定された場合は空行が書き込まれます。
*
* @param entity 書き込む Java プログラム要素。または {@code null}
* @return データの出力を行った場合は {@code true} それ以外の場合 (フィルタにより書き込みがスキップされた場合) は {@code false}
* @throws CsvColumnException 区切り文字形式のデータ項目の検証操作実行中にエラーが発生した場合
* @throws IOException 入出力エラーが発生した場合
*/
public boolean write(final T entity) throws IOException {
synchronized (this) {
ensureOpen();
ensureHeader();
// 要素が null の場合は null 出力します。
if (entity == null || entity.getClass().getAnnotation(CsvEntity.class) == null) {
writer.writeValues(null);
return true;
}
final List values = toValues(entity);
if (template.isAccept(columnNames, values)) {
return false;
}
writer.writeValues(values);
return true;
}
}
private List toValues(final T entity) throws IOException {
final String[] values = new String[columnCount];
for (final Field field : entity.getClass().getDeclaredFields()) {
final CsvColumns columns = field.getAnnotation(CsvColumns.class);
if (columns != null) {
int arrayIndex = 0;
for (final CsvColumn column : columns.value()) {
if (!column.access().isWriteable()) {
arrayIndex++;
continue;
}
int pos = column.position();
if (pos < 0) {
pos = columnNames.indexOf(defaultIfEmpty(column.name(), field.getName()));
}
if (pos == -1) {
throw new IOException(String.format("Invalid CsvColumn field %s", field.getName()));
}
Object o = getFieldValue(entity, field);
if (field.getType().isArray()) {
if (o != null) {
o = Array.get(o, arrayIndex);
}
arrayIndex++;
}
values[pos] = template.objectToString(pos, o);
if (values[pos] == null && !column.defaultValue().isEmpty()) {
// デフォルト値が指定されていて、値がない場合はデフォルト値を代入します。
values[pos] = column.defaultValue();
}
if (values[pos] == null && column.required()) {
throw new CsvColumnException(String.format("%s must not be null", columnNames.get(pos)), entity);
}
}
}
final CsvColumn column = field.getAnnotation(CsvColumn.class);
if (column != null && column.access().isWriteable()) {
int pos = column.position();
if (pos < 0) {
pos = columnNames.indexOf(defaultIfEmpty(column.name(), field.getName()));
}
if (pos == -1) {
throw new IOException(String.format("Invalid CsvColumn field %s", field.getName()));
}
values[pos] = template.objectToString(pos, getFieldValue(entity, field));
if (values[pos] == null && !column.defaultValue().isEmpty()) {
// デフォルト値が指定されていて、値がない場合はデフォルト値を代入します。
values[pos] = column.defaultValue();
}
if (values[pos] == null && column.required()) {
throw new CsvColumnException(String.format("%s must not be null", columnNames.get(pos)), entity);
}
}
}
return Arrays.asList(values);
}
// ------------------------------------------------------------------------
// getter / setter
/**
* Java プログラム要素操作の簡素化ヘルパーを返します。
*
* @return Java プログラム要素操作の簡素化ヘルパー
* @since 2.1
*/
public CsvEntityTemplate getTemplate() {
return template;
}
/**
* 区切り文字形式データの列見出し (ヘッダ) 行の出力が無効化されているかどうかを返します。
*
* @return 区切り文字形式データの列見出し (ヘッダ) 行の出力が無効化されているかどうか
* @since 2.2
*/
public boolean isDisableWriteHeader() {
return disableWriteHeader;
}
}