pl.aislib.fm
Class TemplateEngine

java.lang.Object
  pl.aislib.fm.TemplateEngine

Direct Known Subclasses:

VelocityTemplateEngine

public abstract class TemplateEngine

extends java.lang.Object

Generic Template Engine class. This class should be extended to implement template engine for specific environment.

Since:

AISLIB 0.1

Version:

$Revision: 1.3 $

Author:

Tomasz Pik, AIS.PL

Michal Jastak, AIS.PL

Constructor Summary

TemplateEngine()

Method Summary

abstract java.lang.String	evaluate(java.lang.Object template, java.util.Map parameters) Evaluates template.
abstract boolean	isTemplate(java.lang.Object object) Checks if given object is a template.
abstract java.lang.Object	load(Application application, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String templateName) Gets specified template.

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateEngine

public TemplateEngine()

Method Detail

load

public abstract java.lang.Object load(Application application,
                                      javax.servlet.http.HttpServletRequest request,
                                      javax.servlet.http.HttpServletResponse response,
                                      java.lang.String templateName)
                               throws TemplateEngineException

Gets specified template.

Parameters:

application - Parent Application description.

request - HttpServletRequest object.

response - HttpServletResponse object.

templateName - Template which we want to load.

Returns:

specified template object.

Throws:

TemplateEngineException - exception.

evaluate

public abstract java.lang.String evaluate(java.lang.Object template,
                                          java.util.Map parameters)
                                   throws TemplateEngineException

Evaluates template.

Parameters:

template - Template object.

parameters - Map containing evaluation parameters.

Returns:

String created during evaluation process.

Throws:

TemplateEngineException - exception.

isTemplate

public abstract boolean isTemplate(java.lang.Object object)

Checks if given object is a template.

Parameters:

object - Object which should be checked.

Returns:

true if object given as argument is implementation of Template, false otherwise.