org.gramar.gramar

Class Gramar

java.lang.Object

org.gramar.gramar.Gramar

All Implemented Interfaces:

IGramar

Direct Known Subclasses:

ClasspathGramar, JarGramar, ZipGrammar

public abstract class Gramar
extends Object
implements IGramar

Field Summary

Fields

Modifier and Type	Field and Description
protected String	gramarId
protected String	label
protected String	mainproduction
static String	META_FILE_NAME
protected String	provider
protected ArrayList<ISampleModel>	sampleModels
protected ArrayList<TagLibSpec>	taglibs

Constructor Summary

Constructors

Constructor and Description
Gramar()

Method Summary

Methods

Modifier and Type	Method and Description
void	free() Free any cached resources
String	getId()
String	getLabel()
String	getMainProductionId() Answers the current relative path into the gramar of the gramar's primary production
Properties	getProperties()
String	getProvider()
IModel	getSampleModel(String name)
List<ISampleModel>	getSamples()
ArrayList<TagLibSpec>	getTaglibs()
ITemplate	getTemplate(String id, IGramarContext context)
InputStream	getTemplateBinary(String id)
String	getTemplateSource(String id)
void	loadMeta()
abstract InputStream	readTemplateBinary(String id)
abstract String	readTemplateSource(String id)
Double	scoreApplicability(IModel proposedModel) Estimates the applicability of the receiving gramar to the specified proposed model.
void	setPrimaryProductionId(String newId) Sets the relative path of the gramar production that will be processed when the gramar is applied to the model.
void	storeSource(String name, String content)

Methods inherited from class java.lang.Object

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

Field Detail

gramarId

protected String gramarId

label

protected String label

provider

protected String provider

mainproduction

protected String mainproduction

taglibs

protected ArrayList<TagLibSpec> taglibs

sampleModels

protected ArrayList<ISampleModel> sampleModels

META_FILE_NAME

public static final String META_FILE_NAME

See Also:

Constant Field Values

Constructor Detail

Gramar

public Gramar()
       throws InvalidGramarException

Throws:

InvalidGramarException

Method Detail

free

public void free()

Description copied from interface: IGramar

Free any cached resources

Specified by:

free in interface IGramar

getId

public String getId()

Specified by:

getId in interface IGramar

getLabel

public String getLabel()

Specified by:

getLabel in interface IGramar

getProvider

public String getProvider()

Specified by:

getProvider in interface IGramar

getMainProductionId

public String getMainProductionId()

Description copied from interface: IGramar

Answers the current relative path into the gramar of the gramar's primary production

Specified by:

getMainProductionId in interface IGramar

Returns:

the primary production id

setPrimaryProductionId

public void setPrimaryProductionId(String newId)

Description copied from interface: IGramar

Sets the relative path of the gramar production that will be processed when the gramar is applied to the model.

Specified by:

setPrimaryProductionId in interface IGramar

getProperties

public Properties getProperties()

getTemplate

public ITemplate getTemplate(String id,
                    IGramarContext context)
                      throws GramarException

Specified by:

getTemplate in interface IGramar

Throws:

GramarException

storeSource

public void storeSource(String name,
               String content)

getTemplateSource

public String getTemplateSource(String id)
                         throws NoSuchResourceException

Specified by:

getTemplateSource in interface IGramar

Returns:

a String containing the content of the given template

Throws:

NoSuchResourceException

getTemplateBinary

public InputStream getTemplateBinary(String id)
                              throws NoSuchResourceException

Specified by:

getTemplateBinary in interface IGramar

Returns:

an InputStream from which can be read the binary content of the given template

Throws:

NoSuchResourceException

readTemplateSource

public abstract String readTemplateSource(String id)
                                   throws NoSuchResourceException

Throws:

NoSuchResourceException

readTemplateBinary

public abstract InputStream readTemplateBinary(String id)
                                        throws NoSuchResourceException

Throws:

NoSuchResourceException

loadMeta

public void loadMeta()
              throws InvalidGramarException

Throws:

InvalidGramarException

getTaglibs

public ArrayList<TagLibSpec> getTaglibs()

getSamples

public List<ISampleModel> getSamples()

Specified by:

getSamples in interface IGramar

Returns:

a list of sample models deployed with this gramar

getSampleModel

public IModel getSampleModel(String name)

Specified by:

getSampleModel in interface IGramar

Returns:

the sample model configured with the given name

scoreApplicability

public Double scoreApplicability(IModel proposedModel)

Description copied from interface: IGramar

Estimates the applicability of the receiving gramar to the specified proposed model. The returned score is a double value between 0 and 100 where 100 represents a high applicability. It is expected that the receiving gramar will count how many of the elements in the proposed model have the same xpath as an element in one of the sample models configured for the receiver. The percentage would be returned as a double value between 0 and 100 inclusive.

Specified by:

scoreApplicability in interface IGramar

Returns: