org.gramar

Interface IPluginSource

All Known Implementing Classes:

ClasspathPluginSource, FileSystemPluginSource, PluginSource

public interface IPluginSource

Represents a means by which gramars and extensions can be located and retrieved from the execution environment

Author:

chrisgerken

Method Summary

Methods

Modifier and Type	Method and Description
void	addKnownGramar(String id) Tells the receiver that a pattern with the specified ID exists and is retrievable.
IGramar	getGramar(String gramarId) Return an IGramar with the given id A gramar is a collection of text templates and a property file.
ITemplatingExtension	getTemplatingExtension(String extensionId) Return the templating extension with the given id
IGramar[]	gramars() Return an array of available IPatterns.
String[]	list() Return an array of String id's for the available IGramars.

Method Detail

list

String[] list()

Return an array of String id's for the available IGramars. Some implementations may not be able to answer this request. In these case, callers must know the desired patternId.

gramars

IGramar[] gramars()

Return an array of available IPatterns.

getGramar

IGramar getGramar(String gramarId)
                  throws NoSuchGramarException,
                         InvalidGramarException

Return an IGramar with the given id A gramar is a collection of text templates and a property file. It can be persisted as a zip file named .zip or as a set of individual files in and under a given subdirectory

Throws:

NoSuchGramarException

InvalidGramarException

getTemplatingExtension

ITemplatingExtension getTemplatingExtension(String extensionId)
                                            throws NoSuchTemplatingExtensionException,
                                                   InvalidTemplateExtensionException

Return the templating extension with the given id

Throws:

NoSuchTemplatingExtensionException

InvalidTemplateExtensionException

addKnownGramar

void addKnownGramar(String id)
                    throws NoSuchGramarException,
                           InvalidGramarException

Tells the receiver that a pattern with the specified ID exists and is retrievable. This is used for gramars deployed with the GramarPlatform and which are to be retrieved via a PluginSource that can not query for available gramars

Parameters:

id -

Throws:

InvalidGramarException

NoSuchGramarException