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.IOException;
21  import java.lang.reflect.Field;
22  import java.util.Collections;
23  import java.util.List;
24  import java.util.Map;
25  
26  import com.orangesignal.csv.CsvReader;
27  import com.orangesignal.csv.bean.CsvColumnPositionMappingBeanTemplate;
28  import com.orangesignal.csv.bean.FieldUtils;
29  
30  /**
31   * 区切り文字形式データの項目位置を基準として Java プログラム要素と区切り文字形式データアクセスを行う区切り文字形式入力ストリームを提供します。
32   * 
33   * @author Koji Sugisawa
34   * @since 1.4.0
35   */
36  public class CsvColumnPositionMappingBeanReader<T> implements Closeable {
37  
38  	/**
39  	 * 区切り文字形式入力ストリームを保持します。
40  	 */
41  	private CsvReader reader;
42  
43  	/**
44  	 * Java プログラム要素操作の簡素化ヘルパーを保持します。
45  	 */
46  	private final CsvColumnPositionMappingBeanTemplate<T> template;
47  
48  	/**
49  	 * 項目名のリストを保持します。
50  	 */
51  	private List<String> columnNames;
52  
53  	private Field[] fields;
54  	private Map<String, Object[]> fieldColumnsMap;
55  
56  	// ------------------------------------------------------------------------
57  	// 利便性のための静的メソッド
58  
59  	/**
60  	 * 新しい {@link CsvColumnPositionMappingBeanReader} のインスタンスを返します。
61  	 * このメソッドは利便性のために提供しています。
62  	 * 
63  	 * @param reader 区切り文字形式入力ストリーム
64  	 * @param type Java プログラム要素の型
65  	 * @return 新しい {@link CsvColumnPositionMappingBeanReader} のインスタンス
66  	 * @throws IllegalArgumentException {@code reader} または {@code type} が {@code null} の場合。
67  	 */
68  	public static <T> CsvColumnPositionMappingBeanReader<T> newInstance(final CsvReader reader, final Class<T> type) {
69  		return new CsvColumnPositionMappingBeanReader<T>(reader, type);
70  	}
71  
72  	/**
73  	 * 新しい {@link CsvColumnPositionMappingBeanReader} のインスタンスを返します。
74  	 * このメソッドは利便性のために提供しています。
75  	 * 
76  	 * @param reader 区切り文字形式入力ストリーム
77  	 * @param template Java プログラム要素操作の簡素化ヘルパー
78  	 * @return 新しい {@link CsvColumnPositionMappingBeanReader} のインスタンス
79  	 * @throws IllegalArgumentException {@code reader} または {@code template} が {@code null} の場合。
80  	 */
81  	public static <T> CsvColumnPositionMappingBeanReader<T> newInstance(final CsvReader reader, final CsvColumnPositionMappingBeanTemplate<T> template) {
82  		return new CsvColumnPositionMappingBeanReader<T>(reader, template);
83  	}
84  
85  	// ------------------------------------------------------------------------
86  	// コンストラクタ
87  
88  	/**
89  	 * 指定された区切り文字形式入力ストリームと Java プログラム要素操作の簡素化ヘルパーを使用して、このクラスを構築するコンストラクタです。
90  	 * 
91  	 * @param reader 区切り文字形式入力ストリーム
92  	 * @param type Java プログラム要素の型
93  	 * @throws IllegalArgumentException {@code reader} または {@code type} が {@code null} の場合。
94  	 */
95  	public CsvColumnPositionMappingBeanReader(final CsvReader reader, final Class<T> type) {
96  		this(reader, new CsvColumnPositionMappingBeanTemplate<T>(type));
97  	}
98  
99  	/**
100 	 * 指定された区切り文字形式入力ストリームと Java プログラム要素操作の簡素化ヘルパーを使用して、このクラスを構築するコンストラクタです。
101 	 * 
102 	 * @param reader 区切り文字形式入力ストリーム
103 	 * @param template Java プログラム要素操作の簡素化ヘルパー
104 	 * @throws IllegalArgumentException {@code reader} または {@code template} が {@code null} の場合。
105 	 */
106 	public CsvColumnPositionMappingBeanReader(final CsvReader reader, final CsvColumnPositionMappingBeanTemplate<T> template) {
107 		if (reader == null) {
108 			throw new IllegalArgumentException("CsvReader must not be null");
109 		}
110 		if (template == null) {
111 			throw new IllegalArgumentException("CsvColumnPositionMappingBeanTemplate must not be null");
112 		}
113 		this.reader = reader;
114 		this.template = template;
115 	}
116 
117 	// ------------------------------------------------------------------------
118 	// プライベート メソッド
119 
120 	/**
121 	 * Checks to make sure that the stream has not been closed
122 	 */
123 	private void ensureOpen() throws IOException {
124 		if (reader == null) {
125 			throw new IOException("CsvReader closed");
126 		}
127 	}
128 
129 	private void ensureHeader() throws IOException {
130 		synchronized (this) {
131 			if (columnNames == null) {
132 				// 項目位置とフィールド名のマップが指定されていない場合は、最初の行をヘッダとして読込んでマップを作成します。
133 				if (template.getMaxColumnPosition() == -1) {
134 					final List<String> names = reader.readValues();
135 					if (names == null) {
136 						// ヘッダがない場合は例外をスローします。
137 						throw new IOException("No header is available");
138 					}
139 					for (final String name : names) {
140 						template.column(name);
141 					}
142 				}
143 				columnNames = Collections.unmodifiableList(template.createColumnNames());
144 				fields = template.getType().getDeclaredFields();
145 				fieldColumnsMap = template.createFieldAndColumnsMap();
146 			}
147 		}
148 	}
149 
150 	// ------------------------------------------------------------------------
151 	// オーバーライド メソッド
152 
153 	@Override
154 	public void close() throws IOException {
155 		synchronized (this) {
156 			ensureOpen();
157 			reader.close();
158 			reader = null;
159 			columnNames = null;
160 			fields = null;
161 			fieldColumnsMap = null;
162 		}
163 	}
164 
165 	// ------------------------------------------------------------------------
166 	// パブリック メソッド
167 
168 	/**
169 	 * 項目名のリストを返します。
170 	 * 
171 	 * @return 項目名のリスト
172 	 * @throws IOException 入出力エラーが発生した場合
173 	 */
174 	public List<String> getHeader() throws IOException {
175 		synchronized (this) {
176 			ensureOpen();
177 			ensureHeader();
178 			return columnNames;
179 		}
180 	}
181 
182 	/**
183 	 * 論理行を読込み Java プログラム要素として返します。
184 	 *
185 	 * @return Java プログラム要素。ストリームの終わりに達した場合は {@code null}
186 	 * @throws IOException 入出力エラーが発生した場合
187 	 */
188 	public T read() throws IOException {
189 		synchronized (this) {
190 			ensureOpen();
191 			ensureHeader();
192 			final List<String> values = nextValues();
193 			if (values == null) {
194 				return null;
195 			}
196 			return convert(values);
197 		}
198 	}
199 
200 	/**
201 	 * 論理行を読込み CSV トークンの値をリストとして返します。
202 	 * 
203 	 * @return CSV トークンの値をリスト。ストリームの終わりに達している場合は {@code null}
204 	 * @throws IOException 入出力エラーが発生した場合
205 	 */
206 	public List<String> readValues() throws IOException {
207 		synchronized (this) {
208 			ensureOpen();
209 			ensureHeader();
210 			return nextValues();
211 		}
212 	}
213 
214 	/**
215 	 * 指定された CSV トークンの値をリストを Java プログラム要素へ変換して返します。
216 	 * 
217 	 * @param values CSV トークンの値をリスト
218 	 * @return 変換された Java プログラム要素
219 	 * @throws IOException 入出力エラーが発生した場合
220 	 */
221 	public T toBean(final List<String> values) throws IOException {
222 		synchronized (this) {
223 			ensureOpen();
224 			ensureHeader();
225 			return convert(values);
226 		}
227 	}
228 
229 	private List<String> nextValues() throws IOException {
230 		List<String> values;
231 		while ((values = reader.readValues()) != null) {
232 			if (template.isAccept(values)) {
233 				continue;
234 			}
235 			return values;
236 		}
237 		return null;
238 	}
239 
240 	@SuppressWarnings("null")
241 	private T convert(final List<String> values) throws IOException {
242 		final T bean = template.createBean();
243 		for (final Field f : fields) {
244 			final Object[] columns = fieldColumnsMap.get(f.getName());
245 			final int count = columns == null ? 0 : columns.length;
246 
247 			Object o = null;
248 			if (count == 1) {
249 				final int pos = (Integer) columns[0];
250 				if (pos >= 0) {
251 					o = template.stringToObject(f, values.get(pos));
252 				}
253 			} else if (count > 1) {
254 				final StringBuilder sb = new StringBuilder();
255 				for (final Object column : columns) {
256 					final int pos = (Integer) column;
257 					if (pos >= 0) {
258 						final String s = values.get(pos);
259 						if (s != null) {
260 							sb.append(s);
261 						}
262 					}
263 				}
264 				o = template.stringToObject(f, sb.toString());
265 			}
266 			if (o != null) {
267 				FieldUtils.setFieldValue(bean, f, o);
268 			}
269 		}
270 		return bean;
271 	}
272 
273 	// ------------------------------------------------------------------------
274 	// getter / setter
275 
276 	/**
277 	 * Java プログラム要素操作の簡素化ヘルパーを返します。
278 	 * 
279 	 * @return Java プログラム要素操作の簡素化ヘルパー
280 	 * @since 2.1
281 	 */
282 	public CsvColumnPositionMappingBeanTemplate<T> getTemplate() {
283 		return template;
284 	}
285 
286 }