hr.ngs.templater

Interface EditorConfigurationBuilder

public interface EditorConfigurationBuilder

Templater Editor integration is available for Reporting and Enterprise license. Many options can be configured which will setup Templater Editor behavior. This is useful when preparing document for tag definition and for final processing of document when template setup can be changed into presentation setup.

Most configuration options will leave already existing values unless specific setting is provided.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	EditorConfigurationBuilder.MetadataProvider Callback for metadata type.
static class	EditorConfigurationBuilder.TagMetadata Additional metadata available in Templater Editor.
static class	EditorConfigurationBuilder.TagStatus Status of the tag used in the Templater Editor.

Method Summary

Modifier and Type	Method and Description
EditorConfigurationBuilder	addAlias(java.lang.String prefix, java.lang.String alias) To simplify tag management long tags can be shortened via aliases.
DocumentFactoryBuilder	configure(boolean embedSchema) Finish configuring the Microsoft Office Templater Editor setup.
EditorConfigurationBuilder	debugLog(boolean capture) Capturing debug log will allow inspection of every Templater processing step.
EditorConfigurationBuilder	issuesListing(boolean show) When tag detection and analysis is enabled, Templater Editor will search for various issues in the document.
EditorConfigurationBuilder	metadataResolver(EditorConfigurationBuilder.MetadataProvider customResolver) To make tags more useful and friendly, additional metadata can be attached to schema.
EditorConfigurationBuilder	tagDetection(boolean enabled) Continuously run tag detection on any change in the document.
EditorConfigurationBuilder	tagListing(boolean show) Show tag listing when opening up document.
EditorConfigurationBuilder	tagManagement(boolean allow) Is the user allowed to specify their own tags.

Method Detail

tagManagement

EditorConfigurationBuilder tagManagement(boolean allow)

Is the user allowed to specify their own tags. Most of the time this is not useful when application defined tags are available, since only a fixed set of tags should be available.

Parameters:

allow - allow user to add/remove tags

Returns:

itself

tagListing

EditorConfigurationBuilder tagListing(boolean show)

Show tag listing when opening up document. This is useful as it will immediately show the list of available tags to the user. Tags are listed from defined schema. Schema is defined by running Templater with data (sample or real) and embedding it into the final document.

Parameters:

show - list available tags

Returns:

itself

tagDetection

EditorConfigurationBuilder tagDetection(boolean enabled)

Continuously run tag detection on any change in the document. This is very useful to have enabled during template setup as it will detect tag changes and run analysis for common issues and best practices. To see such list issuesListing can be set

Parameters:

enabled - enable tag detection and analysis

Returns:

itself

issuesListing

EditorConfigurationBuilder issuesListing(boolean show)

When tag detection and analysis is enabled, Templater Editor will search for various issues in the document. It will report errors, warnings and suggestions on what should be resolved in the template before its sent for processing.

Parameters:

show - list errors, warnings and suggestions

Returns:

itself

addAlias

EditorConfigurationBuilder addAlias(java.lang.String prefix,
                                    java.lang.String alias)

To simplify tag management long tags can be shortened via aliases. This is especially useful in Word tables with many columns as long tags will extends cell width to accommodate entire tag name.

Parameters:

prefix - long tag prefix which can be replaced with alias

alias - tag alias for specific prefix

Returns:

itself

metadataResolver

EditorConfigurationBuilder metadataResolver(EditorConfigurationBuilder.MetadataProvider customResolver)

To make tags more useful and friendly, additional metadata can be attached to schema. This can be used to explain the tag purpose, how it should be used, along with putting them in categories and providing example value.

Custom callback can be registered here which can provide additional metadata for specific class. Metadata should specify every relevant property as a key with value pair consisting from its metadata description.

Parameters:

customResolver - provide additional metadata for specified type

Returns:

itself

debugLog

EditorConfigurationBuilder debugLog(boolean capture)

Capturing debug log will allow inspection of every Templater processing step.

This can help to better understand how Templater works, or diagnose an issue with processing.

Parameters:

capture - capture debug log

Returns:

itself

configure

DocumentFactoryBuilder configure(boolean embedSchema)

Finish configuring the Microsoft Office Templater Editor setup.

Instead of normal processing, schema can be embedded into OOXML documents. At the end of the processing document will remain the same as the original template but schema will be embedded into the document which can be used from the Templater Editor.

If schema is not embedded, it will be stripped from the output document, which is expected use case when creating the final document.

Parameters:

embedSchema - embed schema

Returns:

continue with document builder