org.b3log.latke.http.renderer

Class AbstractFreeMarkerRenderer

java.lang.Object

org.b3log.latke.http.renderer.AbstractResponseRenderer

org.b3log.latke.http.renderer.AbstractFreeMarkerRenderer

All Implemented Interfaces:

ResponseRenderer

public abstract class AbstractFreeMarkerRenderer
extends AbstractResponseRenderer

Abstract FreeMarker HTTP response renderer.

Version:

2.0.0.0, Nov 3, 2019

Author:

Liang Ding

Constructor Summary

Constructors

Constructor and Description
AbstractFreeMarkerRenderer()

Method Summary

Modifier and Type	Method and Description
protected abstract void	afterRender(RequestContext context) Invoked after render.
protected abstract void	beforeRender(RequestContext context) Invoked before render.
protected void	doRender(String html, Request request, Response response) Processes the specified FreeMarker template with the specified request, data model and response.
protected String	genHTML(Request request, Map<String,Object> dataModel, freemarker.template.Template template) Processes the specified FreeMarker template with the specified request, data model.
Map<String,Object>	getDataModel() Gets the data model.
Map<String,Object>	getRenderDataModel() Gets the data model.
protected abstract freemarker.template.Template	getTemplate() Gets a template.
String	getTemplateName() Gets the template name.
void	render(RequestContext context) Renders with the specified HTTP request context.
void	setTemplateName(String templateName) Sets the template name with the specified template name.

Methods inherited from class org.b3log.latke.http.renderer.AbstractResponseRenderer

postRender, preRender, setRendererId

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractFreeMarkerRenderer

public AbstractFreeMarkerRenderer()

Method Detail

beforeRender

protected abstract void beforeRender(RequestContext context)
                              throws Exception

Invoked before render.

Parameters:

context - the specified context

Throws:

Exception - exception

afterRender

protected abstract void afterRender(RequestContext context)
                             throws Exception

Invoked after render.

Parameters:

context - the specified context

Throws:

Exception - exception

getTemplate

protected abstract freemarker.template.Template getTemplate()

Gets a template.

Returns:

template, returns null if not found

render

public void render(RequestContext context)

Description copied from interface: ResponseRenderer

Renders with the specified HTTP request context.

Specified by:

render in interface ResponseRenderer

Specified by:

render in class AbstractResponseRenderer

Parameters:

context - the specified HTTP request context

genHTML

protected String genHTML(Request request,
                         Map<String,Object> dataModel,
                         freemarker.template.Template template)
                  throws Exception

Processes the specified FreeMarker template with the specified request, data model.

Parameters:

request - the specified request

dataModel - the specified data model

template - the specified FreeMarker template

Returns:

generated HTML

Throws:

Exception - exception

doRender

protected void doRender(String html,
                        Request request,
                        Response response)

Processes the specified FreeMarker template with the specified request, data model and response.

Puts the page response contents into cache with the key getting from request attribute specified by page cache key.

Parameters:

html - the specified HTML content

request - the specified request

response - the specified response

getDataModel

public Map<String,Object> getDataModel()

Gets the data model.

Returns:

data model

getTemplateName

public String getTemplateName()

Gets the template name.

Returns:

template name

setTemplateName

public void setTemplateName(String templateName)

Sets the template name with the specified template name.

Parameters:

templateName - the specified template name

getRenderDataModel

public Map<String,Object> getRenderDataModel()

Description copied from class: AbstractResponseRenderer

Gets the data model.

Overrides:

getRenderDataModel in class AbstractResponseRenderer

Returns:

a new hash map