View Javadoc
1   /*
2    * Copyright 2013 the original author or authors.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package com.orangesignal.csv.io;
18  
19  import java.io.Closeable;
20  import java.io.Flushable;
21  import java.io.IOException;
22  import java.util.ArrayList;
23  import java.util.Arrays;
24  import java.util.Collections;
25  import java.util.List;
26  import java.util.Map;
27  
28  import com.orangesignal.csv.CsvWriter;
29  import com.orangesignal.csv.filters.CsvNamedValueFilter;
30  
31  /**
32   * 項目名と項目値のマップで区切り文字形式データアクセスを行う区切り文字形式出力ストリームを提供します。
33   * 
34   * @author Koji Sugisawa
35   * @since 1.4.0
36   */
37  public class CsvColumnNameMapWriter implements Closeable, Flushable {
38  
39  	/**
40  	 * 区切り文字形式出力ストリームを保持します。
41  	 */
42  	private CsvWriter writer;
43  
44  	/**
45  	 * 項目名のリストを保持します。
46  	 */
47  	private List<String> columnNames;
48  
49  	/**
50  	 * 区切り文字形式データの列見出し (ヘッダ) 行を出力するかどうかを保持します。
51  	 * 
52  	 * @since 2.1
53  	 */
54  	private final boolean header;
55  
56  	/**
57  	 * 項目名の数を保存します。
58  	 */
59  	private int columnCount = -1;
60  
61  	/**
62  	 * 区切り文字形式データフィルタを保持します。
63  	 */
64  	private CsvNamedValueFilter filter;
65  
66  	// ------------------------------------------------------------------------
67  	// コンストラクタ
68  
69  	/**
70  	 * 指定された区切り文字形式出力ストリームを使用して、このクラスを構築するコンストラクタです。
71  	 * 
72  	 * @param writer 区切り文字形式出力ストリーム
73  	 * @throws IllegalArgumentException {@code writer} が {@code null} の場合。
74  	 */
75  	public CsvColumnNameMapWriter(final CsvWriter writer) {
76  		this(writer, null, true);
77  	}
78  
79  	/**
80  	 * 指定された区切り文字形式出力ストリームを使用して、このクラスを構築するコンストラクタです。
81  	 * 
82  	 * @param writer 区切り文字形式出力ストリーム
83  	 * @param header 区切り文字形式データの列見出し (ヘッダ) 行を出力するかどうか
84  	 * @throws IllegalArgumentException {@code writer} が {@code null} の場合。
85  	 * @since 2.1
86  	 */
87  	public CsvColumnNameMapWriter(final CsvWriter writer, final boolean header) {
88  		this(writer, null, header);
89  	}
90  
91  	/**
92  	 * 指定された区切り文字形式出力ストリームと項目名のリストを使用して、このクラスを構築するコンストラクタです。
93  	 * 
94  	 * @param writer 区切り文字形式出力ストリーム
95  	 * @param columnNames 項目名のリスト
96  	 * @throws IllegalArgumentException {@code writer} が {@code null} の場合。
97  	 */
98  	public CsvColumnNameMapWriter(final CsvWriter writer, final List<String> columnNames) {
99  		this(writer, columnNames, true);
100 	}
101 
102 	/**
103 	 * 指定された区切り文字形式出力ストリームと項目名のリストを使用して、このクラスを構築するコンストラクタです。
104 	 * 
105 	 * @param writer 区切り文字形式出力ストリーム
106 	 * @param columnNames 項目名のリスト
107 	 * @param header 区切り文字形式データの列見出し (ヘッダ) 行を出力するかどうか
108 	 * @throws IllegalArgumentException {@code writer} が {@code null} の場合。
109 	 * @since 2.1
110 	 */
111 	public CsvColumnNameMapWriter(final CsvWriter writer, final List<String> columnNames, final boolean header) {
112 		if (writer == null) {
113 			throw new IllegalArgumentException("CsvWriter must not be null");
114 		}
115 		this.writer = writer;
116 
117 		if (columnNames != null) {
118 			this.columnNames = Collections.unmodifiableList(columnNames);
119 		}
120 		this.header = header;
121 	}
122 
123 	// ------------------------------------------------------------------------
124 	// プライベート メソッド
125 
126 	/**
127 	 * Checks to make sure that the stream has not been closed
128 	 */
129 	private void ensureOpen() throws IOException {
130 		if (writer == null) {
131 			throw new IOException("CsvWriter closed");
132 		}
133 	}
134 
135 	private void ensureHeader(final Map<String, String> map) throws IOException {
136 		if (columnNames == null && map != null) {
137 			columnNames = new ArrayList<String>(map.keySet());
138 		}
139 		if (columnNames == null) {
140 			// ヘッダがない場合は例外をスローします。
141 			throw new IOException("No header is available");
142 		}
143 		if (columnCount == -1) {
144 			if (header) {
145 				// ヘッダ部を処理します。
146 				writer.writeValues(columnNames);
147 			}
148 			columnCount = columnNames.size();
149 		}
150 	}
151 
152 	// ------------------------------------------------------------------------
153 	// オーバーライド メソッド
154 
155 	@Override
156 	public void flush() throws IOException {
157 		synchronized (this) {
158 			ensureOpen();
159 			writer.flush();
160 		}
161 	}
162 
163 	@Override
164 	public void close() throws IOException {
165 		synchronized (this) {
166 			ensureOpen();
167 			writer.close();
168 			writer = null;
169 			columnNames = null;
170 			columnCount = -1;
171 		}
172 	}
173 
174 	// ------------------------------------------------------------------------
175 	// パブリック メソッド
176 
177 	/**
178 	 * 可能であれば項目名を書き込みます。項目名が既に書き込まれている場合、このメソッドは何も行いません。
179 	 * 
180 	 * @param map 項目名と項目値のマップ
181 	 * @throws IOException 入出力エラーが発生した場合
182 	 */
183 	public void writeHeader(final Map<String, String> map) throws IOException {
184 		synchronized (this) {
185 			ensureOpen();
186 			ensureHeader(map);
187 		}
188 	}
189 
190 	/**
191 	 * 指定された項目名と項目値のマップを書き込みます。項目名の書き込みが必要な場合は自動的に書き込みが行われます。
192 	 * 
193 	 * @param map 項目名と項目値のマップ
194 	 * @return 区切り文字形式データフィルタによって書き込みが行われなかった場合は {@code false} それ以外の場合は {@code true}
195 	 * @throws IOException 入出力エラーが発生した場合
196 	 */
197 	public boolean write(final Map<String, String> map) throws IOException {
198 		synchronized (this) {
199 			ensureOpen();
200 			ensureHeader(map);
201 
202 			// 要素が null の場合は null 出力します。
203 			if (map == null) {
204 				writer.writeValues(null);
205 				return true;
206 			}
207 
208 			final List<String> values = toValues(map);
209 			if (filter != null && !filter.accept(columnNames, values)) {
210 				return false;
211 			}
212 			writer.writeValues(values);
213 			return true;
214 		}
215 	}
216 
217 	private List<String> toValues(final Map<String, String> map) {
218 		final String[] values = new String[columnCount];
219 		for (int i = 0; i < columnCount; i++) {
220 			values[i] = map.get(columnNames.get(i));
221 		}
222 		return Arrays.asList(values);
223 	}
224 
225 	// ------------------------------------------------------------------------
226 	// セッター / ゲッター
227 
228 	/**
229 	 * 区切り文字形式データフィルタを返します。
230 	 * 
231 	 * @return 区切り文字形式データフィルタ。または {@code null}
232 	 */
233 	public CsvNamedValueFilter getFilter() {
234 		return filter;
235 	}
236 
237 	/**
238 	 * 区切り文字形式データフィルタを設定します。
239 	 * 
240 	 * @param filter 区切り文字形式データフィルタ
241 	 */
242 	public void setFilter(final CsvNamedValueFilter filter) {
243 		synchronized (this) {
244 			this.filter = filter;
245 		}
246 	}
247 
248 }