org.gramar

Interface ITemplatingExtension

All Known Implementing Classes:

ClasspathTemplatingExtension, JarFileTemplatingExtension, TemplatingExtension

public interface ITemplatingExtension

Represents an object that extends the templating platform with tag handlers and/or XPath functions. Platform extensions can be deployed in many ways and each deployment method requires an implementation of ITemplatingExtension to answer the extending tag handlers and XPath functions.

Author:

chrisgerken

Method Summary

Methods

Modifier and Type	Method and Description
ITagHandler	getCustomTagHandler(String tagName)
String	getDefaultAbbreviation()
String	getExtensionId()
IFileStore	getFileStore(String fileStoreId) Returns the IFileStore implementation for the given ID.
XPathFunction	getFunction(String name, int arity)
DefinedTag	getTagDef(String tagName)
boolean	hasCustomTagHandler(String tagName)
Class	loadClass(String fullyQualifiedName)

Method Detail

getDefaultAbbreviation

String getDefaultAbbreviation()

getExtensionId

String getExtensionId()

getFunction

XPathFunction getFunction(String name,
                        int arity)

getTagDef

DefinedTag getTagDef(String tagName)
                     throws NoSuchCustomTagException

Throws:

NoSuchCustomTagException

getCustomTagHandler

ITagHandler getCustomTagHandler(String tagName)
                                throws NoSuchCustomTagException

Throws:

NoSuchCustomTagException

hasCustomTagHandler

boolean hasCustomTagHandler(String tagName)

loadClass

Class loadClass(String fullyQualifiedName)
                throws ClassNotFoundException,
                       Exception

Throws:

ClassNotFoundException

Exception

getFileStore

IFileStore getFileStore(String fileStoreId)
                        throws NoSuchFileStoreException

Returns the IFileStore implementation for the given ID. If no such filestore is supported by this extension then throw an exception

Parameters:

fileStoreId -

Returns:

Throws:

NoSuchFileStoreException