Package org.eclipse.epsilon.egl.dom

Class GenerationRule

java.lang.Object

org.eclipse.epsilon.common.module.AbstractModuleElement

org.eclipse.epsilon.eol.dom.AnnotatableModuleElement

org.eclipse.epsilon.erl.dom.NamedRule

org.eclipse.epsilon.erl.dom.ExtensibleNamedRule

org.eclipse.epsilon.egl.dom.GenerationRule

All Implemented Interfaces:

ModuleElement, IExecutableModuleElement, IExecutableModuleElementParameter

Direct Known Subclasses:

LazyEgxModule.LazyGenerationRule

public class GenerationRule
extends ExtensibleNamedRule
implements IExecutableModuleElementParameter, IExecutableModuleElement

Field Summary

Fields

Modifier and Type	Field	Description
protected ExecutableBlock<Boolean>	appendBlock
protected ExecutableBlock<Collection<?>>	domainBlock
protected ExecutableBlock<Formatter>	formatterBlock
protected ExecutableBlock<Boolean>	guardBlock
protected ExecutableBlock<Boolean>	mergeBlock
protected ExecutableBlock<Boolean>	overwriteBlock
protected ExecutableBlock<EolMap<String,?>>	parametersBlock
protected ExecutableBlock<Boolean>	patchBlock
protected ExecutableBlock<?>	postBlock
protected ExecutableBlock<?>	preBlock
protected Parameter	sourceParameter
protected ExecutableBlock<String>	targetBlock
protected ExecutableBlock<String>	templateBlock

Fields inherited from class org.eclipse.epsilon.erl.dom.ExtensibleNamedRule

allSuperRules, isAbstract, isGreedy, isLazy, isParallel, ofKindCache, ofTypeCache, superRules, superRulesIdentifiers

Fields inherited from class org.eclipse.epsilon.erl.dom.NamedRule

nameExpression

Fields inherited from class org.eclipse.epsilon.eol.dom.AnnotatableModuleElement

annotationBlock

Fields inherited from class org.eclipse.epsilon.common.module.AbstractModuleElement

children, comments, data, module, parent, region, uri

Constructor Summary

Constructors

Constructor	Description
GenerationRule()

Method Summary

Modifier and Type	Method	Description
void	accept(IEgxVisitor visitor)
void	build(AST cst, IModule module)
Object	execute(IEolContext context)
Object	execute(IEolContext context_, Object element)
Collection<?>	getAllElements(IEolContext context)
ExecutableBlock<? extends Collection<?>>	getDomainBlock()
ExecutableBlock<Formatter>	getFormatterBlock()
ExecutableBlock<Boolean>	getGuardBlock()
ExecutableBlock<Boolean>	getMergeBlock()
ExecutableBlock<Boolean>	getOverwriteBlock()
IModel	getOwningModelForType(IEolContext context)	Gets the model which the "transform" parameter type expression belongs to.
ExecutableBlock<EolMap<String,?>>	getParametersBlock()
ExecutableBlock<?>	getPostBlock()
ExecutableBlock<?>	getPreBlock()
AST	getSuperRulesAst(AST cst)
ExecutableBlock<String>	getTargetBlock()
ExecutableBlock<String>	getTemplateBlock()
Parameter	getTransformSource()	Gets the parameter bound to the "transform" part, if hasTransformSource() == true.
boolean	hasTransformSource()	Used to determine whether this rule operates over a collection of model elements.
String	toString()

Methods inherited from class org.eclipse.epsilon.erl.dom.ExtensibleNamedRule

calculateSuperRules, calculateSuperRules, getAllInstances, getAllOfKind, getAllOfType, getAllSuperRules, getRuleByName, getSuperRules, isAbstract, isGreedy, isLazy, isParallel

Methods inherited from class org.eclipse.epsilon.erl.dom.NamedRule

equals, getName, getNameAst, getNameExpression, hashCode

Methods inherited from class org.eclipse.epsilon.eol.dom.AnnotatableModuleElement

accept, getAnnotation, getAnnotationBlock, getAnnotations, getAnnotationsValues, getBooleanAnnotationValue, getBooleanAnnotationValue, getBooleanAnnotationValue, getBooleanAnnotationValue, hasAnnotation, setAnnotationBlock

