org.apache.turbine.services.template
Interface TemplateEngineService

All Known Implementing Classes:

BaseTemplateEngineService, TurbineJspService, TurbineVelocityService

public interface TemplateEngineService

This is the interface that all template engine services must adhere to. This includes the Velocity, WebMacro, FreeMarker, and JSP services.

Version:

$Id: TemplateEngineService.java 534527 2007-05-02 16:10:59Z tv $

Author:

Jason van Zyl, Daniel Rall

Field Summary

static java.lang.String	DEFAULT_ERROR_SCREEN
static java.lang.String	DEFAULT_LAYOUT
static java.lang.String	DEFAULT_LAYOUT_TEMPLATE
static java.lang.String	DEFAULT_NAVIGATION
static java.lang.String	DEFAULT_NAVIGATION_TEMPLATE
static java.lang.String	DEFAULT_PAGE
static java.lang.String	DEFAULT_SCREEN
static java.lang.String	DEFAULT_SCREEN_TEMPLATE
static java.lang.String	DEFAULT_TEMPLATE_EXTENSION
static java.lang.String	TEMPLATE_EXTENSIONS

Method Summary

java.lang.String[]	getAssociatedFileExtensions() Supplies the file extension to key this engine in TemplateService's registry with.
java.util.Hashtable	getTemplateEngineServiceConfiguration() Return the configuration of the template engine in the form of a Hashtable.
void	registerConfiguration(java.lang.String defaultExt) Initializes file extension associations and registers with the template service.
boolean	templateExists(java.lang.String template) Use the specific template engine to determine whether a given template exists.

Field Detail

TEMPLATE_EXTENSIONS

static final java.lang.String TEMPLATE_EXTENSIONS

See Also:

Constant Field Values

DEFAULT_TEMPLATE_EXTENSION

static final java.lang.String DEFAULT_TEMPLATE_EXTENSION

See Also:

Constant Field Values

DEFAULT_PAGE

static final java.lang.String DEFAULT_PAGE

See Also:

Constant Field Values

DEFAULT_SCREEN

static final java.lang.String DEFAULT_SCREEN

See Also:

Constant Field Values

DEFAULT_LAYOUT

static final java.lang.String DEFAULT_LAYOUT

See Also:

Constant Field Values

DEFAULT_NAVIGATION

static final java.lang.String DEFAULT_NAVIGATION

See Also:

Constant Field Values

DEFAULT_ERROR_SCREEN

static final java.lang.String DEFAULT_ERROR_SCREEN

See Also:

Constant Field Values

DEFAULT_LAYOUT_TEMPLATE

static final java.lang.String DEFAULT_LAYOUT_TEMPLATE

See Also:

Constant Field Values

DEFAULT_SCREEN_TEMPLATE

static final java.lang.String DEFAULT_SCREEN_TEMPLATE

See Also:

Constant Field Values

DEFAULT_NAVIGATION_TEMPLATE

static final java.lang.String DEFAULT_NAVIGATION_TEMPLATE

See Also:

Constant Field Values

Method Detail

getTemplateEngineServiceConfiguration

java.util.Hashtable getTemplateEngineServiceConfiguration()

Return the configuration of the template engine in the form of a Hashtable.

registerConfiguration

void registerConfiguration(java.lang.String defaultExt)

Initializes file extension associations and registers with the template service.

Parameters:

defaultExt - The default file extension association to use in case of properties file misconfiguration.

getAssociatedFileExtensions

java.lang.String[] getAssociatedFileExtensions()

Supplies the file extension to key this engine in TemplateService's registry with.

templateExists

boolean templateExists(java.lang.String template)

Use the specific template engine to determine whether a given template exists. This allows Turbine the TemplateService to delegate the search for a template to the template engine being used for the view. This gives us the advantage of fully utilizing the capabilities of template engine with respect to retrieving templates from arbitrary sources.

Parameters:

template - The name of the template to check the existance of.

Returns:

Whether the specified template exists.