Skip to end of metadata
Go to start of metadata

Description

Port of the Grails CSV plugin by Lez Hazlewood.

Installation

The current version of griffon-csv-plugin is 0.1
To install just issue the following command

The Griffon CSV Plugin allows you to easily parse and consume comma-separated values (CSV) from a number of input sources. It supports complex parsing scenarios such as nested commas inside quotes, escaped tokens, multi-line quoted values and allows configuration of parsing options (separator char, escape char, text encoding, etc). It is based on Glen Smith (et. al.)'s OpenCSV project.

This plugin adds two dynamic methods 'eachCsvLine' and 'toCsvReader' to each of the following classes:

  • java.lang.String
  • java.io.File
  • java.io.InputStream
  • java.io.Reader

Usage

Using it is extremely simple. On any instance of the four data types, call the 'eachCsvLine' method with a closure accepting the tokens (a String array) for each parsed line:

or a file:

Configuration

By default, you don't need to configure anything. However, if you need to specify exactly how the parsing should occur, you can construct your own csv reader with a map of configuration options and call the 'eachLine' method on the constructed reader:

The supported config options:

  • 'separatorChar': the character to use as the delimiter to separate the tokens. Defaults to the comma: ,
  • 'quoteChar': the character indicating a quoted string is about to follow. Internal separatorChars can be inside the quoted string and they will not be split into tokens. Defaults to the double quote char: "
  • 'escapeChar': the character to escape an immediately following character, indicating to the parser not to treat it as a special char. Defaults to the backslash char: *\\\\*
  • 'skipLines': the number of lines in the input source to skip before parsing begins. This is useful to skip any potential CSV header lines that are not part of the CSV data. Defaults to zero: 0
  • 'strictQuotes': if characters outside of quotes should be ignored (implying each individual token is quoted. Defaults to false
  • 'ignoreLeadingWhiteSpace': white space in front of a quoted token is ignored. Defaults to true
  • 'charset': use the specified charset when parsing an InputStream. The value can be either the Charset name as a String, a java.nio.charset.Charset instance, or a java.nio.charset.CharsetDecoder instance. Defaults to the system default charset. Note that this option is ONLY valid for InputStream instances - it is ignored otherwise.

History

Version

Date

Notes

0.1

03-05-11

First release

  • No labels