Methods inherited from class org.eclipse.epsilon.common.module.AbstractModuleElement

getChildren, getComments, getData, getDebugInfo, getFile, getModule, getParent, getRegion, getUri, setModule, setParent, setRegion, setUri

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.epsilon.common.module.ModuleElement

getChildren, getComments, getData, getFile, getModule, getParent, getRegion, getUri, setModule, setParent, setRegion, setUri

Field Details

sourceParameter

protected Parameter sourceParameter

domainBlock

protected ExecutableBlock<Collection<?>> domainBlock

targetBlock

protected ExecutableBlock<String> targetBlock

templateBlock

protected ExecutableBlock<String> templateBlock

guardBlock

protected ExecutableBlock<Boolean> guardBlock

overwriteBlock

protected ExecutableBlock<Boolean> overwriteBlock

mergeBlock

protected ExecutableBlock<Boolean> mergeBlock

appendBlock

protected ExecutableBlock<Boolean> appendBlock

patchBlock

protected ExecutableBlock<Boolean> patchBlock

preBlock

protected ExecutableBlock<?> preBlock

postBlock

protected ExecutableBlock<?> postBlock

parametersBlock

protected ExecutableBlock<EolMap<String,?>> parametersBlock

formatterBlock

protected ExecutableBlock<Formatter> formatterBlock

Constructor Details

GenerationRule

public GenerationRule()

Method Details

build

public void build(AST cst,
 IModule module)

Specified by:

build in interface ModuleElement

Overrides:

build in class ExtensibleNamedRule

getAllElements

public Collection<?> getAllElements(IEolContext context)
                             throws EolRuntimeException

Throws:

EolRuntimeException

execute

public Object execute(IEolContext context_,
 Object element)
               throws EolRuntimeException

Specified by:

execute in interface IExecutableModuleElementParameter

Throws:

EolRuntimeException

execute

public Object execute(IEolContext context)
               throws EolRuntimeException

Specified by:

execute in interface IExecutableModuleElement

Throws:

EolRuntimeException

getOwningModelForType

public IModel getOwningModelForType(IEolContext context)
                             throws EolRuntimeException

Gets the model which the "transform" parameter type expression belongs to.

Parameters:

context -

Returns:

The model for the parameter.

Throws:

EolRuntimeException

Since:

1.6

toString

public String toString()

Overrides:

toString in class NamedRule

getSuperRulesAst

public AST getSuperRulesAst(AST cst)

Specified by:

getSuperRulesAst in class ExtensibleNamedRule

accept

public void accept(IEgxVisitor visitor)

getTransformSource

public Parameter getTransformSource()

Gets the parameter bound to the "transform" part, if hasTransformSource() == true.

Returns:

The part following "transform", or null if absent.

Since:

2.3

hasTransformSource

public boolean hasTransformSource()

Used to determine whether this rule operates over a collection of model elements.

Returns:

true if the rule has a "transform" part.

Since:

2.3

getDomainBlock

public ExecutableBlock<? extends Collection<?>> getDomainBlock()

Returns:

Since:

2.3

getTargetBlock

public ExecutableBlock<String> getTargetBlock()

Returns:

Since:

2.3

getTemplateBlock

public ExecutableBlock<String> getTemplateBlock()

Returns:

Since:

2.3

getGuardBlock

public ExecutableBlock<Boolean> getGuardBlock()

Returns:

Since:

2.3

getOverwriteBlock

public ExecutableBlock<Boolean> getOverwriteBlock()

Returns:

Since:

2.3

getMergeBlock

public ExecutableBlock<Boolean> getMergeBlock()

Returns:

Since:

2.3

getPreBlock

public ExecutableBlock<?> getPreBlock()

Returns:

Since:

2.3

getPostBlock

public ExecutableBlock<?> getPostBlock()

Returns:

Since:

2.3

getParametersBlock

public ExecutableBlock<EolMap<String,?>> getParametersBlock()

Returns:

Since:

2.3

getFormatterBlock

public ExecutableBlock<Formatter> getFormatterBlock()

Returns:

Since:

2.5