org.trimou.engine.locator

Class PathTemplateLocator<T>

java.lang.Object

org.trimou.engine.config.AbstractConfigurationAware

org.trimou.engine.locator.AbstractTemplateLocator

org.trimou.engine.locator.PathTemplateLocator<T>

Type Parameters:

T - the source of the template path (e.g. File, String,...)

All Implemented Interfaces:

ConfigurationAware, TemplateLocator, WithPriority

Direct Known Subclasses:

FilePathTemplateLocator

public abstract class PathTemplateLocator<T>
extends AbstractTemplateLocator

Represents a template locator where the template identifier is a path.

Author:

Martin Kouba

Field Summary

Fields

Modifier and Type	Field and Description
static ConfigurationKey	VIRTUAL_PATH_SEPARATOR_KEY Virtual path separator

Fields inherited from interface org.trimou.engine.priority.WithPriority

BUILTIN_RESOLVERS_DEFAULT_PRIORITY, BUILTIN_TEMPLATE_LOCATORS_DEFAULT_PRIORITY, EXTENSION_RESOLVERS_DEFAULT_PRIORITY

Constructor Summary

Constructors

Constructor and Description
PathTemplateLocator(int priority, java.lang.String rootPath)
PathTemplateLocator(int priority, java.lang.String rootPath, java.lang.String suffix)

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.String	addSuffix(java.lang.String filename)
protected abstract java.lang.String	constructVirtualPath(T source)
java.util.Set<ConfigurationKey>	getConfigurationKeys()
protected java.lang.String	getDefaultFileEncoding()
protected java.lang.String	getRealPathSeparator()
java.lang.String	getRootPath()
java.lang.String	getSuffix()
protected java.lang.String	getVirtualPathSeparator()
void	init(Configuration configuration) Initialize the component.
protected java.lang.String	stripSuffix(java.lang.String filename)
protected java.lang.String	toRealPath(java.lang.String virtualPath)
java.lang.String	toString()

Methods inherited from class org.trimou.engine.locator.AbstractTemplateLocator

getPriority

Methods inherited from class org.trimou.engine.config.AbstractConfigurationAware

checkNotInitialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.trimou.engine.locator.TemplateLocator

getAllIdentifiers, locate

Field Detail

VIRTUAL_PATH_SEPARATOR_KEY

public static final ConfigurationKey VIRTUAL_PATH_SEPARATOR_KEY

Virtual path separator

Constructor Detail

PathTemplateLocator

public PathTemplateLocator(int priority,
                   java.lang.String rootPath)

Parameters:

priority -

rootPath -

PathTemplateLocator

public PathTemplateLocator(int priority,
                   java.lang.String rootPath,
                   java.lang.String suffix)

Parameters:

priority -

suffix -

rootPath -

Method Detail

init

public void init(Configuration configuration)

Description copied from interface: ConfigurationAware

Initialize the component. Keep in mind that the configuration itself might not be fully initialized yet. However it should be safe to inspect non-configurable components (e.g. properties and global data) and obtain references to other ConfigurationAware components e.g. ( LocaleSupport). This method must not be called directly by the application.

Specified by:

init in interface ConfigurationAware

Overrides:

init in class AbstractConfigurationAware

getConfigurationKeys

public java.util.Set<ConfigurationKey> getConfigurationKeys()

Specified by:

getConfigurationKeys in interface ConfigurationAware

Overrides:

getConfigurationKeys in class AbstractConfigurationAware

Returns:

the set of configuration keys to discover

getSuffix

public java.lang.String getSuffix()

getRootPath

public java.lang.String getRootPath()

stripSuffix

protected java.lang.String stripSuffix(java.lang.String filename)

addSuffix

protected java.lang.String addSuffix(java.lang.String filename)

getRealPathSeparator

protected java.lang.String getRealPathSeparator()

getVirtualPathSeparator

protected java.lang.String getVirtualPathSeparator()

getDefaultFileEncoding

protected java.lang.String getDefaultFileEncoding()

constructVirtualPath

protected abstract java.lang.String constructVirtualPath(T source)

Parameters:

source -

Returns:

the virtual path of the template

toRealPath

protected java.lang.String toRealPath(java.lang.String virtualPath)

Parameters:

virtualPath -

Returns:

the real path

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object