org.cofax
Class TemplateLoader

java.lang.Object
  |
  +--org.cofax.TemplateLoader

Direct Known Subclasses:

FilesTemplateLoader

public abstract class TemplateLoader

extends java.lang.Object

Cofax's top level template loader class. Cofax compatible template loaders implement this API. A template loader loads a template from some system and makes it available for use. Examples of modules that extend this would be
FilesTemplateLoader (loads templates from file system),
DataStoreTemplateLoader (loads templates via the Cofax DataStore API which fetch from a SQL database (For fetching directly from the fie system use FilesTemplateLoader instead.),
UrlTemplateLoader.
Cofax compatible template loaders extend this abstract class.

TemplateLoader classes are listed in the configuration and loaded dynamically.

Author:

Rajiv Pant, Karl Martino

Constructor Summary

TemplateLoader()

Method Summary

abstract java.lang.String	choose(java.lang.String templateSearchBegin, java.lang.String templateFile, java.lang.String overrideTemplate) Determine's the template's ID based upon a search.
java.lang.String	getDefaultIndex() Gets the default index template.
java.lang.String	getDefaultObject() Gets the default object template.
java.lang.String	getTemplateRoot() Gets the default index template.
void	init(java.lang.String defaultIndex, java.lang.String defaultObject, java.lang.String templateRoot) Initializes variables.
abstract CofaxPage	load(java.lang.String templateId) Get's a template based upon it's ID.
void	setDefaultIndex(java.lang.String defaultIndex) Sets the default index template.
void	setDefaultObject(java.lang.String defaultObject) Sets the default object template.
void	setTemplateRoot(java.lang.String templateRoot) Sets the default index template.

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateLoader

public TemplateLoader()

Method Detail

init

public void init(java.lang.String defaultIndex,
                 java.lang.String defaultObject,
                 java.lang.String templateRoot)

Initializes variables.

getTemplateRoot

public java.lang.String getTemplateRoot()

Gets the default index template.

setTemplateRoot

public void setTemplateRoot(java.lang.String templateRoot)

Sets the default index template.

getDefaultIndex

public java.lang.String getDefaultIndex()

Gets the default index template.

setDefaultIndex

public void setDefaultIndex(java.lang.String defaultIndex)

Sets the default index template.

getDefaultObject

public java.lang.String getDefaultObject()

Gets the default object template.

setDefaultObject

public void setDefaultObject(java.lang.String defaultObject)

Sets the default object template.

choose

public abstract java.lang.String choose(java.lang.String templateSearchBegin,
                                        java.lang.String templateFile,
                                        java.lang.String overrideTemplate)

Determine's the template's ID based upon a search.

load

public abstract CofaxPage load(java.lang.String templateId)

Get's a template based upon it's ID.