CVS reader : CSV File « Development Class « Java

Java
1. 2D Graphics GUI
2. 3D
3. Advanced Graphics
4. Ant
5. Apache Common
6. Chart
7. Class
8. Collections Data Structure
9. Data Type
10. Database SQL JDBC
11. Design Pattern
12. Development Class
13. EJB3
14. Email
15. Event
16. File Input Output
17. Game
18. Generics
19. GWT
20. Hibernate
21. I18N
22. J2EE
23. J2ME
24. JDK 6
25. JNDI LDAP
26. JPA
27. JSP
28. JSTL
29. Language Basics
30. Network Protocol
31. PDF RTF
32. Reflection
33. Regular Expressions
34. Scripting
35. Security
36. Servlets
37. Spring
38. Swing Components
39. Swing JFC
40. SWT JFace Eclipse
41. Threads
42. Tiny Application
43. Velocity
44. Web Services SOA
45. XML
Java Tutorial
Java Source Code / Java Documentation
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java » Development Class » CSV FileScreenshots 
CVS reader
  
package au.com.bytecode.opencsv;

/**
 Copyright 2005 Bytecode Pty Ltd.

 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.
 */

import java.io.BufferedReader;
import java.io.IOException;
import java.io.Reader;
import java.util.ArrayList;
import java.util.List;

/**
 * A very simple CSV reader released under a commercial-friendly license.
 
 @author Glen Smith
 
 */
public class CSVReader {

    private BufferedReader br;

    private boolean hasNext = true;

    private char separator;

    private char quotechar;
    
    private int skipLines;

    private boolean linesSkiped;

    /** The default separator to use if none is supplied to the constructor. */
    public static final char DEFAULT_SEPARATOR = ',';

    /**
     * The default quote character to use if none is supplied to the
     * constructor.
     */
    public static final char DEFAULT_QUOTE_CHARACTER = '"';
    
    /**
     * The default line to start reading.
     */
    public static final int DEFAULT_SKIP_LINES = 0;

    /**
     * Constructs CSVReader using a comma for the separator.
     
     @param reader
     *            the reader to an underlying CSV source.
     */
    public CSVReader(Reader reader) {
        this(reader, DEFAULT_SEPARATOR);
    }

    /**
     * Constructs CSVReader with supplied separator.
     
     @param reader
     *            the reader to an underlying CSV source.
     @param separator
     *            the delimiter to use for separating entries.
     */
    public CSVReader(Reader reader, char separator) {
        this(reader, separator, DEFAULT_QUOTE_CHARACTER);
    }
    
    

    /**
     * Constructs CSVReader with supplied separator and quote char.
     
     @param reader
     *            the reader to an underlying CSV source.
     @param separator
     *            the delimiter to use for separating entries
     @param quotechar
     *            the character to use for quoted elements
     */
    public CSVReader(Reader reader, char separator, char quotechar) {
        this(reader, separator, quotechar, DEFAULT_SKIP_LINES);
    }
    
    /**
     * Constructs CSVReader with supplied separator and quote char.
     
     @param reader
     *            the reader to an underlying CSV source.
     @param separator
     *            the delimiter to use for separating entries
     @param quotechar
     *            the character to use for quoted elements
     @param line
     *            the line number to skip for start reading 
     */
    public CSVReader(Reader reader, char separator, char quotechar, int line) {
        this.br = new BufferedReader(reader);
        this.separator = separator;
        this.quotechar = quotechar;
        this.skipLines = line;
    }

    /**
     * Reads the entire file into a List with each element being a String[] of
     * tokens.
     
     @return a List of String[], with each String[] representing a line of the
     *         file.
     
     @throws IOException
     *             if bad things happen during the read
     */
    public List readAll() throws IOException {

        List allElements = new ArrayList();
        while (hasNext) {
            String[] nextLineAsTokens = readNext();
            if (nextLineAsTokens != null)
                allElements.add(nextLineAsTokens);
        }
        return allElements;

    }

