Author: britter
Date: Fri Jul 11 19:07:31 2014
New Revision: 1609772
URL: http://svn.apache.org/r1609772
Log:
Add new user guide (missed that in the last commit)
Added:
commons/proper/csv/trunk/src/site/xdoc/user-guide.xml (with props)
Added: commons/proper/csv/trunk/src/site/xdoc/user-guide.xml
URL:
http://svn.apache.org/viewvc/commons/proper/csv/trunk/src/site/xdoc/user-guide.xml?rev=1609772&view=auto
==============================================================================
--- commons/proper/csv/trunk/src/site/xdoc/user-guide.xml (added)
+++ commons/proper/csv/trunk/src/site/xdoc/user-guide.xml Fri Jul 11 19:07:31
2014
@@ -0,0 +1,56 @@
+<?xml version="1.0"?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You 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.
+-->
+<document>
+ <properties>
+ <title>User Guide</title>
+ <author email="[email protected]">Commons Documentation Team</author>
+ </properties>
+<body>
+<!-- ================================================== -->
+<section name="Parsing an Excel CSV File">
+ <p>To parse an Excel CSV file, write:</p>
+ <source>Reader in = new FileReader("path/to/file.csv");
+Iterable<CSVRecord> records = CSVFormat.EXCEL.parse(in);
+for (CSVRecord record : records) {
+ String lastName = record.get("Last Name");
+ String firstName = record.get("First Name");
+}</source>
+</section>
+<section name="Handling Byte Order Marks">
+ <p>
+ To handle files that start with a Byte Order Mark (BOM) like some Excel
CSV files, you need an extra step to deal with these optional bytes.
+ You can use the
+ <a
href="https://commons.apache.org/proper/commons-io/apidocs/org/apache/commons/io/input/BOMInputStream.html";>BOMInputStream</a>
+ class from <a href="https://commons.apache.org/proper/commons-io/";>Apache
Commons IO</a> for example:
+ </p>
+ <source>final URL url = ...;
+final Reader reader = new InputStreamReader(new
BOMInputStream(url.openStream()), "UTF-8");
+final CSVParser parser = new CSVParser(reader, CSVFormat.EXCEL.withHeader());
+try {
+ for (final CSVRecord record : parser) {
+ final String string = record.get("SomeColumn");
+ ...
+ }
+} finally {
+ parser.close();
+ reader.close();
+}</source>
+</section>
+<!-- ================================================== -->
+</body>
+</document>
Propchange: commons/proper/csv/trunk/src/site/xdoc/user-guide.xml
------------------------------------------------------------------------------
svn:eol-style = native
