Apache Poi Recipes

transcript

Apache POIRecipesPaolo Mottadelli - ApacheCon Oakland 2009

http://chromasia.comThursday, November 5, 2009

- ApacheCon US 2009, Oakland - Apache POI Recipes -

paolo@apache.org

my to-do list

Thursday, November 5, 2009

paolo@apache.org

POI @ Content Tech

✴ Document to application (and back)✴ Publish data

✴ Build a doc from your content

✴ Know your documents✴ Extract text

✴ Extract content

1A-B-C

paolo@apache.org

POI modules (1): OLE2

✴ POIFS: reading/writing Office Documents

✴ HSSF r/w Excel Spreadsheets

✴ HWPF r/w Word Docs

✴ HSLF r/w PowerPoint Docs

✴ HPSF r/w property sets

paolo@apache.org

POI modules (2): OOXML

✴ XSSF: r/w OXML Excel

✴ XWPF: r/w OXML Word

✴ XSLF: r/w OXML PowerPoint

POI 3.5

http://chromasia.comThursday, November 5, 2009

paolo@apache.org

OOXML dev status

✴ XSSF: Final in POI-3.5

✴ XWPF: Draft (basic features)

✴ XSLF: Not covered (only text ext.)

paolo@apache.org

HSSF & XSSF

✴ Common user model interface

✴ User model based on existing HSSF

✴ Using OpenXML4J and SAX

2Same recipe, different flavours

paolo@apache.org

Common H/XSSF access

✴ org.apache.poi.ss.usermodel

paolo@apache.org

Upgrading to POI-3.5

✴ HSSFFormulaEvaluator.CellValue✴ convert from .hssf. to .ss.

✴ HSSFRow.MissingCellPolicy✴ convert from .hssf. to .ss.

✴ RecordFormatException in DDF✴ convert from .hssf. to .util. Dreadful Drawing Format

3MeetOffice Open XML

paolo@apache.org

Open XML

✴ XML based✴ WordprocessingML

✴ SpreadsheetML

✴ PresentationML

✴ Stored as a package✴ Open Packaging Conventions

made (very) simple

paolo@apache.org

Package concepts

✴ Package (the container)

✴ Part (xml file)

✴ Relationship✴ package-relationship

✴ part-relationship

paolo@apache.org

Expanded package, Excel

paolo@apache.org

WordprocessingML

✴ body✴ paragraphs

✴ runs

✴ properties (for runs and pars)

✴ styles

✴ headers/footers ...

paolo@apache.org

SpreadsheetML

✴ workbook✴ worksheets

✴ rows

✴ cells

✴ styles

✴ formulas

✴ images ...

paolo@apache.org

PresentationML

✴ presentation✴ slides

✴ slides-masters

✴ notes-masters

✴ layout, animation, audio, video, transitions ...

4openxml4j

paolo@apache.org

openXML4J

✴ Package, parts, rels

"/xl/worksheets/sheet1.xml"

5Text Extraction

paolo@apache.org

Extractors

✴ POITextExtractor✴ POIOLE2TextExtractor

✴ POIXMLTextExtractor

✴ XSSFExcelExtractor

✴ XWPFWordExtractor

✴ XSLFPowerPointExtractor

✴ If text is all what you need

getText()

paolo@apache.org

Text extraction

✴ made simple

6EXCELSimple Tasks

paolo@apache.org

New Workbook

paolo@apache.org

New Sheet

paolo@apache.org

Creating Cells

paolo@apache.org

Cell types

paolo@apache.org

Fills and colors

7EXCELImp/Exp to XML

paolo@apache.org

Export to XML

paolo@apache.org

xmlMaps.xml

paolo@apache.org

XML Import/Export

8WORDSimple Doc

paolo@apache.org

A simple doc

paolo@apache.org

9Use Case 1Alfresco Search

paolo@apache.org

Use Case

✴ Upload a document

✴ Detect document mimetype

✴ Extract text and metadata

✴ Create search index

✴ Search (and find) the document

paolo@apache.org

Without Tika✴ Detect the document mimetype

✴ (source/target mimetype)

✴ Get the proper ContentTransformer✴ (ContentTransformerRegistry)

✴ Tranform Doc Content to Text✴ (PoiHssfContentTransformer)

✴ Create Lucene indexPOI here

paolo@apache.org

With Tika

paolo@apache.org

Extension use case

✴ Adding support for Office Open XML documents (Office 2007+)✴ Word 2007+

✴ Excel 2007+

✴ PowerPoint 2007+

paolo@apache.org

POI text extractors

✴ Remember?

paolo@apache.org

Apache Tika (Excel)

paolo@apache.org

Apache Tika

paolo@apache.org

Apache Tika (Word)

paolo@apache.org

Apache Tika (Word)

10Use Case 2JM LaffertyFinancial Forecasting

paolo@apache.org

Make your wb look pro-

✴ Rich text

✴ Graphics

✴ Formulas & Named Ranges

✴ Data validations

✴ Conditional formatting

✴ Cell comments

paolo@apache.org

Formula evaluation

✴ The evaluation engine enables you to calculate formula results from within a POI application

✴ Formulas may be added to your workbook by POI

✴ Evaluation is available for .xls and .xlsx

paolo@apache.org

Formula evaluation (continued)

✴ All arithmetic operators are implemented

✴ Over 280 Excel built in functions are supported

paolo@apache.org

Formula evaluation (code)

11Use Case 3:CQ5 Import

paolo@apache.org

importDocument()

paolo@apache.org

getParagraphs(...)

✴ Makes use of✴ org.apache.poi.hwpf.usermodel.Range

paolo@apache.org

importDocument()

paolo@apache.org

getTitle(...)

✴ Gets the first paragraph’s text

paolo@apache.org

importDocument()

paolo@apache.org

12Want more?

paolo@apache.org

More Examples

✴ http://poi.apache.org/spreadsheet/examples.html

paolo@apache.org

Even more

✴ Get in touch✴ http://poi.apache.org/

✴ Get informed✴ dev@poi.apache.org

✴ Get involved✴ http://svn.apache.org/repos/asf/poi/trunk/

paolo@apache.org

✴ Get slides✴ http://www.slideshare.net/paolomoz/apache-poi-recipes

Thanks

Apache Poi Recipes

Technology