    /**
     * Reads the next line from the buffer and converts to a string array.
     
     @return a string array with each comma-separated element as a separate
     *         entry.
     
     @throws IOException
     *             if bad things happen during the read
     */
    public String[] readNext() throws IOException {

        String nextLine = getNextLine();
        return hasNext ? parseLine(nextLinenull;
    }

    /**
     * Reads the next line from the file.
     
     @return the next line from the file without trailing newline
     @throws IOException
     *             if bad things happen during the read
     */
    private String getNextLine() throws IOException {
      if (!this.linesSkiped) {
            for (int i = 0; i < skipLines; i++) {
                br.readLine();
            }
            this.linesSkiped = true;
        }
        String nextLine = br.readLine();
        if (nextLine == null) {
            hasNext = false;
        }
        return hasNext ? nextLine : null;
    }

    /**
     * Parses an incoming String and returns an array of elements.
     
     @param nextLine
     *            the string to parse
     @return the comma-tokenized list of elements, or null if nextLine is null
     @throws IOException if bad things happen during the read
     */
    private String[] parseLine(String nextLinethrows IOException {

        if (nextLine == null) {
            return null;
        }

        List tokensOnThisLine = new ArrayList();
        StringBuffer sb = new StringBuffer();
        boolean inQuotes = false;
        do {
          if (inQuotes) {
                // continuing a quoted section, reappend newline
                sb.append("\n");
                nextLine = getNextLine();
                if (nextLine == null)
                    break;
            }
            for (int i = 0; i < nextLine.length(); i++) {

                char c = nextLine.charAt(i);
                if (c == quotechar) {
                  // this gets complex... the quote may end a quoted block, or escape another quote.
                  // do a 1-char lookahead:
                  ifinQuotes  // we are in quotes, therefore there can be escaped quotes in here.
                      && nextLine.length() (i+1)  // there is indeed another character to check.
                      && nextLine.charAt(i+1== quotechar ){ // ..and that char. is a quote also.
                    // we have two quote chars in a row == one quote char, so consume them both and
                    // put one on the token. we do *not* exit the quoted text.
                    sb.append(nextLine.charAt(i+1));
                    i++;
                  }else{
                    inQuotes = !inQuotes;
                    // the tricky case of an embedded quote in the middle: a,bc"d"ef,g
                    if(i>//not on the begining of the line
                        && nextLine.charAt(i-1!= this.separator //not at the begining of an escape sequence 
                        && nextLine.length()>(i+1&&
                        nextLine.charAt(i+1!= this.separator //not at the end of an escape sequence
                    ){
                      sb.append(c);
                    }
                  }
                else if (c == separator && !inQuotes) {
                    tokensOnThisLine.add(sb.toString());
                    sb = new StringBuffer()// start work on next token
                else {
                    sb.append(c);
                }
            }
        while (inQuotes);
        tokensOnThisLine.add(sb.toString());
        return (String[]) tokensOnThisLine.toArray(new String[0]);

    }

    /**
     * Closes the underlying reader.
     
     @throws IOException if the close fails
     */
    public void close() throws IOException{
      br.close();
    }
    
}
///////////////////////////////////////////
package au.com.bytecode.opencsv;

/**
 Copyright 2005 Bytecode Pty Ltd.

 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.
 */

import java.io.IOException;
import java.io.StringReader;
import java.util.List;

import junit.framework.TestCase;

public class CSVReaderTest extends TestCase {

  CSVReader csvr;

  
  /**
   * Setup the test.
   */
  protected void setUp() throws Exception {
    StringBuffer sb = new StringBuffer();
    sb.append("a,b,c").append("\n");   // standard case
    sb.append("a,\"b,b,b\",c").append("\n");  // quoted elements
    sb.append(",,").append("\n")// empty elements
    sb.append("a,\"PO Box 123,\nKippax,ACT. 2615.\nAustralia\",d.\n");
    sb.append("\"Glen \"\"The Man\"\" Smith\",Athlete,Developer\n")// Test quoted quote chars
    sb.append("\"\"\"\"\"\",\"test\"\n")// """""","test"  representing:  "", test
    sb.append("\"a\nb\",b,\"\nd\",e\n");
    csvr = new CSVReader(new StringReader(sb.toString()));
  }


  /**
   * Tests iterating over a reader.
   
   @throws IOException
   *             if the reader fails.
   */
  public void testParseLine() throws IOException {

    // test normal case
    String[] nextLine = csvr.readNext();
    assertEquals("a", nextLine[0]);
    assertEquals("b", nextLine[1]);
    assertEquals("c", nextLine[2]);

    // test quoted commas
    nextLine = csvr.readNext();
    assertEquals("a", nextLine[0]);
    assertEquals("b,b,b", nextLine[1]);
    assertEquals("c", nextLine[2]);

    // test empty elements
    nextLine = csvr.readNext();
    assertEquals(3, nextLine.length);
    
    // test multiline quoted
    nextLine = csvr.readNext();
    assertEquals(3, nextLine.length);
    
    // test quoted quote chars
    nextLine = csvr.readNext();
    assertEquals("Glen \"The Man\" Smith", nextLine[0]);
    
    nextLine = csvr.readNext();
    assertTrue(nextLine[0].equals("\"\""))// check the tricky situation
    assertTrue(nextLine[1].equals("test"))// make sure we didn't ruin the next field..
    
    nextLine = csvr.readNext();
    assertEquals(4, nextLine.length);
    
    //test end of stream
    assertEquals(null, csvr.readNext());

  }

  /**
   * Test parsing to a list.
   
   @throws IOException
   *             if the reader fails.
   */
  public void testParseAll() throws IOException {

    List allElements = csvr.readAll();
    assertEquals(7, allElements.size());

  }
  
  /**
   * Tests constructors with optional delimiters and optional quote char.
   
   @throws IOException if the reader fails.
   */
  public void testOptionalConstructors() throws IOException {
    
    StringBuffer sb = new StringBuffer();
    sb.append("a\tb\tc").append("\n");   // tab separated case
    sb.append("a\t'b\tb\tb'\tc").append("\n");  // single quoted elements
    CSVReader c = new CSVReader(new StringReader(sb.toString())'\t''\'');
    
    String[] nextLine = c.readNext();
    assertEquals(3, nextLine.length);

    nextLine = c.readNext();
    assertEquals(3, nextLine.length);

    
  }
  
  /**
   * Tests option to skip the first few lines of a file.
   
   @throws IOException if bad things happen
   */
  public void testSkippingLines() throws IOException {
    
    StringBuffer sb = new StringBuffer();
    sb.append("Skip this line\t with tab").append("\n");   // should skip this
    sb.append("And this line too").append("\n");   // and this
    sb.append("a\t'b\tb\tb'\tc").append("\n");  // single quoted elements
    CSVReader c = new CSVReader(new StringReader(sb.toString())'\t''\''2);
    
    String[] nextLine = c.readNext();
    assertEquals(3, nextLine.length);
    
    assertEquals("a", nextLine[0]);
  }
  
  /**
   * Tests quotes in the middle of an element.
   
   @throws IOException if bad things happen
   */
  public void testParsedLineWithInternalQuota() throws IOException {

    StringBuffer sb = new StringBuffer();

    sb.append("a,123\"4\"567,c").append("\n");// a,123"4",c

    CSVReader c = new CSVReader(new StringReader(sb.toString()));

    String[] nextLine = c.readNext();
    assertEquals(3, nextLine.length);

    System.out.println(nextLine[1]);
    assertEquals("123\"4\"567", nextLine[1]);

  }

  /**
   * The Test Runner for commandline use.
   
   @param args
   *            no args required
   */
  public static void main(String args[]) {
    junit.textui.TestRunner.run(CSVReaderTest.class);
  }

}

   
    
  
Related examples in the same category
1. A utility class that parses a Comma Separated Values (CSV) file
2. Simple demo of CSV parser classSimple demo of CSV parser class
3. CSV in action: lines from a file and printCSV in action: lines from a file and print
4. Simple demo of CSV matching using Regular Expressions
5. Helper class to write table data to a csv-file (comma separated values).
6. Builds a bracketed CSV list from the array
7. Builds a CSV list from the specified String[], separator string and quote string
8. Builds a CSV list from the specified two dimensional String[][], separator string and quote string.
9. The csv tokenizer class allows an application to break a Comma Separated Value format into tokens.
10. The CSVQuoter is a helper class to encode a string for the CSV file format.
11. A stream based parser for parsing delimited text data from a file or a stream
12. Reads CSV (Comma Separated Value) files
13. Writes CSV (Comma Separated Value) files
14. Csv Converter
15. CSV Writer
16. CSV parser
17. Csv Reader
www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.