JPlate Tabular 0.2
Welcome to the JPlate Tabular
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.
note: this documentation is a "work
and will be enhanced when time permits - it is an initial version and
much is missing
(unit test cases, good Java documentation, etc).
There are three included parsers:
As a side note, CSV includes
two parsers - one strictly adheres to RFC 4180, while
the other is a more lax version similar to both the CDV and TDV
- 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.
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
To utilize the Tabular library, include all jar files found in the
lib directory as part of the classpath. For example, assume
0.2 has been downloaded and installed to
/shared/jplate-tabular-0.2 on a Linux platform:
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
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
final Socket tdvSocket = // Create socket in some
final TableIfc table = TdvUtil.getAsTable ( tdvSocket.getInputStream () );
Please look to individual classes for
more specific information.
Building (if desired)
If you wish to build Tabular from source, you will need access
to a Subversion client and Ant 1.7.0+
to simplify using the included libraries - please see the documentation
1.1 for more information).
Check out the source
Create a directory for checkout, change to this directory and execute:
You will note two directories are created: environment
Build the source
Build the source - change directories to the aforementioned tabular
directory and execute the command:
After building, you should find a tabular/assembly/release
directory containing various things such as a jar file
(for example Tabular 0.2 release produces jplate-tabular-0.2.jar)
and other files normally associated with a Tabular release.
Tabular has dependencies upon:
There is an
IRC channel on
irc.freenode.net under the channel name #JPlate.
The Project Manager
is usually there most days under the name Flossy. He is more than
happy to help or answer questions you may have.
Tabular related links follow: