Package org.eclipse.epsilon.hutn

Class HutnModule

java.lang.Object

org.eclipse.epsilon.common.module.AbstractModuleElement

org.eclipse.epsilon.eol.AbstractModule

org.eclipse.epsilon.eol.EolModule

org.eclipse.epsilon.hutn.HutnModule

All Implemented Interfaces:

IModule, ModuleElement, IEolModule, IHutnModule

public class HutnModule
extends EolModule
implements IHutnModule

Field Summary

Fields

Modifier and Type	Field	Description
protected File	configFileDirectory
protected HutnDocument	document
protected boolean	hutnIsValid
protected boolean	metaModelIsValid
protected Spec	spec

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
HutnModule()
HutnModule(IHutnContext context)	Instantiates the module with the specified execution context.

Method Summary

Modifier and Type	Method	Description
ModuleElement	adapt(AST cst, ModuleElement parentAst)
void	build(AST cst, IModule module)
protected org.antlr.runtime.Lexer	createLexer(org.antlr.runtime.ANTLRInputStream inputStream)
EpsilonParser	createParser(org.antlr.runtime.TokenStream tokenStream)
AbstractEmfModel	generateEmfModel()
IHutnContext	getContext()
Spec	getIntermediateModel()
String	getMainRule()
String	getModelFile()
List<String>	getNsUris()
boolean	hasValidHutn()	Returns false only if the HUTN source passed to parse is not valid HUTN.
boolean	hasValidMetaModel()
protected boolean	invokeMainRule(List<org.antlr.runtime.CommonToken> comments)
protected boolean	parsingWasSuccessful()
void	setConfigFileDirectory(File configFileDirectory)
List<File>	storeEmfModel(File baseDirectory, String defaultModelPath, String inferredMetamodelPath)	Generates an EMF model for the HUTN source passed to parse.
void	storeIntermediateModel(File destination)
void	storeIntermediateModelTransformation(File destination)
void	storeIntermediateModelTransformationForAllInputModels(File destination)
protected void	translateAst(AST ast)

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

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

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

assignAnnotations, assignComment, assignComments, createAst, extractComments, getParseProblems, getSourceFile, getSourceUri, 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, getConfigurationProperties, getParseProblems, parse

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

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

Field Details

document

protected HutnDocument document

spec

protected Spec spec

metaModelIsValid

protected boolean metaModelIsValid

configFileDirectory

protected File configFileDirectory

hutnIsValid

protected boolean hutnIsValid

Constructor Details

HutnModule

public HutnModule()

HutnModule

public HutnModule(IHutnContext context)

Instantiates the module with the specified execution context.

Parameters:

context - The execution context

Since:

1.6

Method Details

createLexer

protected org.antlr.runtime.Lexer createLexer(org.antlr.runtime.ANTLRInputStream inputStream)

Overrides:

createLexer in class EolModule

createParser

public EpsilonParser createParser(org.antlr.runtime.TokenStream tokenStream)

Overrides:

createParser in class EolModule

adapt

public ModuleElement adapt(AST cst,
 ModuleElement parentAst)

Overrides:

adapt in class EolModule

getMainRule

public String getMainRule()

Overrides:

getMainRule in class EolModule

getContext

public IHutnContext getContext()

Specified by:

getContext in interface IEolModule

Overrides:

getContext in class EolModule

invokeMainRule

protected boolean invokeMainRule(List<org.antlr.runtime.CommonToken> comments)
                          throws Exception

Overrides:

invokeMainRule in class AbstractModule

Throws:

Exception

parsingWasSuccessful

protected boolean parsingWasSuccessful()

build

public void build(AST cst,
 IModule module)

Specified by:

build in interface ModuleElement

Overrides:

build in class EolModule

translateAst

protected void translateAst(AST ast)
                     throws HutnException

Throws:

HutnException

hasValidHutn

public boolean hasValidHutn()

Description copied from interface: IHutnModule

Returns false only if the HUTN source passed to parse is not valid HUTN. True is returned when the HUTN is valid, regardless of whether it conforms to the metamodel specified in the preamble.

Specified by:

hasValidHutn in interface IHutnModule

setConfigFileDirectory

public void setConfigFileDirectory(File configFileDirectory)

Specified by:

setConfigFileDirectory in interface IHutnModule

hasValidMetaModel

public boolean hasValidMetaModel()

Specified by:

hasValidMetaModel in interface IHutnModule

getNsUris

public List<String> getNsUris()

Specified by:

getNsUris in interface IHutnModule

getModelFile

public String getModelFile()

Specified by:

getModelFile in interface IHutnModule

generateEmfModel

public AbstractEmfModel generateEmfModel()
                                  throws HutnGenerationException

Specified by:

generateEmfModel in interface IHutnModule

Returns:

an in-memory EMF model for the HUTN source passed to parse.

Throws:

HutnGenerationException

storeEmfModel

public List<File> storeEmfModel(File baseDirectory,
 String defaultModelPath,
 String inferredMetamodelPath)
                         throws HutnGenerationException

Description copied from interface: IHutnModule

Generates an EMF model for the HUTN source passed to parse.

The model is stored in the given baseDirectory, with filename defaultModelPath. The HUTN source may contain a modelFile attribute (in a model package, in the Spec preamble). When a modelFile attribute is specified in the HUTN source, that value takes precedence over defaultModelPath.

When a metamodel is inferred (because no metamodel is specfied in the Spec preamble), it is generated in the given baseDirectory, with filename inferredMetamodelPath.

Specified by:

storeEmfModel in interface IHutnModule

Returns:

the list of Files generated by this method invocation.

Throws:

HutnGenerationException

getIntermediateModel

public Spec getIntermediateModel()

Specified by:

getIntermediateModel in interface IHutnModule

storeIntermediateModel

public void storeIntermediateModel(File destination)

Specified by:

storeIntermediateModel in interface IHutnModule

storeIntermediateModelTransformation

public void storeIntermediateModelTransformation(File destination)
                                          throws HutnGenerationException

Specified by:

storeIntermediateModelTransformation in interface IHutnModule

Throws:

HutnGenerationException

storeIntermediateModelTransformationForAllInputModels

public void storeIntermediateModelTransformationForAllInputModels(File destination)
                                                           throws HutnGenerationException

Specified by:

storeIntermediateModelTransformationForAllInputModels in interface IHutnModule

Throws:

HutnGenerationException