search

verronpro / docx-stamper

Easy-to-use template engine for creating docx documents in Java.
https://verronpro.github.io/docx-stamper/
MIT License
18 stars 8 forks source link
docx hacktoberfest template word

readme

// suppress inspection "AsciiDocLinkResolve" for whole file :proj: https://github.com/verronpro/docx-stamper :repo: https://github.com/verronpro/docx-stamper/blob/main :module: pro.verron.officestamper :engine: https://github.com/verronpro/docx-stamper/blob/main/engine/src/main/java/pro/verron/officestamper/

= OfficeStamper

== Introduction

OfficeStamper (formerly Docx-Stamper) is a Java template engine that allows for dynamic creation of DOCX documents at runtime. You design a template using your preferred Word processor; and OfficeStamper will generate documents based on that template.

image:{proj}/actions/workflows/integrate-os.yml/badge.svg[Build Status,link={proj}/actions/workflows/integrate-os.yml] image:{proj}/actions/workflows/integrate-docx4j.yml/badge.svg[Build Status,link={proj}/actions/workflows/integrate-docx4j.yml] image:{proj}/actions/workflows/analyze.yml/badge.svg[Build Status,link={proj}/actions/workflows/analyze.yml] image:{proj}/actions/workflows/pages.yml/badge.svg[Build Status,link={proj}/actions/workflows/pages.yml]

== Release Notes

=== {proj}/releases/tag/v2.6.0[v2.6.0]

==== Features

==== Dependencies

==== Continuous Integration

==== Refactorings

==== Tests

=== Previous releases notes link:RELEASE_NOTES.adoc[here]

== Usage

Here is a code snippet exemplifying how to use OfficeStamper:

[source,java]

class Example { public static void main(String[] args) { // a java object to use as context for the expressions found in the template. var context = new YourPojoContext(, , _);

    // an instance of the stamper
    var stamper = OfficeStampers.docxStamper();

    try(
        // Path to the .docx template file
        var template = Files.newInputStream(Paths.get("your/docx/template/file.docx"));
        // Path to write the resulting .docx document
        var output = Files.newOutputStream(Paths.get("your/desired/output/path.docx"))
    ) {
        stamper.stamp(template, context, output);
    }
}

}

== Template Expressions and Their Usage

The foundation of OfficeStamper lies in its ability to replace expressions within the text of a .docx template document. Conveniently, add expressions such as ${person.name} or ${person.name.equals("Homer") ? "Duff" : "Budweiser"} in the text of the .docx file you're using as a template. Then, provide a context object to resolve the placeholder. Don't worry about formatting, OfficeStamper will maintain the original text's formatting in the template. You have full access to the extensive feature set of link:http://docs.spring.io/spring/docs/current/spring-framework-reference/html/expressions.html[Spring Expression Language (SpEL)].

=== Resolvers Order

[cols="1,2,2",options="header"] |=== | Default Resolvers | When the placeholder resolves to a | It will be replaced in the document with | Resolvers.image() | link:{engine}preset/Image.java[{module}.preset.Image] | an inline image | Resolvers.legacyDate() | java.util.Date | a formatted Date string (default "dd.MM.yyyy") | Resolvers.isoDate() | java.time.LocalDate | a formatted Date string (default DateTimeFormatter.ISO_LOCAL_DATE) | Resolvers.isoTime() | java.time.LocalTime | a formatted Date string (default DateTimeFormatter.ISO_LOCAL_TIME) | Resolvers.isoDateTime() | java.time.LocalDateTime | a formatted Date string (default DateTimeFormatter.ISO_LOCAL_DATE_TIME) | Resolvers.nullToEmpty() | null | an empty string | Resolvers.fallback() | Object | the result of the call to String.valueOf() method on the object |===

If a placeholder fails to resolve successfully, OfficeStamper will skip it, the placeholder in the document remains the same as its initial state in the template.

=== Comment Processors

Alongside expression replacement, Office-Stamper presents the feature of processing comments associated with paragraphs in your .docx template. These comments act as directives for manipulating the template. As a standard, the following expressions can be used within comments:

.Default activated comment processors [cols=">1,4"] |=== | Expression in .docx comment | Effect on the commented paragraph/paragraphs | displayParagraphIf(boolean) | It is only displayed if condition resolves to true. | displayTableRowIf(boolean) | The table row around it is only displayed if condition resolves to true. | displayTableIf(boolean) | The whole table around it is only displayed if condition resolves to true. | repeatParagraph(List<Object>) | It is copied once for each object in the passed-in list. Expressions found in the copies are evaluated against the object from the list. | repeatTableRow(List<Object>) | The table row around it is copied once for each object in the passed-in list. Expressions found in the cells of the table row are evaluated against the object from the list. | repeatDocPart(List<Object>) | It is copied once for each object in the passed-in list. Expressions found in the copies are evaluated against the object from the list. Can be used instead of repeatTableRow and repeatParagraph if you want to repeat more than table rows and paragraphs. | replaceWordWith(expression) | Replace the commented word with the value of the given expression. | resolveTable(StampTable) | Replace a table (that must have one column and two rows) with the values given by the StampTable. The StampTable contains a list of headers for columns, and a 2-level list of rows containing values for each column. |===

