Package com.flowable.template.engine.impl.processor

Class AsposeWordTemplateProcessor

java.lang.Object

com.flowable.template.engine.impl.processor.DocumentTemplateProcessor

com.flowable.template.engine.impl.processor.AsposeWordTemplateProcessor

All Implemented Interfaces:

TemplateProcessor

public class AsposeWordTemplateProcessor
extends DocumentTemplateProcessor
implements TemplateProcessor

A TemplateProcessor using the Aspose ReportingEngine.

Field Summary

Fields

Modifier and Type	Field	Description
protected AsposeTemplateProcessorSettings	asposeTemplateProcessorSettings
protected java.util.Set<java.lang.Class<?>>	customKnownTypes
protected java.util.Map<java.lang.String,java.lang.Integer>	supportedContentTypes

Fields inherited from class com.flowable.template.engine.impl.processor.DocumentTemplateProcessor

OUTPUT_TYPE_PDF, OUTPUT_TYPE_WORD, supportedContentType, templateResourceResolver

Constructor Summary

Constructors

Constructor	Description
AsposeWordTemplateProcessor(TemplateResourceResolver templateResourceResolver, AsposeTemplateProcessorSettings asposeTemplateProcessorSettings)

Method Summary

Modifier and Type	Method	Description
protected org.flowable.content.api.ContentItem	createProcessorContentItem(org.flowable.content.api.ContentService contentService, java.lang.String outputDocumentName, java.lang.String outputDocumentType)
protected byte[]	getAsByteArray(com.aspose.words.Document doc, java.lang.Integer saveFormat)
java.util.Set<java.lang.Class<?>>	getCustomKnownTypes()
protected java.lang.String	getOutputDocumentType(java.util.Map<java.lang.String,java.lang.Object> payload, java.lang.String outputDocumentName)
java.util.Map<java.lang.String,java.lang.Integer>	getSupportedContentTypes()
protected com.aspose.words.Document	getTemplateDocument(TemplateHolder templateHolder)
TemplateProcessingResult	processTemplate(TemplateHolder templateHolder, java.util.Map<java.lang.String,java.lang.Object> payload, java.util.Map<java.lang.String,java.lang.Object> templateProcessingSettings)	Processes a template given by its definition which might have been loaded through the TemplateRepositoryService.
void	setCustomKnownTypes(java.util.Set<java.lang.Class<?>> customKnownTypes)
void	setSupportedContentTypes(java.util.Map<java.lang.String,java.lang.Integer> supportedContentTypes)

Methods inherited from class com.flowable.template.engine.impl.processor.DocumentTemplateProcessor

canRender, createContentItem, getContentInputStream, getContentService, getExpressionManager, getFromPayloadOrDefault, getVariableContainer, isContentItemGenerationEnabled

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.flowable.template.api.processor.TemplateProcessor

canRender, processTemplate

Field Detail

asposeTemplateProcessorSettings

protected final AsposeTemplateProcessorSettings asposeTemplateProcessorSettings

supportedContentTypes

protected java.util.Map<java.lang.String,java.lang.Integer> supportedContentTypes

customKnownTypes

protected java.util.Set<java.lang.Class<?>> customKnownTypes

Constructor Detail

AsposeWordTemplateProcessor

public AsposeWordTemplateProcessor(TemplateResourceResolver templateResourceResolver,
                                   AsposeTemplateProcessorSettings asposeTemplateProcessorSettings)

Method Detail

processTemplate

public TemplateProcessingResult processTemplate(TemplateHolder templateHolder,
                                                java.util.Map<java.lang.String,java.lang.Object> payload,
                                                java.util.Map<java.lang.String,java.lang.Object> templateProcessingSettings)

Description copied from interface: TemplateProcessor

Processes a template given by its definition which might have been loaded through the TemplateRepositoryService. The payload is used for the placeholders within the template content and must be valid according the TemplateVariationModel.getParameters() definition.

Specified by:

processTemplate in interface TemplateProcessor

Parameters:

templateHolder - the template holder with template and template variation information

payload - the optional payload, if the template is using placeholders to render properly (must be valid according the parameter definition)

Returns:

the template processing results

createProcessorContentItem

protected org.flowable.content.api.ContentItem createProcessorContentItem(org.flowable.content.api.ContentService contentService,
                                                                          java.lang.String outputDocumentName,
                                                                          java.lang.String outputDocumentType)

Specified by:

createProcessorContentItem in class DocumentTemplateProcessor

getAsByteArray

protected byte[] getAsByteArray(com.aspose.words.Document doc,
                                java.lang.Integer saveFormat)
                         throws java.lang.Exception

Throws:

java.lang.Exception

getOutputDocumentType

protected java.lang.String getOutputDocumentType(java.util.Map<java.lang.String,java.lang.Object> payload,
                                                 java.lang.String outputDocumentName)

getTemplateDocument

protected com.aspose.words.Document getTemplateDocument(TemplateHolder templateHolder)

getSupportedContentTypes

public java.util.Map<java.lang.String,java.lang.Integer> getSupportedContentTypes()

setSupportedContentTypes

public void setSupportedContentTypes(java.util.Map<java.lang.String,java.lang.Integer> supportedContentTypes)

getCustomKnownTypes

public java.util.Set<java.lang.Class<?>> getCustomKnownTypes()

setCustomKnownTypes

public void setCustomKnownTypes(java.util.Set<java.lang.Class<?>> customKnownTypes)