Examples of org.apache.commons.csv.CSVFormat

org.apache.commons.csv.CSVFormat
Specifies the format of a CSV file and parses input.
Using predefined formats

You can use one of the predefined formats:
- {@link #DEFAULT}
- {@link #EXCEL}
- {@link #MYSQL}
- {@link #RFC4180}
- {@link #TDF}
For example:
```
 CSVParser parser = CSVFormat.EXCEL.parse(reader); 
```
The {@link CSVParser} provides static methods to parse other input types, for example:
```
CSVParser parser = CSVParser.parse(file, StandardCharsets.US_ASCII, CSVFormat.EXCEL);
```
Defining formats

You can extend a format by calling the {@code with} methods. For example:
```
 CSVFormat.EXCEL .withNullString("N/A") .withIgnoreSurroundingSpaces(true); 
```
Defining column names

To define the column names you want to use to access records, write:
```
 CSVFormat.EXCEL.withHeader("Col1", "Col2", "Col3"); 
```
Calling {@link #withHeader(String)} let's you use the given names to address values in a {@link CSVRecord}, and assumes that your CSV source does not contain a first record that also defines column names. If it does, then you are overriding this metadata with your names and you should skip the first record by calling {@link #withSkipHeaderRecord(boolean)} with {@code true}.

Parsing

You can use a format directly to parse a reader. For example, to parse an Excel file with columns header, write:
```
 Reader in = ...; CSVFormat.EXCEL.withHeader("Col1", "Col2", "Col3").parse(in); 
```
For other input types, like resources, files, and URLs, use the static methods on {@link CSVParser}.

Referencing columns safely

If your source contains a header record, you can simplify your code and safely reference columns, by using {@link #withHeader(String)} with no arguments:
```
 CSVFormat.EXCEL.withHeader(); 
```
This causes the parser to read the first record and use its values as column names. Then, call one of the {@link CSVRecord} get method that takes a String column name argument:
```
 String value = record.get("Col1"); 
```
This makes your code impervious to changes in column order in the CSV file.

Notes

This class is immutable.
@version $Id: CSVFormat.java 1617076 2014-08-10 09:23:01Z britter $

    private BufferedReader getBufferedReader() throws IOException {
        return new BufferedReader(new FileReader(BIG_FILE));
    }


    private long parse(final Reader in, final boolean traverseColumns) throws IOException {
        final CSVFormat format = CSVFormat.DEFAULT.withIgnoreSurroundingSpaces(false);
        long recordCount = 0;
        for (final CSVRecord record : format.parse(in)) {
            recordCount++;
            if (traverseColumns) {
                for (@SuppressWarnings("unused") final String value : record) {
                    // do nothing for now
                }

View Full Code Here

     * ignore empty lines allows the last data line to have a recordSeparator
     *
     * @return CSVFormat based on constructor settings.
     */
    private CSVFormat buildFormat() {
        CSVFormat format = CSVFormat.DEFAULT
                .withIgnoreEmptyLines(true)
                .withDelimiter(asControlCharacter(fieldDelimiter))
                .withQuoteChar(asControlCharacter(quoteCharacter));


        if (escapeCharacter != null) {
            format = format.withEscape(asControlCharacter(escapeCharacter));
        }


        switch(headerSource) {
        case FROM_TABLE:
            // obtain headers from table, so format should not expect a header.
            break;
        case IN_LINE:
            // an empty string array triggers csv loader to grab the first line as the header
            format = format.withHeader(new String[0]);
            break;
        case SUPPLIED_BY_USER:
            // a populated string array supplied by the user
            format = format.withHeader(columns.toArray(new String[columns.size()]));
            break;
        default:
            throw new RuntimeException("Header source was unable to be inferred.");


        }

View Full Code Here

     * ignore empty lines allows the last data line to have a recordSeparator
     *
     * @return CSVFormat based on constructor settings.
     */
    private CSVFormat buildFormat() {
        CSVFormat format = CSVFormat.DEFAULT
                .withIgnoreEmptyLines(true);
        if (userSuppliedMetaCharacters) {
            // list error checking handled in constructor above.
            // use 0 to keep default setting
            String delimiter = customMetaCharacters.get(0);
            String quote = customMetaCharacters.get(1);
            String escape = customMetaCharacters.get(2);


            if (!"0".equals(delimiter)) {
                format = format.withDelimiter(getCustomMetaCharacter(delimiter));
            }
            if (!"0".equals(quote)) {
                format = format.withQuoteChar(getCustomMetaCharacter(quote));
            }
            if (!"0".equals(quote)) {
                format = format.withEscape(getCustomMetaCharacter(escape));
            }


        }
        switch(headerSource) {
        case FROM_TABLE:
            // obtain headers from table, so format should not expect a header.
            break;
        case IN_LINE:
            // an empty string array triggers csv loader to grab the first line as the header
            format = format.withHeader(new String[0]);
            break;
        case SUPPLIED_BY_USER:
            // a populated string array supplied by the user
            format = format.withHeader(columns.toArray(new String[columns.size()]));
            break;
        default:
            throw new RuntimeException("Header source was unable to be inferred.");


        }

View Full Code Here

TOP

Related Classes of org.apache.commons.csv.CSVFormat

org.apache.commons.csv.perf.PerformanceTest

org.apache.phoenix.util.CSVCommonsLoader

java.io.StringWriter

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.

Examples of org.apache.commons.csv.CSVFormat

Using predefined formats

Defining formats

Defining column names

Parsing

Referencing columns safely

Notes

Related Classes of org.apache.commons.csv.CSVFormat