leila-csv is a demo plugin for the tool leila.
leila-csv demonstrates simply how can be implemented a custom formatting plugin for leila.
leila-csv serialize each lucene Document extracted with leila into a standard csv.
It consists of a single class CsvFormatter whith just one constructor.
The class ha just one public method, which receives a Document and returns a String, which is always empty meaning that leila won't print anything. This is expected, since the class prints directly to stdout.
Dependencies:
- commons-csv
- lucene-core 4.10.4
This software is open-source, released under Apache License 2.0, and made without any commercial intent. Please feel free to contribute, especially if you find leila usefull and discover some bug or missing feature. The non-exhaustive feature request list is at the bottom of this page.
leila-csv source can be downloaded from this repository and can be build with maven. The requirements are a JVM compatible with Java 1.8 version.
git clone https://github.com/raymanrt/leila-csv.git
cd leila-csv
mvn clean package
ls target/leila-csv.jar
A portable fat jar is build which includes every dependency required to use leila-csv in bundle with leila.
To make leila-csv visible to leila you should run the leila Main with the java command, not forgetting to include the generated jar in your classpath, for example:
java -cp 'target/leila.jar:../leila-csv/target/leila-csv.jar' com.github.raymanrt.leila.Main \
target/demo-index \
-f field1,field2
-p com.github.raymanrt.leila.csv.CsvFormatter field1,field2
Please remember the syntax for the -p option:
- the first argument is the path of the desired class
- the following arguments are the builder parameters
WARNING: every column to be printed should also be loaded with the standard leila's -f option
In the case of leila-csv the builder arguments are the columns that will be present in the output.
There are also some system properties to customize the csv output:
- leila.csv.format : one of those supported by commons-csv (default EXCEL)
- leila.csv.withHeader: true or false, to decide if printing csv header into the output (default true)
- leila.csv.recordSeparator: string to indicate the record separator (default
,) - leila.csv.withQuote: single character to indicate quote character (default
") - leila.csv.quoteMode: one of those supported by commons-csv (default MINIMAL)
By default leila-csv tries to infer the datatype. If a field can be parsed as a number, it will be written as a number. Also boolean values are inferred if parsable.
Multiple values are joined with , separator.
Missing values are treated as empty strings.
You can declare a column custom parser, indicating with the following syntax: column1,column2:parserName,column3.
The existing parsers are:
- javatimestamp: convert a numeric java long timestamp to a human readable ISO local datetime .
- I'd like to add more parser
- more testing is required