JSaPar stands for Java Schema based Parser
JSaPar is a Java library providing a schema based parser and composer of almost all sorts of delimited and fixed width files.
It is an open source java library created with the purpose of making it easy to process delimited and fixed width data sources. By separating the description of the data format into a schema that can be loaded from XML it makes the code easier to maintain and increases flexibility.
The goal of this project is a java library that removes the burden of parsing and composing flat files and csv files from the developer.
The library should
- Be easy to use for both simple and complex situations.
- Be possible to extend.
- Have a low memory impact and good performance.
- Be flexible to use in different situations.
- Be independent of other (third party) libraries.
- Use schemas in order to distinctly separate the description of the format of the data source from the code.
- Unburden the tremendous tasks of a developer dealing with fixed width and delimited data sources.
- Support for flat files with fixed positions.
- Support for CSV and all other delimited files such as TAB-separated or multi character separated.
- Configurable line separator character sequence.
- Support for quoted CSV cells.
- Support for multi line quoted CSV cells. Line breaks are allowed within quoted cells.
- Support for type conversion while parsing and composing.
- Can handle internationalization of numbers and dates both while parsing and composing.
- Support for different type of lines where line type is determined by the value of defined “condition cells”.
- Support converting Java objects to or from any of the other supported input or output formats.
- The schema can be expressed with xml notation or created directly within the java code.
- The parser can either produce a Document class, representing the content of the file, or you can choose to receive events for each line that has been successfully parsed.
- Can handle huge files without loading everything into memory.
- The output Document class contains a list of lines which contains a list of cells.
- The input and outputs are given by java.io.Reader and java.io.Writer which means that it is not necessarily files that are parsed or generated.
- The schema contains information about the format of each cell regarding data type and syntax.
- Parsing errors can either be handled by exceptions thrown at first error or the errors can be collected during parsing to be able to deal with them later.
- Support for consuming or producing an internal xml format which can be used to transform any of the supported formats into any markup language by the use of xslt.
- All features fully documented, discussed and demonstrated.
- Unit tests for (almost) all classes within the library.
- Examples demonstrating all features.
We are not quite there yet, but we are working on it…
- Source code and issues
- Maven coordinates and binaries download
- Download historical binaries
- The original project web page with historical archive.
- For questions about usage, use Stack overflow with the jsapar tag
This project has no dependencies to other external libraries in runtime.
However if you plan to build and test the source consider the following:
- To build the source it is recommended to use Maven. A Maven pom.xml is provided. As of version 1.6, the library is published in the public Maven repository.
- The provided test classes require JUnit4 in order to run.
- Since JSaPar 1.5.0 the library in the download packages are built with java 1.7. Earlier versions of the library in the download packages are built with java 1.6 but with target compatibility level 1.5. It is no guarantee that the library will work for earlier version of Java.
- JSaPar version 2.0 requires Java 1.8 or later.