By default, an exception is thrown if a comment fails to process. However, successfully processed comments are wiped from the document.

=== SpEL functions

Office-stamper provides some function already added to the standard configuration, notably to format date & time objects.

.Default activated comment processors [cols=">1,4"] |=== | Function in .docx | Effect on the January 1st, 2000 at the 23h34m45s 567 nano, and from zone UTC+2 in Korean Locale | fdate(date) | ISO: 2000-01-12+02:00 | fdatetime(date) | ISO: 2000-01-12T23:34:45.000000567+02:00[UTC+02:00] | ftime(date) | ISO: 23:34:45.000000567+02:00 | finstant(date) | ISO: 2000-01-12T21:34:45.000000567Z | fbasicdate(date) | ISO: 20000112+0200 | fordinaldate(date) | ISO: 2000-012+02:00 | fweekdate(date) | ISO: 2000-W02-3+02:00 | f1123datetime(date) | Wed, 12 Jan 2000 23:34:45 +0200 | foffsetdate(date) | ISO: 2000-01-12+02:00 | foffsetdatetime(date) | ISO: 2000-01-12T23:34:45.000000567+02:00 | foffsettime(date) | ISO: 23:34:45.000000567+02:00 | fzoneddatetime(date) | ISO: 2000-01-12T23:34:45.000000567+02:00[UTC+02:00] | flocaldate(date) | ISO: 2000-01-12 | flocaldate(date, style) | Style can be FULL, LONG, MEDIUM or SHORT: 2000년 1월 12일 수요일 to 00. 1. 12. | flocaltime(date) | 23:34:45.000000567 | flocaltime(date, String) | Style can be FULL, LONG, MEDIUM or SHORT: 오후 11시 34분 45초 UTC+02:00 to 오후 11:34 | flocaldatetime(date) | 2000-01-12T23:34:45.000000567 | flocaldatetime(date, style) | Style can be FULL, LONG, MEDIUM or SHORT for the same effect as flocaldate or flocaltime | flocaldatetime(date, dateStyle, timeStyle) | Style can be FULL, LONG, MEDIUM or SHORT for the same effect as flocaldate or flocaltime | fpattern(date, pattern) | run your own datetime pattern | fpattern(date, pattern, locale) | run your own datetime pattern with a specified locale |===

== Custom settings

=== Custom resolvers

You can expand the resolution capability by implementing custom link:{engine}api/ObjectResolver.java[ObjectResolver].

Here's a code snippet on how to proceed:

[source,java]

class Main { public static void main(String... args) { // instance of your own ObjectResolver implementation var customResolver = new StringResolver(YourCustomType.class){ @Override public String resolve(YourCustomType object){ return doYourStuffHere(); // this is your implementation detail } };

    var configuration = OfficeStamperConfigurations.standardWithPreprocessing();
    configuration.addResolver(resolver);

    var stamper = OfficeStampers.docxStamper(configuration);
}

}

=== Custom functions

OfficeStamper lets you add custom functions to the tool's expression language. For example, if you need specific formats for numbers or dates, you can register such functions which can then be used in the placeholders throughout your template.

Below is a sample code demonstrating how to extend the expression language with a custom function. This particular example adds a function toUppercase(String), enabling you to convert any text in your .docx document to uppercase.

[source,java]

import java.time.LocalDate;import java.time.format.DateTimeFormatter;class Main { public static void main(String... args) { var configuration = OfficeStamperConfigurations.standardWithPreprocessing();

    // add `today()` function to use in the template to retrieve current date, at time of running the stamping
    config.addCustomFunction("today", () -> LocalDate.now());

    // add `censor(String)` function, to remove the f-word from resolved template values.
    config.addCustomFunction("censor", String.class, input -> input.replace("f-word", "f**k"));

    // add `add(Integer, Integer)` function to sum 2 values together after their resolution.
    config.addCustomFunction("add", Integer.class, Integer.class, (a, b) -> a + b);

    // add `format(Date, String, String)` function to format a date with a pattern and a locale.
    config.addCustomFunction("format", LocalDate.class, String.class, String.class, (date, pattern, locale) -> DateTimeFormatter.ofPattern(pattern, locale).format(date));

    //
    interface StringFunctionProvider {
        String toUppercase(String string);
        String toLowercase(String string);
    }

    class StringFunctionProviderImpl implements StringFunctionProvider {
        String toUppercase(String string){return string.toUpperCase();}
        String toLowercase(String string){return string.toUpperCase();}
    }

    configuration.exposeInterfaceToExpressionLanguage(UppercaseFunction.class, new StringFunctionProviderImpl());
    var stamper = OfficeStampers.docxStamper(configuration);
}

}

Chains of such custom functions can enhance the versatility of OfficeStamper, making it able to handle complex and unique templating situations.

=== Custom Comment Processors

