|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface TemplateService
Template Service.
Provides an interface to services for executing template engine against a template file and data model.
The service provides a configured list of available template engines. The template file can either be in the repository (passed as NodeRef string) or on the classpath. Also a template can be passed directly as a String using the processTemplateString() methods.
The data model is specified to the template engine. The FreeMarker template engine is used by default.
Field Summary | |
---|---|
static java.lang.String |
KEY_COMPANY_HOME
|
static java.lang.String |
KEY_DATE
|
static java.lang.String |
KEY_IMAGE_RESOLVER
Keys for default model values |
static java.lang.String |
KEY_PERSON
|
static java.lang.String |
KEY_PRODUCT_NAME
|
static java.lang.String |
KEY_SHARE_URL
|
static java.lang.String |
KEY_TEMPLATE
|
static java.lang.String |
KEY_USER_HOME
|
Method Summary | |
---|---|
java.util.Map |
buildDefaultModel(org.alfresco.service.cmr.repository.NodeRef person,
org.alfresco.service.cmr.repository.NodeRef companyHome,
org.alfresco.service.cmr.repository.NodeRef userHome,
org.alfresco.service.cmr.repository.NodeRef template,
TemplateImageResolver imageResolver)
Helper method to build a default model |
TemplateProcessor |
getTemplateProcessor(java.lang.String engine)
Return a TemplateProcessor instance for the specified engine name. |
java.lang.String |
processTemplate(java.lang.String template,
java.lang.Object model)
Process a template against the upplied data model and return the result as a string. |
void |
processTemplate(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. |
java.lang.String |
processTemplate(java.lang.String engine,
java.lang.String template,
java.lang.Object model)
Process a template against the supplied data model and write to the out. |
void |
processTemplate(java.lang.String engine,
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. |
java.lang.String |
processTemplateString(java.lang.String engine,
java.lang.String template,
java.lang.Object model)
Process a given template, provided as a string, against the supplied data model and return the result as a String |
void |
processTemplateString(java.lang.String engine,
java.lang.String template,
java.lang.Object model,
java.io.Writer out)
Process a given template, provided as a string, against the supplied data model and report the result back in the provided writer. |
void |
registerTemplateProcessor(TemplateProcessor templateProcessor)
Registers a new template processor with the template service |
Field Detail |
---|
static final java.lang.String KEY_IMAGE_RESOLVER
static final java.lang.String KEY_COMPANY_HOME
static final java.lang.String KEY_USER_HOME
static final java.lang.String KEY_PERSON
static final java.lang.String KEY_TEMPLATE
static final java.lang.String KEY_DATE
static final java.lang.String KEY_SHARE_URL
static final java.lang.String KEY_PRODUCT_NAME
Method Detail |
---|
@Auditable(parameters={"template", "model"}) java.lang.String processTemplate(java.lang.String template, java.lang.Object model) throws TemplateException
template
- Template (qualified classpath name or noderef)model
- Object model to process template against
TemplateException
@Auditable(parameters={"template", "model", "out"}) void processTemplate(java.lang.String template, java.lang.Object model, java.io.Writer out) throws TemplateException
template
- Template (qualified classpath name or noderef)model
- Object model to process template againstout
- Writer object to send output too
TemplateException
@Auditable(parameters={"engine", "template", "model"}) java.lang.String processTemplate(java.lang.String engine, java.lang.String template, java.lang.Object model) throws TemplateException
engine
- Name of the template engine to usetemplate
- Template (qualified classpath name or noderef)model
- Object model to process template against
TemplateException
@Auditable(parameters={"engine", "template", "model", "out"}) void processTemplate(java.lang.String engine, java.lang.String template, java.lang.Object model, java.io.Writer out) throws TemplateException
engine
- Name of the template engine to usetemplate
- Template (qualified classpath name or noderef)model
- Object model to process template againstout
- Writer object to send output too
TemplateException
@Auditable(parameters={"engine", "template", "model"}) java.lang.String processTemplateString(java.lang.String engine, java.lang.String template, java.lang.Object model) throws TemplateException
engine
- Name of the template engine to usetemplate
- Template stringmodel
- Object model to process template against
TemplateException
@Auditable(parameters={"engine", "template", "model", "out"}) void processTemplateString(java.lang.String engine, java.lang.String template, java.lang.Object model, java.io.Writer out) throws TemplateException
engine
- Name of the template engine to usetemplate
- Template stringmodel
- Object model to process template againstout
- Writer object to send output too
TemplateException
@Auditable(parameters="engine") TemplateProcessor getTemplateProcessor(java.lang.String engine)
engine
- Name of the template engine to get or null for default
@Auditable(parameters="templateProcessor") void registerTemplateProcessor(TemplateProcessor templateProcessor)
templateProcessor
- the template processor to register@Auditable(parameters={"person", "companyHome", "userHome", "template", "imageResolver"}) java.util.Map buildDefaultModel(org.alfresco.service.cmr.repository.NodeRef person, org.alfresco.service.cmr.repository.NodeRef companyHome, org.alfresco.service.cmr.repository.NodeRef userHome, org.alfresco.service.cmr.repository.NodeRef template, TemplateImageResolver imageResolver)
person
- the person node referencecompanyHome
- the company home node refereenceuserHome
- the user home node referencetemplate
- the node ref for the template (optional)imageResolver
- the image resolver (optional)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |