Skip to main content

Document code examples

General​

Single-document access​

DocumentDB can access a document field (obj is the business object):

// Get document meta-data from DB
DocumentDB doc = obj.getField("myDocField").getDocument(getGrant());
// Absolute path in DOC_DIR + relative path (not available with BLOB)
String path = Platform.getDocDir() + "/" + doc.getPath();
// Or input-stream to read the document
InputStream is = doc.getInputStream();
// Or force a full read in memory
byte[] b = doc.getBytes(true);

Handling document content​

It is possible to save a generated document directly into a business object document field:

// With an input stream to preserve memory heap
obj.getField("myDocField").setDocument(obj, "docname.pdf", inputStream);
// Or with a content as bytes in memory
obj.getField("myDocField").setDocument(obj, "docname.pdf", bytesArray);
obj.save();

Note: the file name must include an appropriate extension vs the content of the stream or byte array.

Multi-documents access​

Since V5 DocumentDB can access a multi-documents field:

// Load all documents meta-data of the current record from DB (null if the field is not a multi-documents field)
List<DocumentDB> docs = getField("myMultiDocsField").getListOfDocuments(this, getRowId());
for (int i=0; docs!=null && i<docs.size(); i++) {
	// Single document
	DocumentDB doc = docs.get(i);
	// Document ID and name
	String id = doc.getId();
	String name = doc.getName();
	// Absolute path in DOC_DIR + relative path
	String path = Platform.getDocDir() + "/" + doc.getPath();
	// Content is read only on demand
	byte[] b = doc.getBytes(true);
	// ...
}

The same can be done in two steps, loadDocuments returns a DocumentDB container of all documents:

// This DocumentDB contains many documents
DocumentDB multiDocs = getField("myMultiDocsField").loadDocuments(this, getRowId());
// Get the list of documents
List<DocumentDB> docs = multiDocs!=null ? multiDocs.getDocuments() : null;
// Or get one document by its ID
DocumentDB doc = multiDocs!=null ? multiDocs.getDocument(docId) : null;

Note: only the documents meta-data are loaded (ID, name, path, size, MIME type...), the contents are read only when calling getBytes, getInputStream...

or without DB access to retrieve meta-data already loaded:

// This DocumentDB contains many documents
DocumentDB multiDocs = getField("myMultiDocsField").getDocument();
// Get the list of documents
List<DocumentDB> docs = multiDocs!=null ? multiDocs.getDocuments() : null;
// ...

QRCodes images​

As of version 3.0, the standard QRCodeTool helper class provides various methods for generating QR codes images as PNG.

Typical usage is to set an image field with a URL QR code:

obj.getField("myQRCode").setDocument(obj, "qrcode.png", QRCodeTool.qrCodeImage(Globals.getContextURL()));

Barcodes images​

As of version 3.1, the standard BarcodeTool helper class provides various methods for generating EAN13 Barcodes.

EAN13 checksum​

The BarcodeTool.checkSum method can be used to calculate the checksum digit of a code. Typical usage is:

code = "123456789012"; // 12 digits code
code += BarcodeTool.checkSum(code); // 13 digits code with checksum

EAN13 barcode image​

A EAN13 code (12 digits + 1 checksum digit) can then be used to generate a JPEG image, for instance to set an image field:

obj.getField("myEAN13Barcode").setDocument(obj, code + ".jpg", BarcodeTool.ean13Image(code));

PDF documents using iText® 2.1.7​

This example is given in the server-side Rhino scripting language. It can be easily transposed to Java language.

To use the iText® library classes you need to include the com.lowagie.text package explicitly. For more information on itext 2.1.7 available on the Javadoc.

import com.lowagie.text.*;

(...)

ByteArrayOutputStream bos = new java.io.ByteArrayOutputStream();

Document pdf = PDFTool.open(bos);
pdf.add(new Paragraph("Hello world !"));
(...)
PDFTool.close(pdf);

byte[] bytes = bos.toByteArray();
// Do something with document content...

Note that it is possible to insert resource images in the PDF document, e.g.:

pdf.add(PDFTool.getImageFromResource(obj.getGrant(), "MYIMAGERESOURCECODE"));

Excel(R) sheet using Apache POI®​

Create a basic sheet​

import com.simplicite.util.tools.ExcelPOITool;

(...)

ExcelPOITool xls = new ExcelPOITool(); // or ExcelPOITool(true); as of version 4.0, the true argument means using XLSX format
ExcelSheet s = xls.newSheet("MyNewSheet");
ExcelRow r = xls.newRow(0);
ExcelCell c = xls.newCell(0, "Hello World !");
r.add(c);
s.add(r);
xls.add(s);
bytes[] bytes = xls.generateToByteArray();
// Do something with byte array...

Create an advanced sheet​

For this advanced usage of the Apache POI lib you need to include the org.apache.poi.hssf.usermodel package explicitly.

import com.simplicite.util.tools.ExcelPOITool;
import org.apache.poi.hssf.usermodel.*;

(...)

ExcelTool xls = new ExcelTool(true);
Sheet sheet = xls.addSheet("Custom");
for (int i = 0; i < rows.size(); i++) {
	ExcelRow r = new ExcelRow(i);
	String[] row = rows.get(i);
	for (int j = 0; j < row.length; j++) {
		r.add(xls.newCell(j, row[j]));
	}
	xls.addRow(sheet, r);
}
bytes[] bytes = xls.generateToByteArray();
// Do something with byte array...

Word(R) sheet using Docx4j​

In the below example we add HTML fragments to a Word(R) document.

Create a basic document​

import com.simplicite.util.tools.DocxTool;

(...)

DocxTool dt = new DocxTool();
dt.newDocument();
dt.addHTML(html);
dt.toByteArray();
bytes[] bytes = dt.toByteArray();
// Do something with byte array...

Create from an existing template document​

DocxTool dt = new DocxTool(doc.getFile());
dt.addHTML(html);
bytes[] bytes = dt.toByteArray();
// Do something with byte array...

In the above example doc is a Simplicité document.

For instance you can get it:

  • from a business object document field: doc = obj.getField("myDoc").getDocument() (obj is the business object)
  • from a publication template: doc = pt.getDocument(obj.getGrant()) (pt is the publication template)
  • Etc.
Last updated on