org.apache.jetspeed.locator

Interface TemplateLocator

public interface TemplateLocator

TemplateLocator interface

Version:

$Id: TemplateLocator.java 1576070 2014-03-10 20:31:10Z taylor $

Author:

David Sean Taylor

Method Summary

Methods

Modifier and Type	Method and Description
LocatorDescriptor	createFromString(String string) Creates a locator from a string of format (where brackets are optional]: template//[media-type/]/[language/]/[country/]]/name/
LocatorDescriptor	createLocatorDescriptor(String type) Factory to create template locators of the given type.
List<String>	getTemplateRoots() Retrieves a list of template root directories for this locator
TemplateDescriptor	locateTemplate(LocatorDescriptor locator) Locate an template using Jetspeed template location algorithm
Iterator	query(LocatorDescriptor locator) Deprecated. Do not use this method as it is not supported

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(String type)
                                          throws TemplateLocatorException

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

Parameters:

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(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

Iterator query(LocatorDescriptor locator)

Deprecated. Do not use this method as it is not supported

getTemplateRoots

List<String> getTemplateRoots()

Retrieves a list of template root directories for this locator

Returns:

a copy of the list of template root directories