Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "MoDisco/Components/QueryManager/Architecture"
(add references to org.eclipse.team) |
(→Implementation) |
||
| Line 1: | Line 1: | ||
{{MoDiscoTabs|QueryManager|0|1}} | {{MoDiscoTabs|QueryManager|0|1}} | ||
| − | + | This is a draft. | |
==Use cases== | ==Use cases== | ||
| Line 28: | Line 28: | ||
** createModelQuerySet() | ** createModelQuerySet() | ||
** editModelQuerySet() | ** editModelQuerySet() | ||
| + | ** save() | ||
* ModelQuerySetCatalog | * ModelQuerySetCatalog | ||
** addQuerySet() | ** addQuerySet() | ||
| Line 45: | Line 46: | ||
== Implementation == | == Implementation == | ||
| + | |||
=== org.eclipe.gmt.modisco.infra.query.core === | === org.eclipe.gmt.modisco.infra.query.core === | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
=== org.eclipe.gmt.modisco.infra.query.editor === | === org.eclipe.gmt.modisco.infra.query.editor === | ||
| Line 60: | Line 56: | ||
'''Scope:''' This wizard can be called using a popup menu on ''the main menu, package explorer, navigator, etc.''. If a project was selected, it is automatically chosen in the wizard. This wizard can also be called from the query panel of the "Query Execution" view | '''Scope:''' This wizard can be called using a popup menu on ''the main menu, package explorer, navigator, etc.''. If a project was selected, it is automatically chosen in the wizard. This wizard can also be called from the query panel of the "Query Execution" view | ||
| − | '''Implementation classes:''' | + | '''Implementation classes:''' |
====Properties view==== | ====Properties view==== | ||
| Line 85: | Line 81: | ||
=== Summary === | === Summary === | ||
| + | |||
{{CTable|tableWidth=64%}} | {{CTable|tableWidth=64%}} | ||
| Line 91: | Line 88: | ||
| ModelQuerySetEditor::createModelQuerySet() || Wizard "New QuerySet model" | | ModelQuerySetEditor::createModelQuerySet() || Wizard "New QuerySet model" | ||
|- | |- | ||
| − | | | + | | ModelQuerySet::addQuery() || Wizard "Create Query Wizard" |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
|- | |- | ||
| ModelQuery::editQuery() || Query property view | | ModelQuery::editQuery() || Query property view | ||
|- | |- | ||
| ModelQuery::evaluate || "Query Execution" view | | ModelQuery::evaluate || "Query Execution" view | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| MetaClass::addQuery || | | MetaClass::addQuery || | ||
|- | |- | ||
|} | |} | ||
Revision as of 08:53, 19 February 2010
| MoDisco |
| Website |
| Download |
| Community |
| Mailing List • Forums |
| Bugzilla |
| Open |
| Help Wanted |
| Bug Day |
| Contribute |
| Browse Source • Project Set File |
This is a draft.
Use cases
This document assumes that:
- A user is the actor which uses the query manager
- A developer is a kind of user which creates queries.
UC1 - Create query set: The developer creates a query set by declaring its identifier and the used meta-models. Each query set contains one or more queries. The developer has to add queries in the new query set (UC2)
UC2 - Add a query in a query set: The developer selects an existing query set and adds a new query in this query set. Each query has a name and this name is the query identifier. To add a model query the developer has to provide: the name, the parameters, the description and the implementation. All the model query sets are automatically detected and added into a catalog.
UC3 - Use a model query: To use a model query the user has to find it in the model query set catalog (UC5). To execute a query the user has to provide an execution context (a set of models and of model elements) and the parameter values.
UC4 - Add a query to a meta-class: The developer wants to create a query dedicated to a certain meta-class by selecting the meta-class or one of its instances. He has to choose a query set in the catalog, or create a new query set (UC1) and then create a new query.
UC5 - Find a query in the catalog: by scope, by name, by query set name, by return type.
UC6 - Publish a model query: The developer publishes a query set to allow other users to install the query set in their working environment. A published and/or installed query cannot be modified by the query set user (to make sure that the published model query set will never be modified). An installed model query set is available through the model query set catalog. A published query set has a version number.
Functional specification
Actors: query developer, query user
Functional components:
- ModelQuerySetEditor
- createModelQuerySet()
- editModelQuerySet()
- save()
- ModelQuerySetCatalog
- addQuerySet()
- removeQuerySet()
- getAllModelQuerySet()
- findQueryByName()
- Sharing
- commit()
- checkout()
- ModelQuery
- evaluate
- Publisher
- publish()
- get()
- Installer
- install()
Implementation
org.eclipe.gmt.modisco.infra.query.core
org.eclipe.gmt.modisco.infra.query.editor
Wizard "New QuerySet model"
Scope: This wizard can be called using a popup menu on the main menu, package explorer, navigator, etc.. If a project was selected, it is automatically chosen in the wizard. This wizard can also be called from the query panel of the "Query Execution" view
Implementation classes:
Properties view
org.eclipe.gmt.modisco.infra.query.ui
Create Query Wizard
Scope:
- This wizard can be called from the popup menu of an existing query set.
- EClass or EObject (whose EClass will be used)
Behaviour:
- The name, parameters, implementation class, etc. are fields in this wizard. Each query type (Java, OCL, etc.) can contribute a page to this wizard, for its own specific attributes (eg: Java class, OCL query).
- The query scope is already chosen based on the selection.
Extension point:
Implementation classes:
Query execution view
Uses: query catalog ui
Summary
| Functional operation | Realization |
| ModelQuerySetEditor::createModelQuerySet() | Wizard "New QuerySet model" |
| ModelQuerySet::addQuery() | Wizard "Create Query Wizard" |
| ModelQuery::editQuery() | Query property view |
| ModelQuery::evaluate | "Query Execution" view |
| MetaClass::addQuery |