Package org.nuxeo.ecm.platform.rendering.template

Class FreemarkerRenderingEngine

java.lang.Object

org.nuxeo.ecm.platform.rendering.template.FreemarkerRenderingEngine

All Implemented Interfaces:

RenderingEngine

Direct Known Subclasses:

DocumentRenderingEngine

public abstract class FreemarkerRenderingEngine
extends Object
implements RenderingEngine

Base class for RenderingEngine implementation that will work with freemarker.

Author:

Dragos Mihalache

Field Summary

Fields

Modifier and Type	Field	Description
protected freemarker.template.Configuration	cfg

Constructor Summary

Constructors

Constructor	Description
FreemarkerRenderingEngine()

Method Summary

Modifier and Type	Method	Description
freemarker.template.Configuration	createConfiguration()	TODO : It works like this but this default implementation should return just a new Configuration() There should be a class that extends this class and overrides this but that brokes it right now.
protected abstract FreemarkerRenderingJob	createJob(RenderingContext ctx)
RenderingResult	process(RenderingContext ctx)	Processes the given context and return a rendering result.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.ecm.platform.rendering.RenderingEngine

getFormatName

Field Details

cfg

protected freemarker.template.Configuration cfg

Constructor Details

FreemarkerRenderingEngine

public FreemarkerRenderingEngine()

Method Details

createConfiguration

public freemarker.template.Configuration createConfiguration()

TODO : It works like this but this default implementation should return just a new Configuration() There should be a class that extends this class and overrides this but that brokes it right now. TODO: write a clear TODO

createJob

protected abstract FreemarkerRenderingJob createJob(RenderingContext ctx)

process

public RenderingResult process(RenderingContext ctx)
                        throws RenderingException

Description copied from interface: RenderingEngine

Processes the given context and return a rendering result.

The processing must never return null. If some error occurs it must throw an exception.

Specified by:

process in interface RenderingEngine

Parameters:

ctx - the context to process

Throws:

RenderingException