Package org.eclipse.epsilon.emg

Class EmgModule

java.lang.Object

org.eclipse.epsilon.common.module.AbstractModuleElement

org.eclipse.epsilon.eol.AbstractModule

org.eclipse.epsilon.eol.EolModule

org.eclipse.epsilon.erl.ErlModule

org.eclipse.epsilon.epl.AbstractEplModule

org.eclipse.epsilon.epl.EplModule

org.eclipse.epsilon.emg.EmgModule

All Implemented Interfaces:

IModule, ModuleElement, IEmgModule, IEolModule, IEplModule, IErlModule

public class EmgModule
extends EplModule
implements IEmgModule

The Emg Module is responsible for execution emg scripts. Emg scripts are used to generate models.

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.epsilon.epl.AbstractEplModule

AbstractEplModule.LazyAdvancedRoleInstancesInitializer, AbstractEplModule.LazyBasicRoleInstancesInitializer

Field Summary

Fields inherited from class org.eclipse.epsilon.epl.AbstractEplModule

declaredPatterns, INFINITE, maxLoops, patternMatchModelName, patterns, repeatWhileMatchesFound

Fields inherited from class org.eclipse.epsilon.erl.ErlModule

declaredPost, declaredPre, post, pre

Fields inherited from class org.eclipse.epsilon.eol.EolModule

context, declaredModelDeclarations, declaredOperations, imports, main, modelDeclarations, operations, postOperationStatements

Fields inherited from class org.eclipse.epsilon.eol.AbstractModule

parseProblems, parser, sourceFile, sourceUri

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

children, comments, data, module, region, uri

Constructor Summary

Constructors

Constructor	Description
EmgModule()

Method Summary

Modifier and Type	Method	Description
protected boolean	containAny(Collection<Object> first, Collection<Object> last)	Contain any.
protected void	executeCreateOperations()	Execute the create operations in the EMG script.
protected double	getFloat(Object object)	Gets the float.
HashMap<String,Class<? extends IModule>>	getImportConfiguration()
protected int	getInt(Object object)	Gets the int.
Map<String,List<Object>>	getNamedCreatedObjects()
List<PatternMatch>	match(Pattern pattern)	This method provides the main high-level execution logic for EPL.
protected void	prepareContext()
Object	processRules()	Main rule processing logic.
void	setSeed(long seed)
void	setUseSeed(boolean useSeed)

Methods inherited from class org.eclipse.epsilon.epl.EplModule

createCombinationGenerator, getCandidates, initGenerator, wrapAdvancedRoleInstances, wrapBasicRoleInstances

Methods inherited from class org.eclipse.epsilon.epl.AbstractEplModule

adapt, build, createLexer, createModel, createParser, createPatternMatch, executeDoBlock, filterElements, flatMapRoleBindings, getContext, getDeclaredPatterns, getMainRule, getMatchResult, getMaxLoops, getPatterns, getRoleInstances, getVariables, isRepeatWhileMatches, isValidCombination, matchCombination, matchPatterns, matchPatterns, negativeGuard, postProcessMatches, preMatch, putRoleBindingsIntoFrame, setMaxLoops, setRepeatWhileMatches

Methods inherited from class org.eclipse.epsilon.erl.ErlModule

calculateSuperRules, execute, execute, executeImpl, getDeclaredPost, getDeclaredPre, getPost, getPre, postExecution, prepareExecution

Methods inherited from class org.eclipse.epsilon.eol.EolModule

checkImports, clearCache, execute, getDeclaredModelDeclarations, getDeclaredOperations, getImportManager, getImports, getImportsByExtension, getMain, getModelDeclarations, getOperations, getParentModule, getPostOperationStatements, setContext, setImportManager, setMain, setParentModule, toString

Methods inherited from class org.eclipse.epsilon.eol.AbstractModule

assignAnnotations, assignComment, assignComments, createAst, extractComments, getParseProblems, getSourceFile, getSourceUri, invokeMainRule, parse, parse

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

