001 /**
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 * http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017 package org.apache.camel.dataformat.bindy.csv;
018
019 import java.io.InputStream;
020 import java.io.InputStreamReader;
021 import java.io.OutputStream;
022 import java.util.ArrayList;
023 import java.util.Arrays;
024 import java.util.HashMap;
025 import java.util.Iterator;
026 import java.util.List;
027 import java.util.Map;
028 import java.util.Scanner;
029
030 import org.apache.camel.Exchange;
031 import org.apache.camel.dataformat.bindy.BindyCsvFactory;
032 import org.apache.camel.dataformat.bindy.util.Converter;
033 import org.apache.camel.spi.DataFormat;
034 import org.apache.camel.spi.PackageScanClassResolver;
035 import org.apache.camel.util.ObjectHelper;
036 import org.apache.commons.logging.Log;
037 import org.apache.commons.logging.LogFactory;
038
039 /**
040 * A <a href="http://camel.apache.org/data-format.html">data format</a> (
041 * {@link DataFormat}) using Bindy to marshal to and from CSV files
042 */
043 public class BindyCsvDataFormat implements DataFormat {
044 private static final transient Log LOG = LogFactory.getLog(BindyCsvDataFormat.class);
045
046 private String[] packages;
047 private BindyCsvFactory modelFactory;
048
049 public BindyCsvDataFormat() {
050 }
051
052 public BindyCsvDataFormat(String... packages) {
053 this.packages = packages;
054 }
055
056 @SuppressWarnings("unchecked")
057 public void marshal(Exchange exchange, Object body, OutputStream outputStream) throws Exception {
058
059 BindyCsvFactory factory = getFactory(exchange.getContext().getPackageScanClassResolver());
060 ObjectHelper.notNull(factory, "not instantiated");
061
062 // Get CRLF
063 byte[] bytesCRLF = Converter.getByteReturn(factory.getCarriageReturn());
064
065 if (factory.getGenerateHeaderColumnNames()) {
066
067 String result = factory.generateHeader();
068 byte[] bytes = exchange.getContext().getTypeConverter().convertTo(byte[].class, exchange, result);
069 outputStream.write(bytes);
070
071 // Add a carriage return
072 outputStream.write(bytesCRLF);
073 }
074
075 List<Map<String, Object>> models;
076
077 // the body is not a prepared list so help a bit here and create one for us
078 if (exchange.getContext().getTypeConverter().convertTo(List.class, body) == null) {
079 models = new ArrayList<Map<String, Object>>();
080 Iterator it = ObjectHelper.createIterator(body);
081 while (it.hasNext()) {
082 Object model = it.next();
083 String name = model.getClass().getName();
084 Map<String, Object> row = new HashMap<String, Object>();
085 row.put(name, body);
086 models.add(row);
087 }
088 } else {
089 // cast to the expected type
090 models = (List<Map<String, Object>>) body;
091 }
092
093 for (Map<String, Object> model : models) {
094
095 String result = factory.unbind(model);
096
097 byte[] bytes = exchange.getContext().getTypeConverter().convertTo(byte[].class, exchange, result);
098 outputStream.write(bytes);
099
100 // Add a carriage return
101 outputStream.write(bytesCRLF);
102 }
103 }
104
105 public Object unmarshal(Exchange exchange, InputStream inputStream) throws Exception {
106 BindyCsvFactory factory = getFactory(exchange.getContext().getPackageScanClassResolver());
107 ObjectHelper.notNull(factory, "not instantiated");
108
109 // List of Pojos
110 List<Map<String, Object>> models = new ArrayList<Map<String, Object>>();
111
112 // Pojos of the model
113 Map<String, Object> model;
114
115 InputStreamReader in = new InputStreamReader(inputStream);
116
117 // Scanner is used to read big file
118 Scanner scanner = new Scanner(in);
119
120 // Retrieve the separator defined to split the record
121 String separator = factory.getSeparator();
122 ObjectHelper.notEmpty(separator, "The separator has not been defined in the annotation @CsvRecord or not instantiated during initModel.");
123
124 int count = 0;
125
126 try {
127
128 // If the first line of the CSV file contains columns name, then we
129 // skip this line
130 if (factory.getSkipFirstLine()) {
131
132 // Check if scanner is empty
133 if (scanner.hasNextLine()) {
134 scanner.nextLine();
135 }
136 }
137
138 while (scanner.hasNextLine()) {
139
140 // Read the line
141 String line = scanner.nextLine().trim();
142
143 if (ObjectHelper.isEmpty(line)) {
144 // skip if line is empty
145 continue;
146 }
147
148 // Increment counter
149 count++;
150
151 // Create POJO where CSV data will be stored
152 model = factory.factory();
153
154 // Added for camel- jira ticket
155 // We will remove the first and last character of the line
156 // when the separator contains quotes, double quotes
157 // e.g. ',' or "," ...
158 // REMARK : We take the assumption that the data fields are
159 // quoted or double quoted like that
160 // e.g : "1 ", "street 1, NY", "USA"
161 if (separator.length() > 1) {
162 String tempLine = line.substring(1, line.length() - 1);
163 line = tempLine;
164 }
165 // Split the CSV record according to the separator defined in
166 // annotated class @CSVRecord
167 String[] tokens = line.split(separator, -1);
168 List<String> result = Arrays.asList(tokens);
169
170 if (result.size() == 0 || result.isEmpty()) {
171 throw new java.lang.IllegalArgumentException("No records have been defined in the CSV !");
172 }
173
174 if (result.size() > 0) {
175
176 if (LOG.isDebugEnabled()) {
177 LOG.debug("Size of the record splitted : " + result.size());
178 }
179
180 // Bind data from CSV record with model classes
181 factory.bind(result, model, count);
182
183 // Link objects together
184 factory.link(model);
185
186 // Add objects graph to the list
187 models.add(model);
188
189 if (LOG.isDebugEnabled()) {
190 LOG.debug("Graph of objects created : " + model);
191 }
192
193 }
194
195 }
196
197 // Test if models list is empty or not
198 // If this is the case (correspond to an empty stream, ...)
199 if (models.size() == 0) {
200 throw new java.lang.IllegalArgumentException("No records have been defined in the CSV !");
201 } else {
202 return models;
203 }
204
205 } finally {
206 scanner.close();
207 ObjectHelper.close(in, "in", LOG);
208 }
209
210 }
211
212 /**
213 * Method used to create the singleton of the BindyCsvFactory
214 */
215 public BindyCsvFactory getFactory(PackageScanClassResolver resolver) throws Exception {
216 if (modelFactory == null) {
217 modelFactory = new BindyCsvFactory(resolver, packages);
218 }
219 return modelFactory;
220 }
221
222 public void setModelFactory(BindyCsvFactory modelFactory) {
223 this.modelFactory = modelFactory;
224 }
225
226 public String[] getPackages() {
227 return packages;
228 }
229
230 public void setPackages(String[] packages) {
231 this.packages = packages;
232 }
233
234 }