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, String rootPath)
PathTemplateLocator(int priority, String rootPath, String suffix)

Method Summary

Methods

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

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

getPriority

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,
                   String rootPath)

Parameters:

priority -

rootPath -

PathTemplateLocator

public PathTemplateLocator(int priority,
                   String rootPath,
                   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 is likely not fully initialized yet. It's only safe to inspect properties and global data.

Specified by:

init in interface ConfigurationAware

Overrides:

init in class AbstractConfigurationAware

getConfigurationKeys

public Set<ConfigurationKey> getConfigurationKeys()

Specified by:

getConfigurationKeys in interface ConfigurationAware

Overrides:

getConfigurationKeys in class AbstractConfigurationAware

Returns:

the set of configuration keys to discover

getSuffix

public String getSuffix()

getRootPath

public String getRootPath()

stripSuffix

protected String stripSuffix(String filename)

addSuffix

protected String addSuffix(String filename)

getRealPathSeparator

protected String getRealPathSeparator()

getVirtualPathSeparator

protected String getVirtualPathSeparator()

getDefaultFileEncoding

protected String getDefaultFileEncoding()

constructVirtualPath

protected abstract String constructVirtualPath(T source)

Parameters:

source -

Returns:

the virtual path of the template

toRealPath

protected String toRealPath(String virtualPath)

Parameters:

virtualPath -

Returns:

the real path

toString

public String toString()

Overrides:

toString in class Object