org.jbake.template

Class AbstractTemplateEngine

java.lang.Object

org.jbake.template.AbstractTemplateEngine

Direct Known Subclasses:

DelegatingTemplateEngine, FreemarkerTemplateEngine, GroovyMarkupTemplateEngine, GroovyTemplateEngine, JadeTemplateEngine, ThymeleafTemplateEngine

public abstract class AbstractTemplateEngine
extends Object

A template is responsible for converting a model into a rendered document. The model consists of key/value pairs, some of them potentially converted from a markup language to HTML already. An appropriate rendering engine will be chosen by JBake based on the template suffix. If contents is not available in the supplied model, a template has access to the document database in order to complete the model. It is in particular interesting to optimize data access based on the underlying template engine capabilities. Note that some rendering engines may rely on a different rendering model than the one provided by the first argument of renderDocument(java.util.Map, String, java.io.Writer). In this case, it is the responsibility of the engine to convert it.

Author:

Cédric Champeau

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.configuration.Configuration	config
protected ContentStore	db
protected File	destination
protected static ModelExtractors	extractors
protected File	templatesPath

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractTemplateEngine(org.apache.commons.configuration.Configuration config, ContentStore db, File destination, File templatesPath)

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	renderDocument(Map<String,Object> model, String templateName, Writer writer)

Methods inherited from class java.lang.Object

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

Field Detail

extractors

protected static ModelExtractors extractors

config

protected final org.apache.commons.configuration.Configuration config

db

protected final ContentStore db

destination

protected final File destination

templatesPath

protected final File templatesPath

Constructor Detail

AbstractTemplateEngine

protected AbstractTemplateEngine(org.apache.commons.configuration.Configuration config,
                      ContentStore db,
                      File destination,
                      File templatesPath)

Method Detail

renderDocument

public abstract void renderDocument(Map<String,Object> model,
                  String templateName,
                  Writer writer)
                             throws RenderingException

Throws:

RenderingException