de.uni_hildesheim.sse.ui.hyperlinking

Class EcoreModelQuery

java.lang.Object

net.ssehub.easy.dslCore.ui.hyperlinking.AbstractEcoreModelQuery<de.uni_hildesheim.sse.ivml.Project,ModelElementTypeFinder.ModelElementDescription>

de.uni_hildesheim.sse.ui.hyperlinking.EcoreModelQuery

All Implemented Interfaces:

IEcoreModelQuery<de.uni_hildesheim.sse.ivml.Project,ModelElementTypeFinder.ModelElementDescription>

public class EcoreModelQuery
extends AbstractEcoreModelQuery<de.uni_hildesheim.sse.ivml.Project,ModelElementTypeFinder.ModelElementDescription>

Field Summary

Fields

Modifier and Type	Field and Description
static EcoreModelQuery	INSTANCE The instance of this EcoreModelQuery for retrieving elements from an Ecore-model.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	EcoreModelQuery() Constructs an instance of this EcoreModelQuery.

Method Summary

Modifier and Type	Method and Description
private boolean	compareByBasicType(de.uni_hildesheim.sse.ivml.VariableDeclaration varDecl, ModelElementTypeFinder.ModelElementDescription elementDescription) Checks whether the given ModelElementTypeFinder.ModelElementDescription describes the given VariableDeclaration.
private boolean	compareByDerivedType(de.uni_hildesheim.sse.ivml.VariableDeclaration varDecl, ModelElementTypeFinder.ModelElementDescription elementDescription) Checks whether the given ModelElementTypeFinder.ModelElementDescription describes the given VariableDeclaration.
private boolean	compareByQualifiedName(de.uni_hildesheim.sse.ivml.VariableDeclaration varDecl, ModelElementTypeFinder.ModelElementDescription elementDescription) Checks whether the given ModelElementTypeFinder.ModelElementDescription describes the given VariableDeclaration.
private java.lang.String	constructFullTypeDefinition(de.uni_hildesheim.sse.ivml.Type type) Returns the full type definition based on the given Type.
private boolean	equalNames(de.uni_hildesheim.sse.ivml.VariableDeclaration varDecl, ModelElementTypeFinder.ModelElementDescription elementDescription) Checks whether the name of the given VariableDeclaration equals the name of the given .
org.eclipse.emf.ecore.EObject	getEcoreElement(CommonXtextEditor<?,de.uni_hildesheim.sse.ivml.Project> ivmlEditor, ModelElementTypeFinder.ModelElementDescription elementDescription) Returns the EObject of the parse tree of the given XtextEditor's resource that matches the element described by the given ModelElementTypeFinder.ModelElementDescription.
java.lang.String	getName(de.uni_hildesheim.sse.ivml.Project project) Returns the name of the project.
de.uni_hildesheim.sse.ivml.Project	getProject(org.eclipse.xtext.nodemodel.ICompositeNode rootNode) Returns the Project of the Ecore-model represented by the given root node.
protected de.uni_hildesheim.sse.ivml.Project	getProject(org.eclipse.xtext.resource.XtextResource resource) Returns the Project in the given resource (IVML-file).
private java.util.List<de.uni_hildesheim.sse.ivml.Typedef>	getSpecificTypeDefs(java.util.List<de.uni_hildesheim.sse.ivml.Typedef> typeDefs, ModelElementTypeFinder.ClassType specificType) Creates a sub-list of the given list of Typedefs in which only type definitions are included that provide the specific type definition described by the given ModelElementTypeFinder.ClassType.
private boolean	isTypeDefClass(ModelElementTypeFinder.ClassType type) Checks whether the given ModelElementTypeFinder.ClassType describes a type definition in IVML, e.g.: Enum OrderedEnum Compound Mapping
private boolean	notEmpty(ModelElementTypeFinder.ModelElementDescription elementDescription) Checks whether the given ModelElementTypeFinder.ModelElementDescription is not null and all information is available (the nested Strings are not null or empty).
private org.eclipse.emf.ecore.EObject	processCompoundElements(de.uni_hildesheim.sse.ivml.TypedefCompound compound, ModelElementTypeFinder.ModelElementDescription elementDescription)
private org.eclipse.emf.ecore.EObject	processDecisionVariableDeclarations(java.util.List<de.uni_hildesheim.sse.ivml.VariableDeclaration> varDecls, ModelElementTypeFinder.ModelElementDescription elementDescription) Returns an EObject if this object is part of the given list of VariableDeclarations and matches the element described by the given ModelElementTypeFinder.ModelElementDescription.
private org.eclipse.emf.ecore.EObject	processProjectContents(de.uni_hildesheim.sse.ivml.ProjectContents projectContents, ModelElementTypeFinder.ModelElementDescription elementDescription) Returns an EObject if this object is part of the given ProjectContents and matches the element described by the given ModelElementTypeFinder.ModelElementDescription.
private org.eclipse.emf.ecore.EObject	processTypeDefinitions(java.util.List<de.uni_hildesheim.sse.ivml.Typedef> typeDefs, ModelElementTypeFinder.ModelElementDescription elementDescription, ModelElementTypeFinder.ClassType searchType) Returns an EObject if this object is part of the given list of Typedefs and matches the element described by the given ModelElementTypeFinder.ModelElementDescription.

