hr.ngs.templater

Interface ITemplateDocument

public interface ITemplateDocument

Template document with analyzed tags. Modifies document in memory and saves changes on flush.

Represents abstraction over specific document type (text, Word document, ...) All such documents are processed with this same API which allows for code reuse across different templates.

Method Summary

Modifier and Type	Method and Description
java.io.OutputStream	flush() Flushes current changes to output stream and finishes processing.
<T> ITemplateDocument	process(T data) Modifies document according to rules for specified data type.
ITemplater	templater() Provides access to the low-level API.

Method Detail

templater

ITemplater templater()

Provides access to the low-level API.

Low-level API should mostly be used from plugins.

Common use case for using it is to check if all tags were processed and put out appropriate warning when they were not.

Returns:

low-level API

process

<T> ITemplateDocument process(T data)

Modifies document according to rules for specified data type. Tags are resolved from properties, fields, methods, column names, etc...

Tags are resolved from properties, fields, methods, column names, etc...

Plugins will be invoked when this API is used, such as formatters, navigations and handlers.

Templater will find the best processor type which will process input data with the appropriate rules.

Process method can be called multiple times if there are multiple root objects.

   document.process(resultSet);
   document.process(jsonMap);
 

Type Parameters:

T - type of data to process

Parameters:

data - data for modifying tags. Specific rules will be chosen from its type

Returns:

itself

flush

java.io.OutputStream flush()

Flushes current changes to output stream and finishes processing.

Returns:

the underlying output stream. If the template document was opened using the three-argument IDocumentFactory.open then this will return the original output stream.