org.eclipse.tigerstripe.workbench.plugins
Interface IArtifactBasedTemplateRule

All Superinterfaces:

IRule, ITemplateBasedRule

public interface IArtifactBasedTemplateRule
extends ITemplateBasedRule

An ArtifactBased Template Run rule in a Pluggable Plugin This rule will be run once per instance (with possibility of filtering) of a designated Artifact Type. For each instance of that Artifact Type a "Model Object" will be instantiated and placed in the velocity context.

Since:

0.3

Author:

Eric Dillon

Field Summary

static java.lang.String

ANY_ARTIFACT_LABEL

Method Summary

java.lang.String	getArtifactFilterClass()
java.lang.String	getArtifactType()
java.lang.String	getModelClass() Returns the Fully Qualified Name of the Model to instantiate
java.lang.String	getModelClassName() Get the name to be used in the templates for objects of this type This will typically be "model" or "class"
void	setArtifactFilterClass(java.lang.String classname)
void	setArtifactType(java.lang.String artifactType)
void	setModelClass(java.lang.String classname) Sets the classname of the model object to instantiate
void	setModelClassName(java.lang.String classname) Set the name to be used in the templates for objects of this type This will typically be "model" or "class"

Methods inherited from interface org.eclipse.tigerstripe.workbench.plugins.ITemplateBasedRule

addMacroLibraries, addMacroLibrary, addVelocityContextDefinition, addVelocityContextDefinitions, getMacroLibraries, getOutputFile, getTemplate, getVelocityContextDefinitions, hasMacroLibrary, isOverwriteFiles, isSuppressEmptyFiles, removeMacroLibraries, removeMacroLibrary, removeVelocityContextDefinition, removeVelocityContextDefinitions, setOutputFile, setOverwriteFiles, setSuppressEmptyFiles, setTemplate

Methods inherited from interface org.eclipse.tigerstripe.workbench.plugins.IRule

getDescription, getLabel, getName, getType, isEnabled, setDescription, setEnabled, setName

Field Detail

ANY_ARTIFACT_LABEL

static final java.lang.String ANY_ARTIFACT_LABEL

See Also:

Constant Field Values

Method Detail

getModelClass

java.lang.String getModelClass()

Returns the Fully Qualified Name of the Model to instantiate

Returns:

setModelClass

void setModelClass(java.lang.String classname)

Sets the classname of the model object to instantiate

Parameters:

classname -

getModelClassName

java.lang.String getModelClassName()

Get the name to be used in the templates for objects of this type This will typically be "model" or "class"

Returns:

setModelClassName

void setModelClassName(java.lang.String classname)

Set the name to be used in the templates for objects of this type This will typically be "model" or "class"

Parameters:

classname -

getArtifactFilterClass

java.lang.String getArtifactFilterClass()

setArtifactFilterClass

void setArtifactFilterClass(java.lang.String classname)

getArtifactType

java.lang.String getArtifactType()

setArtifactType

void setArtifactType(java.lang.String artifactType)