Methods inherited from class net.ssehub.easy.dslCore.ui.hyperlinking.AbstractEcoreModelQuery

getRootNode, getXtextResource, notEmpty, notEmpty, notEmpty

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final EcoreModelQuery INSTANCE

The instance of this EcoreModelQuery for retrieving elements from an Ecore-model.

Constructor Detail

EcoreModelQuery

private EcoreModelQuery()

Constructs an instance of this EcoreModelQuery.

Method Detail

getProject

protected de.uni_hildesheim.sse.ivml.Project getProject(org.eclipse.xtext.resource.XtextResource resource)

Returns the Project in the given resource (IVML-file).

Parameters:

resource - the XtextResource from which the Project should be retrieved

Returns:

the Project in the given resource (IVML-file). May return null if the given resource is null, cannot be parsed, or there is no Project in that file

getProject

public de.uni_hildesheim.sse.ivml.Project getProject(org.eclipse.xtext.nodemodel.ICompositeNode rootNode)

Returns the Project of the Ecore-model represented by the given root node.

Parameters:

rootNode - the ICompositeNode which is the root of the Ecore-model from which the Project should be retrieved

Returns:

the Project in the given resource (IVML-file). May return null if the given root node is null, or there is no Project in that file

getEcoreElement

public org.eclipse.emf.ecore.EObject getEcoreElement(CommonXtextEditor<?,de.uni_hildesheim.sse.ivml.Project> ivmlEditor,
                                                     ModelElementTypeFinder.ModelElementDescription elementDescription)

Returns the EObject of the parse tree of the given XtextEditor's resource that matches the element described by the given ModelElementTypeFinder.ModelElementDescription. The search for this object will be performed in the Ecore-model of the given IVML-editor's resource only. This requires that it is ensured that the given editor displays an IVML-file which includes the desired element.

Parameters:

ivmlEditor - the XtextEditor which displays the IVML-file in which the desired element should be found

elementDescription - the ModelElementTypeFinder.ModelElementDescription that describes the VarModel element that should be found in the parse tree of the given editor's resource

Returns:

the EObject that matches the element described by the given ModelElementTypeFinder.ModelElementDescription. May return null if the element could not be found

processProjectContents

private org.eclipse.emf.ecore.EObject processProjectContents(de.uni_hildesheim.sse.ivml.ProjectContents projectContents,
                                                             ModelElementTypeFinder.ModelElementDescription elementDescription)

Returns an EObject if this object is part of the given ProjectContents and matches the element described by the given ModelElementTypeFinder.ModelElementDescription.

Parameters:

projectContents - the ProjectContents in which to search for the element described by the given ModelElementTypeFinder.ModelElementDescription

elementDescription - the ModelElementTypeFinder.ModelElementDescription that describes the EObject to be found in the ProjectContents

Returns:

an EObject if this object is part of the given projects ProjectContents and matches the element described by the given ModelElementTypeFinder.ModelElementDescription; null otherwise.

processDecisionVariableDeclarations