For additional flexibility, create your own expression within comments by implementing your link:{repo}/src/main/java/org/wickedsource/docxstamper/api/commentprocessor/ICommentProcessor.java[ICommentProcessor].

Here's an example of how to create and register a custom comment processor:

[source,java]

class Main { public static void main(String... args) { // interface defining the methods to expose to the expression language interface IYourCommentProcessor { void yourComment(String ); // 1+ argument of the type you expect to see in the document void yourSecondComment(String , CustomType _); // theoretically, any number of comment can be added } class YourCommentProcessor extends BaseCommentProcessor { @Override public void commitChanges(WordprocessingMLPackage document) {/Do something to the document/} @Override public void reset() {/ reset processor state for re-run of the stamper /} } var commentProcessor = new YourCommentProcessor(); var configuration = new DocxStamperConfiguration() .addCommentProcessor(IYourCommentProcessor.class, commentProcessor); var stamper = OfficeStampers.docxStamper(configuration); } }

=== Custom SpEL Evaluation Context

At times, you might want to exert more control over how expressions are evaluated. With Office-Stamper, there's provision for such scenarios. Here’s how:

Implement your own link:{engine}api/EvaluationContextConfigurer.java[EvaluationContextConfigurer]. This allows you to customize Springs StandardEvaluationContext according to your requirements.

Here's a code snippet on how to proceed:

[source,java ]

import org.springframework.context.expression.MapAccessor; class Main { public static void main(String... args) { var configuration = OfficeStamperConfigurations.standardWithPreprocessing();

    // explicitly set the default configurer, that only allows a subset of SpEL features
    configuration.setEvaluationContextConfigurer(EvaluationContextConfigurers.defaultConfigurer());

    // or choose the more full-featured but potentially unsafe noopConfigurer
    configuration.setEvaluationContextConfigurer(EvaluationContextConfigurers.noopConfigurer());

    // or call other sources, like MapAccessor from org.springframework.context, that allow resolving Map objects
    configuration.setEvaluationContextConfigurer(ctx -> ctx.addPropertyAccessor(new MapAccessor()));

    var stamper = OfficeStampers.docxStamper(configuration);
}

}

This feature empowers you with greater flexibility and enhanced control over the expression evaluation process, fitting Office-Stamper seamlessly into complex scenarios and requirements.

== Linebreak Replacement

The setLineBreakPlaceholder(String lineBreakPlaceholder) method is used to replace the provided placeholder with a line break while stamping the document.

Please note that by default \n is provided.

== Conditional and Repetitive Displays within Headers and Footers

The .docx file format doesn’t permit comments within headers or footers. But there's a workaround in OfficeStamper. If you want to display contents within headers or footers conditionally, or require repetitive elements, all you got to do is :

  1. Craft the expression as you would in a comment.
  2. Encapsulate it with "#{}".
  3. Position it at the starting of the paragraph you intend to manipulate.

The assigned expression will be processed in the same way it would be in a comment, allowing you to maximize template customization.

Remember, this workaround unlocks the power of conditional display and repetition in your document's headers and footers, enhancing document dynamics.

== Graceful Error Handling

In general, DocxStamper employs an OfficeStamperException if there's a failure in resolving an expression within a document or the associated comments. However, you can modify this behavior.

Follow the given example to silence the exception and keep OfficeStamper from failing even when it encounters unresolved expressions:

[source,java]

class Main { public static void main(String... args) { var configuration = OfficeStamperConfiguration .standardWithPreprocessing() .setExceptionResolver(ExceptionResolvers.throwing()); // to throw as soon as an error occurs (default) // .setExceptionResolver(ExceptionResolvers.passing()); // to do nothing on error, leaving erroneous placeholders in place, and log the error // .setExceptionResolver(ExceptionResolvers.defaulting("value")); // to replace erroneous placeholders by a default value, and log the error var stamper = OfficeStampers.docxStamper(configuration); } }

This customization allows you to control the failure behavior of DocxStamper according to your specific requirements.

== Sample Code

The source code contains a set of tests show how to use the features. If you want to run them yourself, clone the repository and run mvn test with the system property -DkeepOutputFile=true so that the resulting .docx documents will not be cleaned up and let you view them. The resulting files will be stored in your local temp folder. Watch the logging output for the exact location of the files).

If you want to have a look at the .docx templates used in the tests, have a look at the link:{repo}/test/sources[sources subfolder] in the test folder.

== Maven coordinates

To include docx-stamper in your project, you can use the following maven coordinates in your dependency management system: link:https://verronpro.github.io/docx-stamper/dependency-info.html[go to last documented version]

Note that as of version 1.4.0, you have to provide the dependency to your version of Docx4J yourself:

[source,xml]

org.docx4j docx4j 11.4.11

This way, you can choose which version of Docx4J you want to use instead of having it dictated by docx-stamper.

The list of actively integrated docx4j is listed here -> link:{repo}/.github/workflows/integrate-docx4j.yml[Docx4J integration matrix]]

== Contribute

If you have an issue or create a comment processor or type resolver that you think deserves to be part of the default distribution, feel free to open an issue or - even better - a pull request with your contribution.