Tutorial Apache POI: scriviamo e leggiamo un documento Word

In questo articolo vedremo come creare un documento Word e come successivamente possiamo leggerlo, tramite la libreria Apache POI. Purtroppo le API non sono complete come per la versione Excel e non esistono interfacce Wrapper per entrambe le versioni HWPF e XWPF, in poche parole dovremo usare due classi distinte se vogliamo creare  e/o leggere un file di tipo .doc o di tipo .docx e, ancora peggio, il loro utilizzo è piuttosto differente.

Prima di vedere qualche esempio, elenchiamo le dipendenze della libreria POI:

Nella tabella precedente troviamo nella prima colonna il nome del Componente della libreria Apche POI, nella seconda colonna il Tipo di Applicazione per cui viene utilizzato ed infine nella terza colonna l’Id dell’Artefatto Maven che lo implementa.

(*) a partire dalla 3.6-beta1-20091124.

In questa ultima tabella vediamo nella seconda colonna i prerequisiti per i vari Artifatti Maven ed il corrispondente jar (che troviamo incluso nel download della libreria Apache POI).

Facciamo un esempio: se dovessimo usare il componente HWPF (documenti .doc) dovremmo includere nel nostro classpath i jar  commons-logging e log4j ed utilizzare la libreria poi-scratchpad-version-yyyymmdd.jar e poi-version-yyyymmdd.jar; se invece volessimo utilizzare il componente XWPF (documenti .docx) dovremmo includere oltre alle librerie precedenti, i jar xmlbeans, stax-api-1.0.1, dom4j, poi-ooxml-version-yyyymmdd.jar e poi-ooxml-schemas-version-yyyymmdd.jar.

Nel caso in cui usiamo Eclipse come IDE di sviluppo dobbiamo includere tali librerie nel Build Path del Progetto Java.

Facciamo ora qualche esempio prima con le API del componente HWPF. La prima cosa da fare è aprire un file .doc in quanto non è possibile crearne uno da programma (il costruttore HWPFDocument() è di tipo protected:

String nomefile = "test.doc";
POIFSFileSystem fs = new POIFSFileSystem(new FileInputStream(nomefile));
HWPFDocument doc = new HWPFDocument(fs);

per poter modificare il testo contenuto nel documento word dobbiamo avere una istanza della classe Range che rappresenta l’insieme di testo all’interno del file .doc, possiamo poi prendere i vari elementi quali i Paragrafi direttamente da esso. Per ottenere il Range utilizziamo il metodo getRange():

Range range = doc.getRange();
range.insertAfter("Hello World!!");

con i metodi insertBefore e insertAfter possiamo aggiungere del testo prima e dopo del Range. Dal Range possiamo poi ottenere i Paragrafi e i CharacterRuns (insieme di testo che condivide le stesse proprietà).

Un metodo più efficace di estrarre il testo è istanziando una calsse di tipo WordExtractor:

WordExtractor we = new WordExtractor(doc);
String[] paragrafi = we.getParagraphText();
System.out.println( "Il documento Word ha " + paragrafi.length + " paragrafi" );
for( int i=0; iparagrafi[i] = paragrafi[i].replaceAll("\cM?r?n","");
System.out.println( "Testo: "+paragrafi[ i ]);
System.out.println( "Lunghezza: "+paragrafi[ i ].length());
}

Con il codice su riportato estraiamo i paragrafi dal doc e li inseriamo in un array di stringhe (una stringa per ogni paragrafo) e poi iteriamo stampando a video lunghezza e contenuto. Possiamo anche utilizzare più semplicemente il metodo getText() di WordExtractor per ottenere tutto il testo del doc.

Utilizzando invece la classe XWPFDocument (per file .docx) non abbiamo bisogno di un file preesistente, ma possiamo scriverne uno alla fine delle nostre manipolazioni.

Proviamo a creare dei paragrafi, utilizzando stili e allineamenti diversi, creiamo inoltre all’interno dei paragrafi, degli XWPFRun che sono porzioni di testo che condividono lo stesso stile e formato:

package it.appuntisoftware;

import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;

import org.apache.poi.xwpf.usermodel.Borders;
import org.apache.poi.xwpf.usermodel.ParagraphAlignment;
import org.apache.poi.xwpf.usermodel.VerticalAlign;
import org.apache.poi.xwpf.usermodel.XWPFDocument;
import org.apache.poi.xwpf.usermodel.XWPFParagraph;
import org.apache.poi.xwpf.usermodel.XWPFRun;

public class TestWordPOI {

public static void main(String[] args) {

String filename = "text.docx";
XWPFDocument document = new XWPFDocument();

XWPFParagraph paragrafoUno = document.createParagraph();
paragrafoUno.setAlignment(ParagraphAlignment.CENTER);
paragrafoUno.setBorderBottom(Borders.SINGLE);
paragrafoUno.setBorderTop(Borders.SINGLE);
paragrafoUno.setBorderRight(Borders.SINGLE);
paragrafoUno.setBorderLeft(Borders.SINGLE);
paragrafoUno.setBorderBetween(Borders.SINGLE);

XWPFRun paragrafoUnoRunUno = paragrafoUno.createRun();
paragrafoUnoRunUno.setBold(true);
paragrafoUnoRunUno.setItalic(true);
paragrafoUnoRunUno.setText("Hello world! Questo è il paragrafo Uno, Run Uno!");
paragrafoUnoRunUno.addBreak();

XWPFRun paragrafoUnoRunDue = paragrafoUno.createRun();
paragrafoUnoRunDue.setText("Secondo Run!");
paragrafoUnoRunDue.setTextPosition(100);

XWPFRun paragrafoUnoRunTre = paragrafoUno.createRun();
paragrafoUnoRunTre.setStrike(true);
paragrafoUnoRunTre.setFontSize(20);
paragrafoUnoRunTre.setSubscript(VerticalAlign.SUBSCRIPT);
paragrafoUnoRunTre.setText(" Ancora paragrafo Uno...");

XWPFParagraph paragrafoDue = document.createParagraph();
paragrafoDue.setAlignment(ParagraphAlignment.DISTRIBUTE);
paragrafoDue.setIndentationRight(200);

XWPFRun paragraphTwoRunOne = paragrafoDue.createRun();
paragraphTwoRunOne.setText("Questo è il paragrafo due!");
FileOutputStream outStream = null;
try {
outStream = new FileOutputStream(filename);
document.write(outStream);
outStream.close();
} catch (FileNotFoundException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}

Possiamo inoltre creare e riempire delle tabelle di testo:

XWPFDocument document = new XWPFDocument();
int righe = 5, colonne = 5;
XWPFTable table = document.createTable(righe , colonne);
for(int i=0; i< righe; i++)
for(int j=0; j< colonne; j++)
table.getRow(i).getCell(j).addParagraph().createRun()
.setText("cella: ["+i+"]["+j+"]" );