private org.eclipse.emf.ecore.EObject processDecisionVariableDeclarations(java.util.List<de.uni_hildesheim.sse.ivml.VariableDeclaration> varDecls,
                                                                          ModelElementTypeFinder.ModelElementDescription elementDescription)

Returns an EObject if this object is part of the given list of VariableDeclarations and matches the element described by the given ModelElementTypeFinder.ModelElementDescription.

Parameters:

varDecls - the list of VariableDeclarations in which to search for the element described by the given ModelElementTypeFinder.ModelElementDescription

elementDescription - the ModelElementTypeFinder.ModelElementDescription that describes the EObject to be found in the list of VariableDeclarations

Returns:

an EObject if this object is part of the given list of VariableDeclarations and matches the element described by the given ModelElementTypeFinder.ModelElementDescription; null otherwise.

compareByBasicType

private boolean compareByBasicType(de.uni_hildesheim.sse.ivml.VariableDeclaration varDecl,
                                   ModelElementTypeFinder.ModelElementDescription elementDescription)

Checks whether the given ModelElementTypeFinder.ModelElementDescription describes the given VariableDeclaration. This is done by checking the basic type and the name of the VariableDeclaration against the type and the name defined in the ModelElementTypeFinder.ModelElementDescription.

Parameters:

varDecl - the VariableDeclaration that is checked against the ModelElementTypeFinder.ModelElementDescription by type and name

elementDescription - the ModelElementTypeFinder.ModelElementDescription that is checked against the VariableDeclaration by type and name

Returns:

true if the given ModelElementTypeFinder.ModelElementDescription describes the given VariableDeclaration. False otherwise.

compareByQualifiedName

private boolean compareByQualifiedName(de.uni_hildesheim.sse.ivml.VariableDeclaration varDecl,
                                       ModelElementTypeFinder.ModelElementDescription elementDescription)

Checks whether the given ModelElementTypeFinder.ModelElementDescription describes the given VariableDeclaration. This is done by checking the qualified name of the VariableDeclaration against the type defined in the ModelElementTypeFinder.ModelElementDescription and by checking the name of the VariableDeclaration against the name defined in the ModelElementTypeFinder.ModelElementDescription.

Parameters:

varDecl - the VariableDeclaration that is checked against the ModelElementTypeFinder.ModelElementDescription by qualified name (type) and name

elementDescription - the ModelElementTypeFinder.ModelElementDescription that is checked against the VariableDeclaration by qualified name (type) and name

Returns:

true if the given ModelElementTypeFinder.ModelElementDescription describes the given VariableDeclaration. False otherwise.

compareByDerivedType

private boolean compareByDerivedType(de.uni_hildesheim.sse.ivml.VariableDeclaration varDecl,
                                     ModelElementTypeFinder.ModelElementDescription elementDescription)

Checks whether the given ModelElementTypeFinder.ModelElementDescription describes the given VariableDeclaration. This is done by re-constructing the full type definition under the assumption that the given VariableDeclaration is constructed by a combination of (derived) types, e.g. sequenceOf(refBy(MyInteger)). This re-constructed type is than checked against the type of the given ModelElementTypeFinder.ModelElementDescription. If this type is equal and the name of the VariableDeclaration and in the ModelElementTypeFinder.ModelElementDescription are equal, both elements describe the same model element.

Parameters:

varDecl - the VariableDeclaration that is checked against the ModelElementTypeFinder.ModelElementDescription by type and name

elementDescription - the ModelElementTypeFinder.ModelElementDescription that is checked against the VariableDeclaration by type and name

Returns:

true if the given ModelElementTypeFinder.ModelElementDescription describes the given VariableDeclaration. False otherwise.

constructFullTypeDefinition

private java.lang.String constructFullTypeDefinition(de.uni_hildesheim.sse.ivml.Type type)

Returns the full type definition based on the given Type. This leads to re-construction of combined types like sequenceOf(refBy(MyInteger)).

Parameters:

type - the Type from where to start re-constructing the full type definition by recursively checking the sub-types (any valid combination of derived types, qualified names, and basic types).

Returns:

the full type definition as a String. May return an empty String the given type is null.

equalNames

private boolean equalNames(de.uni_hildesheim.sse.ivml.VariableDeclaration varDecl,
                           ModelElementTypeFinder.ModelElementDescription elementDescription)

