This project has retired. For details please refer to its Attic page.

org.apache.jetspeed.locator
Interface TemplateLocator

public interface TemplateLocator

TemplateLocator interface

Version:

$Id: TemplateLocator.java 808138 2009-08-26 17:52:15Z taylor $

Author:

David Sean Taylor

Method Summary

LocatorDescriptor	createFromString(java.lang.String string) Creates a locator from a string of format (where brackets are optional]: template//[media-type/]/[language/]/[country/]]/name/
LocatorDescriptor	createLocatorDescriptor(java.lang.String type) Factory to create template locators of the given type.
java.util.List<java.lang.String>	getTemplateRoots() Retrieves a list of template root directories for this locator
TemplateDescriptor	locateTemplate(LocatorDescriptor locator) Locate an template using Jetspeed template location algorithm
java.util.Iterator	query(LocatorDescriptor locator) Query for a collection of templates given template locator criteria.

Method Detail

locateTemplate

TemplateDescriptor locateTemplate(LocatorDescriptor locator)
                                  throws TemplateLocatorException

Locate an template using Jetspeed template location algorithm

Parameters:

locator - The template locator

Returns:

The template found, or null if not found.

Throws:

TemplateLocatorException

createLocatorDescriptor

LocatorDescriptor createLocatorDescriptor(java.lang.String type)
                                          throws TemplateLocatorException

Factory to create template locators of the given type. Known supported locator types, but not limited to: portlet email

Parameters:

The - type of locator to create

Returns:

a general template locator of the given type

Throws:

TemplateLocatorException - if factory exception or if not valid locator type

createFromString

LocatorDescriptor createFromString(java.lang.String string)
                                   throws TemplateLocatorException

Creates a locator from a string of format (where brackets are optional]: template//[media-type/]/[language/]/[country/]]/name/

Parameters:

string - the string representation of a template locator

Throws:

TemplateLocatorException

query

java.util.Iterator query(LocatorDescriptor locator)

Query for a collection of templates given template locator criteria.

Parameters:

locator - The template locator criteria.

Returns:

The result list of Template objects matching the locator criteria.

getTemplateRoots

java.util.List<java.lang.String> getTemplateRoots()

Retrieves a list of template root directories for this locator

Returns:

a copy of the list of template root directories