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 final AsposeTemplateProcessorSettings	asposeTemplateProcessorSettings
protected Set<Class<?>>	customKnownTypes
protected Map<String,Integer>	supportedContentTypes

Fields inherited from class DocumentTemplateProcessor

OUTPUT_TYPE_PDF, OUTPUT_TYPE_WORD, supportedContentType, templateResourceResolver

Constructor Summary

Constructors

Constructor	Description
AsposeWordTemplateProcessor(TemplateResourceResolver templateResourceResolver, AsposeTemplateProcessorSettings asposeTemplateProcessorSettings, Resource[] hyphenationDictionaryResources)

Method Summary

Modifier and Type	Method	Description
protected byte[]	getAsByteArray(com.aspose.words.Document doc, com.aspose.words.SaveOptions saveOptions)
Set<Class<?>>	getCustomKnownTypes()
protected String	getDocumentName(String outputDocumentName, String outputDocumentType)
protected String	getMimeType(String outputDocumentType)
protected String	getOutputDocumentType(Map<String,Object> payload, String outputDocumentName)
Map<String,Integer>	getSupportedContentTypes()
protected com.aspose.words.Document	getTemplateDocument(TemplateHolder templateHolder)
TemplateProcessingResult	processTemplate(TemplateHolder templateHolder, Map<String,Object> payload, Map<String,Object> templateProcessingSettings)	Processes a template given by its definition which might have been loaded through the TemplateRepositoryService.
protected void	registerHyphenationDictionaries(Resource[] hyphenationDictionaryResources)
protected com.aspose.words.SaveOptions	saveOptions(String outputDocumentType, String pdfComplianceLevel)
void	setCustomKnownTypes(Set<Class<?>> customKnownTypes)
void	setSupportedContentTypes(Map<String,Integer> supportedContentTypes)

Methods inherited from class DocumentTemplateProcessor

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

Methods inherited from class Object

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

Methods inherited from interface TemplateProcessor

canRender, processTemplate

Field Details

asposeTemplateProcessorSettings

protected final AsposeTemplateProcessorSettings asposeTemplateProcessorSettings

supportedContentTypes

protected Map<String,Integer> supportedContentTypes

customKnownTypes

protected Set<Class<?>> customKnownTypes

Constructor Details

AsposeWordTemplateProcessor

public AsposeWordTemplateProcessor(TemplateResourceResolver templateResourceResolver,
 AsposeTemplateProcessorSettings asposeTemplateProcessorSettings,
 Resource[] hyphenationDictionaryResources)

Method Details

processTemplate

public TemplateProcessingResult processTemplate(TemplateHolder templateHolder,
 Map<String,Object> payload,
 Map<String,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

getDocumentName

protected String getDocumentName(String outputDocumentName,
 String outputDocumentType)

getMimeType

protected String getMimeType(String outputDocumentType)

saveOptions

protected com.aspose.words.SaveOptions saveOptions(String outputDocumentType,
 String pdfComplianceLevel)

getAsByteArray

protected byte[] getAsByteArray(com.aspose.words.Document doc,
 com.aspose.words.SaveOptions saveOptions)
                         throws Exception

Throws:

Exception

getOutputDocumentType

protected String getOutputDocumentType(Map<String,Object> payload,
 String outputDocumentName)

getTemplateDocument

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

registerHyphenationDictionaries

protected void registerHyphenationDictionaries(Resource[] hyphenationDictionaryResources)

getSupportedContentTypes

public Map<String,Integer> getSupportedContentTypes()

setSupportedContentTypes

public void setSupportedContentTypes(Map<String,Integer> supportedContentTypes)

getCustomKnownTypes

public Set<Class<?>> getCustomKnownTypes()

setCustomKnownTypes

public void setCustomKnownTypes(Set<Class<?>> customKnownTypes)