Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jferard/fastods

A very fast and lightweight (no dependency) library for creating ODS (Open Document Spreadsheet, mainly for Calc) files in Java. It's a Martin Schulz's SimpleODS fork
https://github.com/jferard/fastods

calc java libreoffice no-dependencies od-files ods opendocument speed spreadsheet

Last synced: 1 day ago
JSON representation

A very fast and lightweight (no dependency) library for creating ODS (Open Document Spreadsheet, mainly for Calc) files in Java. It's a Martin Schulz's SimpleODS fork

Host: GitHub
URL: https://github.com/jferard/fastods
Owner: jferard
License: gpl-3.0
Created: 2016-05-24T12:30:26.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2024-12-07T19:31:34.000Z (about 1 month ago)
Last Synced: 2024-12-07T20:21:16.045Z (about 1 month ago)
Topics: calc, java, libreoffice, no-dependencies, od-files, ods, opendocument, speed, spreadsheet
Language: Java
Homepage:
Size: 4.82 MB
Stars: 37
Watchers: 7
Forks: 6
Open Issues: 13
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

[![FastODS](https://github.com/jferard/fastods/actions/workflows/workflow.yml/badge.svg)](https://github.com/jferard/fastods/actions/workflows/workflow.yml)
[![Code Coverage](https://img.shields.io/codecov/c/github/jferard/fastods/master.svg)](https://codecov.io/github/jferard/fastods?branch=master)

# FastODS
(C) J. Férard 2016-2023

A very fast and lightweight (no dependency) library for creating ODS (Open Document Spreadsheet, mainly for Calc) files in Java. It's a Martin Schulz's SimpleODS fork.

## TLDR;
* FastODS is compatible with Java 8 or any later version and OpenDocument v1.2 (actually, documents are 1.3 valid but tagged "1.2").
* **FastODS cannot read ODS documents;**
* FastODS can produce complex and large ODS documents *very* fast;
* FastODS is almost ready for production use. The version 1.0 is coming;
* There is a little [tutorial](https://github.com/jferard/fastods/wiki/Tutorial) that covers most of the features of FastODS;
* All documents produced in the tutorial are validated against OpenDocument RELAX NG schemas;
* Important: [feel free to ask a question or make a suggestion](https://github.com/jferard/fastods/issues/new);

### Features
* Cell styles, content formatting (dates, numbers, ...), formulas;
* Page formatting (header, footer);
* Document embedding, images;
* Filters & Autofilters;
* Pivot Tables (Data Pilot);
* Easy export of SQL ResultSets;
* Support for Macros, events;
* Document encryption (AES).

### Examples

Here's what some of the produced documents in the tutorial look like:

A regular table (export of a SQL ResultSet):
![Periodic Table List of elements](https://raw.githubusercontent.com/wiki/jferard/fastods/images/capture_periodic_table.png)

A multiplication table:
![Multiplication Table](https://raw.githubusercontent.com/wiki/jferard/fastods/images/i_multiplication_table.png)

The periodic table of Mr. Dmitri Mendeleev:
![Periodic Table](https://raw.githubusercontent.com/wiki/jferard/fastods/images/j_periodic_table.png)

## Table of contents
* [Why FastODS?](#why-fastods)
* [Limitations](#limitations)
* [Installation](#installation)
* [Examples](#examples)
* [Documentation](#documentation)
* [Speed](#speed)
* [History](#history)

## Why FastODS?
Because I need to write big and simple ODS files very fast in Java.

There are some very good libraries for [OASIS Open Document Format](https://www.oasis-open.org/standards#opendocumentv1.2), like [Simple ODF](http://incubator.apache.org/odftoolkit/simple/) or [JOpenDocument](http://www.jopendocument.org/), but they are a little bit slow and cumberstone for only writing **very simple** spreadsheets.
There is a simple and fast library by Martin Schulz, [Simple ODS](http://simpleods.sourceforge.net/), but it is now discontinued, outdated (Java 1.3), has a few limitations (incorrect handling of UTF-8 encoding, missing XML escaping for attributes), etc.

FastODS is a fork of SimpleODS that aims to be a very fast ODS writing library in Java. A lot of
features have been added.

(Thanks to M. Schultz for his work.)

## Limitations
FastODS won't deal with odt, odg, odf, or other od_ files.
It won't even *read* ods files.
Because it doesn't use XML internally, but only for writing files. That's why it is fast and lightweight.

It's an *OpenDocument producer* (*Open Document Format for Office Applications (OpenDocument) Version 1.2*, 2.3.1) and only an *OpenDocument producer*:
> An *OpenDocument producer* is a program that creates at least one conforming OpenDocument document

### FastODS documents and LibreOffice/OpenOffice/Excel/...
While an *OpenDocument producer* like FastODS can be reasonably simple because it just has to focus on the creation of OpenDocument files,
*OpenDocument consumer*s like LibreOffice, OpenOffice, Excel, ... are expected to handle numerous files created by various producers and are therefore more complex.
Although the spec states that a producer has to:

> parse and interpret OpenDocument documents according to the semantics defined by this specification [...] *but it need not interpret the semantics of all elements, attributes and attribute values.* (emphasis mine)

we expect those applications to open almost every proper OpenDocument file. But that's not so easy, because LibreOffice, OpenOffice, Excel, ... *do not* understand some tags, attributes or attribute values.

To be pragmatic, I chose to consider LibreOffice as the reference implementation. Hence **the documents created by FastODS should be fully understood by LibreOffice** (whereas there is a specific option to disable this enforced compatibility and to produce files that are slightly more concise).
**There is no plan to adapt the documents created by FastODS to OpenOffice, Excel or another reader**, although it will be done if possible (your help is welcome).

## Platforms and dependencies
FastODS has no runtime dependency beyond the standard Java Library version 6 or higher. Even the XML code is manually produced.

However, specific modules like `fastods-crypto` and `fastods-extra` have dependencies, but those are usually not needed.

FastODS works on Android (tested on *Android 9 Pie*, see [this issue](https://github.com/jferard/fastods/issues/180)).

## Installation
### Standard
Add the following dependency to your POM:
```

com.github.jferard
fastods
0.8.1

```

### From sources
For the latest version, type the following command:

`git clone https://github.com/jferard/fastods.git`

Then:

`mvn clean install`

And add the following dependency to your POM:

```

com.github.jferard
fastods
0.8.2-SNAPSHOT

```

### From jar
First download the **jar file** from the latest [release](https://github.com/jferard/fastods/releases/).

Then run the following command to install the jar in your local repo:

```mvn org.apache.maven.plugins:maven-install-plugin:2.5.2:install-file -Dfile=fastods-.jar```

## Examples
### Basic example
Taken from the tutorial:

```java
final OdsFactory odsFactory = OdsFactory.create(Logger.getLogger("hello-world"), Locale.US);
final AnonymousOdsFileWriter writer = odsFactory.createWriter();
final OdsDocument document = writer.document();
final Table table = document.addTable("hello-world");
final TableRowImpl row = table.getRow(0);
final TableCell cell = row.getOrCreateCell(0);
cell.setStringValue("Hello, world!");
writer.saveAs(new File("generated_files", "readme_example.ods"));
```

## Documentation
Writing a full documentation would be a considerable work, because every time you change the
library, you have to rewrite the doc.

My idea is to provide a set of examples of the features of FastODS. This is ensures that the doc is up to date.

Those examples are located in [the examples module](https://github.com/jferard/fastods/tree/master/fastods-examples/src/main/java/com/github/jferard/fastods/examples) and are fully commented.
A [tutorial](https://github.com/jferard/fastods/wiki/Tutorial) was extracted from this examples.

To run those examples, one has to run:

```mvn verify```

The resulting ods files are written in `generated_files` directory, and can be opened with LibreOffice or OpenOffice.

(**Note: All documents produced in the tutorial are validated against [OpenDocument RELAX NG schemas](http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html).** This is done by the `odfvalidator` from OdfToolkit.)

### Other examples
Other examples are implemented as integration tests: ```OdsFileCreationIT.java```, ```OdsFileWithHeaderAndFooterCreationIT.java```, etc.

To run those examples, one has to run:

```mvn verify```

The resulting ods files are written in `generated_files` directory, and can be opened with LibreOffice or OpenOffice.
See [the integration tests directory](https://github.com/jferard/fastods/tree/master/fastods/src/test/java/com/github/jferard/fastods/it)

## Speed
Let's be concrete : FastODS is approximately twice as fast as SimpleODS and ten times faster than JOpenDocument for writing large ODS files. (SimpleODF is clearly not the right tool to write large ODS files.)

For more details, see https://github.com/jferard/fastods/wiki/Benchmarking-and-profiling.

## History
See https://github.com/jferard/fastods/releases