Checks whether the name of the given VariableDeclaration equals the name of the given . This is done by iterating over all variable declaration parts of the VariableDeclaration and checking whether one of these parts match the name of the .

Parameters:

varDecl - the VariableDeclaration of which all variable declaration parts are checked against the name defined by the given

elementDescription - the ModelElementTypeFinder.ModelElementDescription which name is checked against all variable declaration parts of the given VariableDeclaration

Returns:

true if the name defined in the given ModelElementTypeFinder.ModelElementDescription matches one variable declaration part of the given VariableDeclaration. False otherwise.

processTypeDefinitions

private org.eclipse.emf.ecore.EObject processTypeDefinitions(java.util.List<de.uni_hildesheim.sse.ivml.Typedef> typeDefs,
                                                             ModelElementTypeFinder.ModelElementDescription elementDescription,
                                                             ModelElementTypeFinder.ClassType searchType)

Returns an EObject if this object is part of the given list of Typedefs and matches the element described by the given ModelElementTypeFinder.ModelElementDescription. This method compares a filtered subset of the given list of Typedef. Which specific type of Typedef will be used depends on the given ModelElementTypeFinder.ClassType searchType. Currently supported types are: Compound, Enum (which will also include OrderedEnum, and Mapping. Note that this kind of comparison requires to ensure that the given ModelElementTypeFinder.ModelElementDescription describes a Typedef.

Parameters:

typeDefs - the full list of Typedefs in which to search for the element described by the given ModelElementTypeFinder.ModelElementDescription. Filtering this full list will be done by this method in accordance to the type defined by searchType

elementDescription - the ModelElementTypeFinder.ModelElementDescription that describes the element for which the EObject should be found in the list of Typedefs

searchType - the specific type of Typedef to look for: one of ModelElementTypeFinder.ClassType

Returns:

an EObject if this object is part of the given list of Typedefs and matches the element described by the given ModelElementTypeFinder.ModelElementDescription null otherwise.

processCompoundElements

private org.eclipse.emf.ecore.EObject processCompoundElements(de.uni_hildesheim.sse.ivml.TypedefCompound compound,
                                                              ModelElementTypeFinder.ModelElementDescription elementDescription)

isTypeDefClass

private boolean isTypeDefClass(ModelElementTypeFinder.ClassType type)

Checks whether the given ModelElementTypeFinder.ClassType describes a type definition in IVML, e.g.: Enum OrderedEnum Compound Mapping

Parameters:

type - the ModelElementTypeFinder.ClassType to check whether this is a class used in IVML to define a new type

Returns:

true if the given ModelElementTypeFinder.ClassType matches one of the types listed above. False otherwise.

getSpecificTypeDefs

private java.util.List<de.uni_hildesheim.sse.ivml.Typedef> getSpecificTypeDefs(java.util.List<de.uni_hildesheim.sse.ivml.Typedef> typeDefs,
                                                                               ModelElementTypeFinder.ClassType specificType)

Creates a sub-list of the given list of Typedefs in which only type definitions are included that provide the specific type definition described by the given ModelElementTypeFinder.ClassType.

Parameters:

typeDefs - the list of Typedefs from which a subset of specific type definitions should be returned

specificType - the specific type of Typedefs to be included in a new list.

Returns:

a sub-list of the given list of Typedefs in which only type definitions are included that provide the specific type definition described by the given ModelElementTypeFinder.ClassType. May return null if the given list of type definitions is null or empty. May return an empty list if the given list does not contain type definitions of the desired specific type.

notEmpty

private boolean notEmpty(ModelElementTypeFinder.ModelElementDescription elementDescription)

Checks whether the given ModelElementTypeFinder.ModelElementDescription is not null and all information is available (the nested Strings are not null or empty).

Parameters:

elementDescription - the ModelElementTypeFinder.ModelElementDescription to check

Returns:

true if the given ModelElementTypeFinder.ModelElementDescription is not null and all information is available. False otherwise.

getName

public java.lang.String getName(de.uni_hildesheim.sse.ivml.Project project)

Description copied from interface: IEcoreModelQuery

Returns the name of the project.

Parameters:

project - the project

Returns:

the name of project