org.apache.turbine.services.template
Interface TemplateEngineService

All Known Implementing Classes:
BaseTemplateEngineService

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,v 1.1.1.1 2001/08/16 05:09:22 jvanzyl Exp $
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_PAGE
           
static java.lang.String DEFAULT_SCREEN
           
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

public static final java.lang.String TEMPLATE_EXTENSIONS

DEFAULT_TEMPLATE_EXTENSION

public static final java.lang.String DEFAULT_TEMPLATE_EXTENSION

DEFAULT_PAGE

public static final java.lang.String DEFAULT_PAGE

DEFAULT_SCREEN

public static final java.lang.String DEFAULT_SCREEN

DEFAULT_LAYOUT

public static final java.lang.String DEFAULT_LAYOUT

DEFAULT_NAVIGATION

public static final java.lang.String DEFAULT_NAVIGATION

DEFAULT_ERROR_SCREEN

public static final java.lang.String DEFAULT_ERROR_SCREEN

DEFAULT_LAYOUT_TEMPLATE

public static final java.lang.String DEFAULT_LAYOUT_TEMPLATE
Method Detail

getTemplateEngineServiceConfiguration

public java.util.Hashtable getTemplateEngineServiceConfiguration()
Return the configuration of the template engine in the form of a Hashtable.

registerConfiguration

public 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

public java.lang.String[] getAssociatedFileExtensions()
Supplies the file extension to key this engine in TemplateService's registry with.

templateExists

public 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.


Copyright © 2000-2002 Apache Software Foundation. All Rights Reserved.