|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.alfresco.repo.processor.BaseProcessor
org.alfresco.repo.template.FreeMarkerProcessor
public class FreeMarkerProcessor
FreeMarker implementation of the template processor interface.
Service to process FreeMarker template files loaded from various sources including the classpath, repository and directly from a String.
The template is processed against a data model generally consisting of a map of named objects. FreeMarker can natively handle any POJO objects using standard bean notation syntax. It has support for walking List objects. A 'standard' data model helper is provided to help generate an object model containing well known objects such as the Company Home, User Home and current User nodes. It also provides helpful util classes to process Date objects and repository specific custom methods.
Field Summary |
---|
Fields inherited from class org.alfresco.repo.processor.BaseProcessor |
---|
extension, name, processorExtensions, scriptService, services, templateService |
Constructor Summary | |
---|---|
FreeMarkerProcessor()
|
Method Summary | |
---|---|
java.lang.Object |
convertValue(java.lang.Object value,
TemplateImageResolver imageResolver)
Converts a Java object (e.g. |
protected freemarker.template.Configuration |
getConfig()
Get the FreeMarker configuration for this instance |
protected freemarker.template.Configuration |
getStringConfig(java.lang.String path,
java.lang.String template)
FreeMarker configuration for loading the specified template directly from a String |
void |
process(java.lang.String template,
java.lang.Object model,
java.io.Writer out)
Process a template against the supplied data model and write to the out. |
void |
processString(java.lang.String template,
java.lang.Object model,
java.io.Writer out)
Process a string template against the supplied data model and write to the out. |
void |
setDefaultEncoding(java.lang.String defaultEncoding)
Set the default template encoding |
Methods inherited from class org.alfresco.repo.processor.BaseProcessor |
---|
getExtension, getName, getProcessorExtensions, register, registerProcessorExtension, setExtension, setName, setScriptService, setServiceRegistry, setTemplateService |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.alfresco.processor.Processor |
---|
getExtension, getName, registerProcessorExtension |
Constructor Detail |
---|
public FreeMarkerProcessor()
Method Detail |
---|
public void setDefaultEncoding(java.lang.String defaultEncoding)
defaultEncoding
- the default encodingprotected freemarker.template.Configuration getConfig()
protected freemarker.template.Configuration getStringConfig(java.lang.String path, java.lang.String template)
path
- Pseudo Path to the templatetemplate
- Template content
public void process(java.lang.String template, java.lang.Object model, java.io.Writer out)
TemplateProcessor
process
in interface TemplateProcessor
template
- Template name/pathmodel
- Object model to process template againstout
- Writer object to send output tooTemplateProcessor.process(java.lang.String, java.lang.Object, java.io.Writer)
public void processString(java.lang.String template, java.lang.Object model, java.io.Writer out)
TemplateProcessor
processString
in interface TemplateProcessor
template
- Template stringmodel
- Object model to process template againstout
- Writer object to send output tooTemplateProcessor.processString(java.lang.String, java.lang.Object, java.io.Writer)
public java.lang.Object convertValue(java.lang.Object value, TemplateImageResolver imageResolver)
TemplateValueConverter
convertValue
in interface TemplateValueConverter
value
- the Java object to convertimageResolver
- the image resolver
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |