Mirror of Apache POI
Switch branches/tags
Clone or download
PJ Fanning
PJ Fanning [bug-62747] bouncycastle 1.60
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1841394 13f79535-47bb-0310-9956-ffa450edef68
Latest commit f4aef7a Sep 19, 2018
Permalink
Failed to load latest commit information.
.settings bump the Eclipse compile source to Java 1.8 Oct 31, 2017
gradle/wrapper Update Gradle wrapper to 4.6 Jun 10, 2018
jenkins Use different directory for xerces-jar so we do not remove it again a… Sep 7, 2018
legal remove reference to Piccolo parser Sep 1, 2018
maven update commons-codec dependency in pom.xml to 1.11 (to match compile … Sep 18, 2018
osgi update 3.17 leftovers and provide a new build target to update those … Sep 7, 2018
sonar [bug-62747] bouncycastle 1.60 Sep 19, 2018
src [bug-62747] bouncycastle 1.60 Sep 19, 2018
test-data bug 62591 -- revert to ignoring place holders even if they contain me… Aug 9, 2018
.classpath [bug-62747] bouncycastle 1.60 Sep 19, 2018
.gitattributes Add .gitattribute file and set lf for one sample-file, see bug 61609 Jan 1, 2018
.gitignore [Bug-61354] fix issue with extracting text from Word docs. This closes Jul 28, 2017
.project revert accidental commit Jun 15, 2016
KEYS changed expiry date of kiwiwings entry Jul 7, 2018
README.rst update docs to Java 1.8 Sep 1, 2018
build.gradle [bug-62747] bouncycastle 1.60 Sep 19, 2018
build.xml [bug-62747] bouncycastle 1.60 Sep 19, 2018
doap_POI.rdf update 3.17 leftovers and provide a new build target to update those … Sep 7, 2018
file-leak-detector.exclude Add initial file of excludes when running with file-leak-detector Apr 16, 2017
gradlew add gradle wrapper Jan 26, 2018
gradlew.bat add gradle wrapper Jan 26, 2018
patch.xml Tweak Aug 2, 2016
settings.gradle Add initial compile steps with a simple multi-project setup to build.… Oct 7, 2016

README.rst

Apache POI

A Java library for reading and writing Microsoft Office binary and OOXML file formats.

The Apache POI Project's mission is to create and maintain Java APIs for manipulating various file formats based upon the Office Open XML standards (OOXML) and Microsoft's OLE 2 Compound Document format (OLE2). In short, you can read and write MS Excel files using Java. In addition, you can read and write MS Word and MS PowerPoint files using Java. Apache POI is your Java Excel solution (for Excel 97-2008). We have a complete API for porting other OOXML and OLE2 formats and welcome others to participate.

OLE2 files include most Microsoft Office files such as XLS, DOC, and PPT as well as MFC serialization API based file formats. The project provides APIs for the OLE2 Filesystem (POIFS) and OLE2 Document Properties (HPSF).

Office OpenXML Format is the new standards based XML file format found in Microsoft Office 2007 and 2008. This includes XLSX, DOCX and PPTX. The project provides a low level API to support the Open Packaging Conventions using openxml4j.

For each MS Office application there exists a component module that attempts to provide a common high level Java api to both OLE2 and OOXML document formats. This is most developed for Excel workbooks (SS=HSSF+XSSF). Work is progressing for Word documents (WP=HWPF+XWPF) and PowerPoint presentations (SL=HSLF+XSLF).

The project has some support for Outlook (HSMF). Microsoft opened the specifications to this format in October 2007. We would welcome contributions.

There are also projects for Visio (HDGF and XDGF), TNEF (HMEF), and Publisher (HPBF).

This library includes the following components, roughly in descending order of maturity:

  • Excel spreadsheets (Common SS = HSSF, XSSF, and SXSSF)
  • PowerPoint slideshows (Common SL = HSLF and XSLF)
  • Word processing documents (Common WP = HWPF and XWPF)
  • Outlook email (HSMF and HMEF)
  • Visio diagrams (HDGF and XDGF)
  • Publisher (HPBF)

And lower-level, supporting components:

  • OLE2 Filesystem (POIFS)
  • OLE2 Document Properties (HPSF)
  • TNEF (HMEF) for Outlook winmail.dat files
  • OpenXML4J (OOXML)
Components named H??F are for reading or writing OLE2 binary formats.
Components named X??F are for reading or writing OpenOffice XML (OOXML) formats.

Getting started

Website: https://poi.apache.org/

Mailing lists:

Bug tracker:

Source code:

Requires Java 1.8 or later.

Contributing

  • Download and install svn or git, Java JDK 1.8+, and Apache Ant 1.8+ or Gradle
  • Check out the code from svn or git
  • Import the project into Eclipse or your favorite IDE
  • Write a unit test:
    • Binary formats and Common APIs: src/testcases/org/apache/poi/
    • OOXML APIs only: src/ooxml/testcases/org/apache/poi/
    • Scratchpad (Binary formats): src/scratchpad/testcases/org/apache/poi/
    • test files: test-data/
  • Navigate the source, make changes, and run unit tests to verify
    • Binary formats and Common APIs: src/java/org/apache/poi/
    • OOXML APIs only: src/ooxml/java/org/apache/poi/
    • Scratchpad (Binary formats): src/scratchpad/src/org/apache/poi/
    • Examples: src/examples/src/org/apache/poi/

Building jar files

To build the jar files for poi, poi-ooxml, poi-ooxml-schemas, and poi-examples:

ant jar