org.trimou.engine.locator

Class FilePathTemplateLocator

java.lang.Object

org.trimou.engine.config.AbstractConfigurationAware

org.trimou.engine.locator.AbstractTemplateLocator

org.trimou.engine.locator.PathTemplateLocator<java.io.File>

org.trimou.engine.locator.FilePathTemplateLocator

All Implemented Interfaces:

ConfigurationAware, TemplateLocator, WithPriority

Direct Known Subclasses:

ClassPathTemplateLocator, FileSystemTemplateLocator

public abstract class FilePathTemplateLocator
extends PathTemplateLocator<java.io.File>

Abstract file-based template locator.

Author:

Martin Kouba

Field Summary

Fields inherited from class org.trimou.engine.locator.PathTemplateLocator

VIRTUAL_PATH_SEPARATOR_KEY

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
FilePathTemplateLocator(int priority, java.lang.String rootPath)
FilePathTemplateLocator(int priority, java.lang.String rootPath, java.lang.String suffix)

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.String	constructVirtualPath(java.io.File source)
java.util.Set<java.lang.String>	getAllIdentifiers()
protected abstract java.io.File	getRootDir()
protected void	checkRootDir()
protected boolean	isDirectoryUsable(java.io.File dir)
protected boolean	isFileUsable(java.io.File file)
protected java.util.List<java.io.File>	listFiles(java.io.File dir)
java.io.Reader	locate(java.lang.String filePath)
protected abstract java.io.Reader	locateRealPath(java.lang.String realPath)

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

addSuffix, getConfigurationKeys, getDefaultFileEncoding, getRealPathSeparator, getRootPath, getSuffix, getVirtualPathSeparator, init, stripSuffix, toRealPath, 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

Constructor Detail

FilePathTemplateLocator

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

Parameters:

priority -

rootPath -

suffix -

FilePathTemplateLocator

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

Parameters:

priority -

rootPath -

Method Detail

locate

public java.io.Reader locate(java.lang.String filePath)

Parameters:

filePath - The template identifier

Returns:

the reader object for a template with the given name or null if no available template with the given name exists

getAllIdentifiers

public java.util.Set<java.lang.String> getAllIdentifiers()

Returns:

the set of names of all available template identifiers (i.e. all available templates)

See Also:

EngineConfigurationKey.PRECOMPILE_ALL_TEMPLATES

constructVirtualPath

protected java.lang.String constructVirtualPath(java.io.File source)

Specified by:

constructVirtualPath in class PathTemplateLocator<java.io.File>

Returns:

the virtual path of the template

getRootDir

protected abstract java.io.File getRootDir()

Returns:

the root directory

See Also:

PathTemplateLocator.getRootPath()

locateRealPath

protected abstract java.io.Reader locateRealPath(java.lang.String realPath)

Parameters:

realPath -

Returns:

the reader for the given path

listFiles

protected java.util.List<java.io.File> listFiles(java.io.File dir)

Parameters:

dir -

Returns:

the list of matching files/templates

isDirectoryUsable

protected boolean isDirectoryUsable(java.io.File dir)

isFileUsable

protected boolean isFileUsable(java.io.File file)

checkRootDir

protected void checkRootDir()