org.gramar.platform

Class GramarPlatform

java.lang.Object

org.gramar.platform.GramarPlatform

All Implemented Interfaces:

IGramarPlatform

Direct Known Subclasses:

SimpleGramarPlatform

public abstract class GramarPlatform
extends Object
implements IGramarPlatform

Field Summary

Fields

Modifier and Type	Field and Description
protected HashMap<String,ITemplatingExtension>	extensions
protected IFileStore	fileStore
protected ArrayList<IPluginSource>	pluginSources

Constructor Summary

Constructors

Constructor and Description
GramarPlatform()

Method Summary

Methods

Modifier and Type	Method and Description
void	addPluginSource(IPluginSource source)
void	addTemplatingExtension(ITemplatingExtension extension) Caches the given extension for later use
IGramarApplicationStatus	apply(IModel model, IGramar gramar)
IGramarApplicationStatus	apply(IModel model, IGramar gramar, IFileStore fileStore)
IGramarApplicationStatus	apply(IModel model, String gramarId)
IGramarApplicationStatus	apply(IModel model, String gramarId, IFileStore fileStore)
IGramarApplicationStatus	apply(ITemplate mainTemplate, IGramar gramar, IGramarContext context)
IFileStore	getDefaultFileStore()
IFileStore	getFileStore(String fileStoreId) Searches all known plugin sources for an extension that provides a filestore with the given filestore ID.
IGramar	getGramar(String gramarId)
IGramar[]	getKnownGramars() Returns aa array of all Gramars known to any PluginSource
ITemplatingExtension	getTemplatingExtension(String extensionId) If not already cached, searches the known plugin sources for the extension, caches it, then returns it.
protected abstract void	loadExtensions() Called by the constructor to give the implementer the chance to load any known extensions, gramars, etc
GramarScore[]	scoreKnownGramars(IModel proposedModel)
void	setDefaultFileStore(IFileStore fileStore)

Methods inherited from class java.lang.Object

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

Field Detail

fileStore

protected IFileStore fileStore

pluginSources

protected ArrayList<IPluginSource> pluginSources

extensions

protected HashMap<String,ITemplatingExtension> extensions

Constructor Detail

GramarPlatform

public GramarPlatform()

Method Detail

getGramar

public IGramar getGramar(String gramarId)
                  throws NoSuchGramarException,
                         InvalidGramarException

Specified by:

getGramar in interface IGramarPlatform

Throws:

NoSuchGramarException

InvalidGramarException

getDefaultFileStore

public IFileStore getDefaultFileStore()

Specified by:

getDefaultFileStore in interface IGramarPlatform

setDefaultFileStore

public void setDefaultFileStore(IFileStore fileStore)

Specified by:

setDefaultFileStore in interface IGramarPlatform

addPluginSource

public void addPluginSource(IPluginSource source)

Specified by:

addPluginSource in interface IGramarPlatform

apply

public IGramarApplicationStatus apply(IModel model,
                             IGramar gramar)
                               throws GramarException

Specified by:

apply in interface IGramarPlatform

Throws:

GramarException

apply

public IGramarApplicationStatus apply(IModel model,
                             String gramarId)
                               throws GramarException

Specified by:

apply in interface IGramarPlatform

Throws:

GramarException

apply

public IGramarApplicationStatus apply(IModel model,
                             String gramarId,
                             IFileStore fileStore)
                               throws GramarException

Specified by:

apply in interface IGramarPlatform

Throws:

GramarException

apply

public IGramarApplicationStatus apply(IModel model,
                             IGramar gramar,
                             IFileStore fileStore)
                               throws GramarException

Specified by:

apply in interface IGramarPlatform

Throws:

GramarException

apply

public IGramarApplicationStatus apply(ITemplate mainTemplate,
                             IGramar gramar,
                             IGramarContext context)

addTemplatingExtension

public void addTemplatingExtension(ITemplatingExtension extension)

Description copied from interface: IGramarPlatform

Caches the given extension for later use

Specified by:

addTemplatingExtension in interface IGramarPlatform

getTemplatingExtension

public ITemplatingExtension getTemplatingExtension(String extensionId)
                                            throws NoSuchTemplatingExtensionException,
                                                   InvalidTemplateExtensionException

Description copied from interface: IGramarPlatform

If not already cached, searches the known plugin sources for the extension, caches it, then returns it.

Specified by:

getTemplatingExtension in interface IGramarPlatform

Throws:

NoSuchTemplatingExtensionException

InvalidTemplateExtensionException

loadExtensions

protected abstract void loadExtensions()

Called by the constructor to give the implementer the chance to load any known extensions, gramars, etc

Throws:

GramarException

getKnownGramars

public IGramar[] getKnownGramars()

Description copied from interface: IGramarPlatform

Returns aa array of all Gramars known to any PluginSource

Specified by:

getKnownGramars in interface IGramarPlatform

Returns:

getFileStore

public IFileStore getFileStore(String fileStoreId)
                        throws NoSuchFileStoreException

Description copied from interface: IGramarPlatform

Searches all known plugin sources for an extension that provides a filestore with the given filestore ID. Ask that extension for an instance of that filestare and return the instance.

Specified by:

getFileStore in interface IGramarPlatform

Returns:

Throws:

NoSuchFileStoreException

scoreKnownGramars

public GramarScore[] scoreKnownGramars(IModel proposedModel)

Specified by:

scoreKnownGramars in interface IGramarPlatform

Returns:

a sorted array of gramars with associated scores. GramarScores are returned with the best match first and the worst match last.