Difference between revisions of "MoDisco/Components/QueryManager/Documentation/0.8"

Revision as of 08:05, 20 January 2010

How to create a MoDisco query set

The first step is to create a MoDisco project.

Right-click on the MoDisco project and select the "New > Other ..." button.

Select "Query Model" and press the "Next" button

Select "Query Model" and press the "Next" button

Choose a name for your model query set (My.querySet in the example) and press "Finish".

Open the "My.querySet" file and open the "Properties View"

Set the description of the query set and take care that the query set name is the same than the containing file name ("My" in the example).

Load the resources containing the meta-models used by the model queries that will be owned by the query set. To load a meta-model resource the user must use the "Load meta-model resource" action.

In this example, we choose to use the KDM meta-model.

Fill the "Associated Metamodels" field with the ePackages containing the meta-models used by the model queries that will be owned by the query set.

In this example we use the "core" package.

Right click on the ModelQuerySet element and choose the "New > Java Model Query" action to create a "Java Model Query".

Set the name, the description and the return type of the query. Set the "Implementation Class Name" field with the qualified name of the class that will contain the query's Java implementation.

Fill the "Scope" field with meta-class on which the query will be applicable.

Create the query's implementation class.

A MoDisco project is also a "Plug-in project". To be able to refer to the API of the used meta-model, we have to add the "org.eclipse.gmt.modisco.infra.query.core" plug-in and the meta-model implementation plug-in in the plug-in dependences.

Java Query implementation class must implement org.eclipse.gmt.modisco.query.core.java.IJavaModelQuery.

How to consult the MoDisco query set catalog trough the UI

If a query set model is valid, it is registered in the model query set catalog. To consult the model query set catalog, we can use the "Model Query Set" view.

To get this view select "Windows > Show view > Other ..." in the menu bar and chose "Query Set" in the list.

The "Query set" view presents the available query sets and them queries. For each query, the description model location is point out.

How to programmatically use the MoDisco query set catalog.

Here a MoDisco query API example is provided. To have more informations please refer to the JavaDoc.

import org.eclipse.emf.ecore.EObject;
import org.eclipse.gmt.modisco.infra.query.ModelQuery;
import org.eclipse.gmt.modisco.infra.query.ModelQuerySet;
import org.eclipse.gmt.modisco.infra.query.core.AbstractModelQuery;
import org.eclipse.gmt.modisco.infra.query.core.ModelQuerySetCatalog;
import org.eclipse.gmt.modisco.infra.query.runtime.ModelQueryResult;
public class Example {

	public Integer main(EObject context) throws Exception {
 		//Get the model query set catalog.
		ModelQuerySetCatalog catalog = ModelQuerySetCatalog.getSingleton(); 
		//Get the query set named "My".
		ModelQuerySet modelQuerySet = catalog.getModelQuerySet("My");
		//Select into the "My" query set a query named "myQuery".
		//modelQueryDescription is a model element.
		ModelQuery modelQueryDescription = null;
		for (ModelQuery modelQuery : modelQuerySet.getQueries()) {
			if (modelQuery.getName().equals("myQuery")) {
				modelQueryDescription = modelQuery;
				break;
			}
		}
		if (modelQueryDescription == null) {
			throw new Exception();
		}
		//Get a java instance of the querySet
		AbstractModelQuery myModelQuery = catalog
				.getModelQueryImpl(modelQueryDescription);
		//the model query set evaluation
		ModelQueryResult result = myModelQuery.evaluate(context);
		if (result.getException() != null) {
			throw new Exception();
		}
		return (Integer) result.getValue();
	}
}

Query Meta-model Description

ModelQuerySet is the root of query model. One root per query model is expected.

ModelQuerySet::name must be unique (in the Eclipse platform) and equal to the containing file name. We recommend to use a name prefix with a name space, for example: org.eclipse.gmt.modisco.example1.querySet1.

ModelQuerySet::isEditable is true if the query can be edited. If the query is stored into a compiled file ModelQuerySet::isEditable is false.

ModelQuerySet::getQuery(EString) returns the contained ModelQuery having the requested name.

ModelQuerySet::associatedMetamodels points to the meta-models used by the contained queries.

ModelQuerySet::queries refers to the contained queries.

ModelQuery is an abstract class representing a query.

ModelQuery::name is the query name. In each query set the query names must be unique.

ModelQuery::parameters a set of ModelQueryParameter instance describing the query parameters.

ModelQuery::returnType is an ecore::DataType representing the query return type.

ModelQuery::scope is the set of type on which the query is applicable. Those types are represented by ecore::DataType instances.

ModelQueryParameter is a class representing the query parameters.

ModelQueryParameter::type is an ecore::DataType representing the query parameter type.

ModelQueryParameter::name is the parameter name. In each query the parameter names must be unique.

ModelQuery::isExternalContextDependent must be true if two evaluations of the same query with the same context and parameters can return different results.

JavaModelQuery is a sub class of ModelQuery which points to a Java implemented query.

JavaModelQuery::implemenationClassName contains the qualified name of the class implementing the query. This class must be a sub class of org.eclipse.gmt.modisco.infra.query.core.java.IJavaModelQuery. The Java implementation class must be stored in the same plug-in (or plug-in project) than the query model.

OCLModelQuery::query is the OCL query string.

JXPath Queries

JXPath Meta-model Extension Description

An JXPathModelQuery is a ModelQuery describing a JXPath expression.

The JXPath expression are stored into the JXPathModelQuery::query attribure.

Example

The jxpathQueryTest.querySet model provide an example of JXPath query. The JXPathQuery stored into jxpathQueryTest.querySet returns the name of the EPackage passed in the query context.