JPlate Tabular 0.1
Summary
Welcome to the JPlate Tabular
Project! This
subproject of JPlate provides tabular related functionality. Here
"tabular" refers to data organized into tables of records and
fields, where each has a fixed delimiter: for example, records
delimited by "new lines" and fields delimited by commas.
Please
note: this documentation is a "work
in progress"
and will be enhanced when time permits - it is an initial version and
much is missing
(unit test cases, good Java documentation, etc).
Parsers
There are three included parsers:
- Colon Delimited Values (CDV): fields separated by colons
and records by newlines.
- Comma Separated Values (CSV): fields separated by commas
and records by newlines.
- Tab Delimeted Values (TDV): fields separated by tabs and
records by new lines.
As a side note, CSV includes
two parsers - one strictly adheres to RFC 4180, while
the other is a more lax version similar both the CDV and TDV
parsers.
Quick Start
This section illustrates how to quickly make use of the parsers
described above. However, remember that this is simply a
"quick start" and does not explain how to use the complete Tabular
library.
There are a set of utility
classes that make use of default implentations to create
tables/lists from files, input streams, readers and strings. By
examining the source code for these classes,
one can extrapolate how to extend or use the rest of the project.
Consider the following examples:
- Comma separated values contained in a file to be consumed as a
java.util.List:
import java.io.File;
import java.util.List;
import org.jplate.tabular.util.JPlateCsvUtil;
...
final File csvFile = new File ( "SomeFile.csv" );
final List <List <String>>
JPlateCsvUtil.getAsList ( csvFile );
...
- Tabbed delimited values streamed from a socket to be consumed as
an org.jplate.tabular.TableIfc:
import java.net.Socket;
import org.jplate.tabular.TableIfc;
import org.jplate.tabular.util.TdvUtil;
...
final Socket tdvSocket = // Create socket in some
fashion...
final TableIfc TdvUtil.getAsTable ( tdvSocket.getInputStream () );
...
Please look to individual classes for
more specific information.
Related Links
Tabular related links follow:
Modifications:
$Date: 2007-12-02 02:09:49 -0500 (Sun, 02 Dec 2007) $
$Revision: 443 $
$Author: sfloess $
$HeadURL: https://jplate.svn.sourceforge.net/svnroot/jplate/trunk/tabular/src/doc/index.html $
