org.apache.jetspeed.locator
Interface TemplateLocator

public interface TemplateLocator

TemplateLocator interface

Version:

$Id: TemplateLocator.java 186579 2004-05-20 15:58:58Z weaver $

Author:

David Sean Taylor

Method Summary

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.
TemplateDescriptor	locateTemplate(LocatorDescriptor locator) Locate an template using Jetspeed template location algorithm
Iterator	query(LocatorDescriptor locator) Query for a collection of templates given template locator criteria.

Method Detail

locateTemplate

public 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

public 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

Returns:

a general template locator of the given type

Throws:

TemplateLocatorException - if factory exception or if not valid locator type

createFromString

public 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

public 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.