org.wickedsource.docxstamper

Class DocxStamper<T>

java.lang.Object

org.wickedsource.docxstamper.DocxStamper<T>

Type Parameters:

T - the class of the context object used to resolve expressions against.

public class DocxStamper<T>
extends Object

Main class of the docx-stamper library. This class can be used to "stamp" .docx templates to create a .docx document filled with custom data at runtime.

Constructor Summary

Constructors

Constructor and Description
DocxStamper()
DocxStamper(DocxStamperConfiguration config)

Method Summary

Modifier and Type	Method and Description
CommentProcessorRegistry	getCommentProcessorRegistry() Returns the registry in which all ICommentProcessors are registeres.
TypeResolverRegistry	getTypeResolverRegistry() Returns the registry in which all ITypeResolvers are registered.
void	setFailOnUnresolvedExpression(boolean failOnUnresolvedExpression) If set to true, calling stamp(InputStream, Object, OutputStream) will throw an UnresolvedExpressionException if a variable expression or processor expression within the document or within the comments is encountered that cannot be resolved.
void	stamp(InputStream template, T contextRoot, OutputStream out) Reads in a .docx template and "stamps" it into the given OutputStream, using the specified context object to fill out any expressions it finds.
void	stamp(org.docx4j.openpackaging.packages.WordprocessingMLPackage document, T contextRoot, OutputStream out) Same as stamp(InputStream, T, OutputStream) except that you may pass in a DOCX4J document as a template instead of an InputStream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocxStamper

public DocxStamper()

DocxStamper

public DocxStamper(DocxStamperConfiguration config)

Method Detail

stamp

public void stamp(InputStream template,
                  T contextRoot,
                  OutputStream out)
           throws DocxStamperException

Reads in a .docx template and "stamps" it into the given OutputStream, using the specified context object to fill out any expressions it finds.

In the .docx template you have the following options to influence the "stamping" process:

• Use expressions like ${name} or ${person.isOlderThan(18)} in the template's text. These expressions are resolved against the contextRoot object you pass into this method and are replaced by the results.
• Use comments within the .docx template to mark certain paragraphs to be manipulated.

Within comments, you can put expressions in which you can use the following methods by default:

• displayParagraphIf(boolean) to conditionally display paragraphs or not
• displayTableRowIf(boolean) to conditionally display table rows or not
• displayTableIf(boolean) to conditionally display whole tables or not
• repeatTableRow(List<Object>) to create a new table row for each object in the list and resolve expressions within the table cells against one of the objects within the list.

If you need a wider vocabulary of methods available in the comments, you can create your own ICommentProcessor and register it via getCommentProcessorRegistry().registerCommentProcessor().

Parameters:

template - the .docx template.

contextRoot - the context root object against which all expressions found in the template are evaluated.

out - the output stream in which to write the resulting .docx document.

Throws:

DocxStamperException - in case of an error.

stamp

public void stamp(org.docx4j.openpackaging.packages.WordprocessingMLPackage document,
                  T contextRoot,
                  OutputStream out)
           throws DocxStamperException

Same as stamp(InputStream, T, OutputStream) except that you may pass in a DOCX4J document as a template instead of an InputStream.

Parameters:

document - the .docx template.

contextRoot - the context root object against which all expressions found in the template are evaluated.

out - the output stream in which to write the resulting .docx document.

Throws:

DocxStamperException - in case of an error.

getTypeResolverRegistry

public TypeResolverRegistry getTypeResolverRegistry()

Returns the registry in which all ITypeResolvers are registered. Use it to register your own ITypeResolver implementation.

getCommentProcessorRegistry

public CommentProcessorRegistry getCommentProcessorRegistry()

Returns the registry in which all ICommentProcessors are registeres. Use it to register your own ICommentProcessor implementation.

setFailOnUnresolvedExpression

public void setFailOnUnresolvedExpression(boolean failOnUnresolvedExpression)

If set to true, calling stamp(InputStream, Object, OutputStream) will throw an UnresolvedExpressionException if a variable expression or processor expression within the document or within the comments is encountered that cannot be resolved. Is set to true by default.