equals, getChildren, getComments, getData, getDebugInfo, getFile, getModule, getParent, getRegion, getUri, hashCode, 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.eol.IEolModule

configure, execute, getConfigurationProperties, getDeclaredModelDeclarations, getDeclaredOperations, getImportManager, getImports, getMain, getModelDeclarations, getOperations, getParentModule, getParseProblems, getPostOperationStatements, parse, setContext, setImportManager, setParentModule

Methods inherited from interface org.eclipse.epsilon.epl.IEplModule

getDeclaredPatterns, getMaximumLevel, getMaxLoops, getPatterns, isRepeatWhileMatches, matchPatterns, setMaxLoops, setRepeatWhileMatches

Methods inherited from interface org.eclipse.epsilon.erl.IErlModule

getContext, getDeclaredPost, getDeclaredPre, getPost, getPre

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

createAst, getSourceUri, parse, parse, parse, parse, parse

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

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

Constructor Details

EmgModule

public EmgModule()

Method Details

setSeed

public void setSeed(long seed)

Specified by:

setSeed in interface IEmgModule

Parameters:

seed - the seed to set

setUseSeed

public void setUseSeed(boolean useSeed)

Specified by:

setUseSeed in interface IEmgModule

Parameters:

useSeed - the useSeed to set

getNamedCreatedObjects

public Map<String,List<Object>> getNamedCreatedObjects()

Specified by:

getNamedCreatedObjects in interface IEmgModule

Returns:

the namedCreatedObjects

getImportConfiguration

public HashMap<String,Class<? extends IModule>> getImportConfiguration()

Overrides:

getImportConfiguration in class AbstractEplModule

prepareContext

protected void prepareContext()
                       throws EolRuntimeException

Overrides:

prepareContext in class EolModule

Throws:

EolRuntimeException

processRules

public Object processRules()
                    throws EolRuntimeException

Description copied from class: ErlModule

Main rule processing logic. Non-abstract for compatibility.

Overrides:

processRules in class AbstractEplModule

Returns:

The result of executing this module.

Throws:

EolRuntimeException

executeCreateOperations

protected void executeCreateOperations()
                                throws EolRuntimeException

Execute the create operations in the EMG script.

Throws:

EolModelElementTypeNotFoundException - the eol model element type not found exception

EolRuntimeException - If the type to be instantiated can't be found or any of the random functions fails.

match

public List<PatternMatch> match(Pattern pattern)
                         throws EolRuntimeException

Description copied from class: AbstractEplModule

This method provides the main high-level execution logic for EPL. The idea is that for each role in the pattern, appropriate bindings are made to the role and executed. Then the match block (and subsequently onMatch) is executed for the role and a PatternMatch is created where applicable.
In essence, this method can be thought of as the executor of all roles in the pattern, and therefore acts as a bridge between the high-level methods (e.g. AbstractEplModule.matchPatterns(int, PatternMatchModel)) and the low-level ones (e.g. AbstractEplModule.getRoleInstances(Role, String)).
Implementation-wise, this method delegates the main execution logic to AbstractEplModule.matchCombination(Collection, Pattern), and so the sole responsibility of this method is to loop through the combinations returned by AbstractEplModule.getCandidates(Pattern) and collect all the results. Subclasses may override this method to alter the type of collection returned and/or alter the looping mechanism.

Specified by:

match in interface IEplModule

Overrides:

match in class AbstractEplModule

Throws:

EolRuntimeException

getInt

protected int getInt(Object object)

Gets the int.

Parameters:

object - the object

Returns:

the int

getFloat

protected double getFloat(Object object)

Gets the float.

Parameters:

object - the object

Returns:

the float

containAny

protected boolean containAny(Collection<Object> first,
 Collection<Object> last)

Contain any.

Parameters:

first - the first

last - the last

Returns:

true, if successful