org.gramar.extension

Class TemplatingExtension

java.lang.Object

org.gramar.extension.TemplatingExtension

All Implemented Interfaces:

ITemplatingExtension

Direct Known Subclasses:

ClasspathTemplatingExtension, JarFileTemplatingExtension

public abstract class TemplatingExtension
extends Object
implements ITemplatingExtension

Field Summary

Fields

Modifier and Type	Field and Description
protected String	abbreviation The default abbreviation (namespace) to use when referencing specific custom tags and xpath functions in this platform extension
protected String	extensionId The extension ID in the form of a java package name.
protected ArrayList<DefinedFunction>	functions A cache of XPath functions defined in this extension.
protected String	label
static String	META_FILE_NAME
protected String	provider

Constructor Summary

Constructors

Constructor and Description
TemplatingExtension(String extensionID) Constructs an extension with the given ID

Method Summary

Methods

Modifier and Type	Method and Description
void	addFunction(DefinedFunction definedFunction)
protected abstract String	getConfig()
ITagHandler	getCustomTagHandler(String tagName)
String	getDefaultAbbreviation()
protected abstract ClassLoader	getExtensionClassloader()
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)
void	loadMeta()
void	setDefaultAbbreviation(String abbreviation)
void	setExtensionId(String id)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

extensionId

protected String extensionId

The extension ID in the form of a java package name.

abbreviation

protected String abbreviation

The default abbreviation (namespace) to use when referencing specific custom tags and xpath functions in this platform extension

label

protected String label

provider

protected String provider

functions

protected ArrayList<DefinedFunction> functions

A cache of XPath functions defined in this extension. The functions are wrapped as a DefinedFunction which has a reference to the implementation of the function as well as metadata about the function, including arity, whether the function has a variable number of arguments and the name of the defined XPath function.

META_FILE_NAME

public static final String META_FILE_NAME

See Also:

Constant Field Values

Constructor Detail

TemplatingExtension

public TemplatingExtension(String extensionID)
                    throws InvalidTemplateExtensionException

Constructs an extension with the given ID

Parameters:

extensionID -

Throws:

InvalidTemplateExtensionException

Method Detail

loadMeta

public void loadMeta()
              throws InvalidTemplateExtensionException

Throws:

InvalidTemplateExtensionException

getExtensionClassloader

protected abstract ClassLoader getExtensionClassloader()
                                                throws Exception

Throws:

Exception

loadClass

public Class loadClass(String fullyQualifiedName)
                throws ClassNotFoundException,
                       Exception

Specified by:

loadClass in interface ITemplatingExtension

Throws:

ClassNotFoundException

Exception

getConfig

protected abstract String getConfig()
                             throws Exception

Throws:

Exception

addFunction

public void addFunction(DefinedFunction definedFunction)

getFunction

public XPathFunction getFunction(String name,
                        int arity)

Specified by:

getFunction in interface ITemplatingExtension

setDefaultAbbreviation

public void setDefaultAbbreviation(String abbreviation)

getDefaultAbbreviation

public String getDefaultAbbreviation()

Specified by:

getDefaultAbbreviation in interface ITemplatingExtension

setExtensionId

public void setExtensionId(String id)

getExtensionId

public String getExtensionId()

Specified by:

getExtensionId in interface ITemplatingExtension

getCustomTagHandler

public ITagHandler getCustomTagHandler(String tagName)
                                throws NoSuchCustomTagException

Specified by:

getCustomTagHandler in interface ITemplatingExtension

Throws:

NoSuchCustomTagException

getTagDef

public DefinedTag getTagDef(String tagName)
                     throws NoSuchCustomTagException

Specified by:

getTagDef in interface ITemplatingExtension

Throws:

NoSuchCustomTagException

hasCustomTagHandler

public boolean hasCustomTagHandler(String tagName)

Specified by:

hasCustomTagHandler in interface ITemplatingExtension

getFileStore

public IFileStore getFileStore(String fileStoreId)
                        throws NoSuchFileStoreException

Description copied from interface: ITemplatingExtension

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

Specified by:

getFileStore in interface ITemplatingExtension

Returns:

Throws:

NoSuchFileStoreException