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 "EMF Search"
(→Quick Start Guide) |
(Indicated the is scheduled for termination.) |
||
| (28 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | Project website at | + | The project has been "inactive for many years" and is scheduled for termination. See [http://wiki.eclipse.org/Modeling/project_termination_review_2012#Search]. |
| + | Project website is at [http://www.eclipse.org/emft/projects/search/#search]. | ||
== Concept == | == Concept == | ||
| Line 7: | Line 8: | ||
EMF Search is an Ecore meta-model based extensible search engine which purpose is to provide users query launching services against Ecore based models. | EMF Search is an Ecore meta-model based extensible search engine which purpose is to provide users query launching services against Ecore based models. | ||
| − | Meta-model based search is basically being able to take advantage of a meta-model structure to run generic search queries onto it. This means that a meta-model structure, defining a minimal modeling " | + | Meta-model based search is basically being able to take advantage of a meta-model structure to run generic search queries onto it. This means that a meta-model structure, defining a minimal modeling "organization", contains information enough to get operations applied to it, and by extension having same operations applied to any inheriting model compliant with this meta-model structure. Ecore based search is in fact a particular case of meta-model based treatment, a typical approach also known as Model Driven Architecture. |
In other words, this allows to develop meta-model based generic algorithms, valid across any user defined model extending elements & structure of a given meta-model. Such method are usually employed as part of a code generation development process also known as Model Driven Development, allowing developers to code things once, setting up templates based code generation getting its data from the particular valuation of an instance of a given meta-model (eg: An actual user defined model or domain model populated with pertinent data). | In other words, this allows to develop meta-model based generic algorithms, valid across any user defined model extending elements & structure of a given meta-model. Such method are usually employed as part of a code generation development process also known as Model Driven Development, allowing developers to code things once, setting up templates based code generation getting its data from the particular valuation of an instance of a given meta-model (eg: An actual user defined model or domain model populated with pertinent data). | ||
| Line 13: | Line 14: | ||
== Terminology == | == Terminology == | ||
| − | For model search explanatory purposes, we need to introduce some terminology. First | + | For model search explanatory purposes, we need to introduce some terminology. First of all, let's keep in mind that a model search query always needs to deal with entities such as a scope of model resource(s)/element(s) onto which a search query will apply, a set of participant meta-elements which the search query will consider, and finally a search query, whether textual, scriptical or programmatic, which an associated model search engine will evaluate against a scope and participants. This evaluation obviously having the role to produce Model Search Results. |
| − | [EMF Model Search Query | + | [[Image:EMFModelSearchQueryClassDiagram.png|EMF Model Search Query Entities Overview]] |
| − | This brief explanation just made main concepts appearing : Model Search Scope, Model Search Participants, Model Search Query, Model Search Engine, Model Search Results. | + | This brief explanation just made main concepts appearing : Model Search Scope, Model Search Participants, Model Search Query, Model Search Engine, and Model Search Results. |
| − | + | === Model Search Engine === | |
| − | + | EMF Search has an extension point allowing a user to contribute custom model search engines | |
| − | + | (see <code>org.eclipse.emf.search.modelSearchEngine</code> extension point definition). | |
| − | + | ||
| − | + | ||
| − | + | A model search engine has responsibility, given a model resource scope, | |
| − | + | to evaluate a model search query applying only on a set of selected meta-elements (called meta-element participants). | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | === Model Search Query === | |
| − | + | EMF Search offers an extensible mechanism for model search queries. | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | Users can contribute model search queries potentially combined with any number of different element participants. | |
| − | + | (eg. given the fact that different user defined elements extend Ecore meta-elements). As a result, users can register to <code>org.eclipse.emf.search.modelSearchID</code> extension their own model search queries (plus the way to handle it from the UI point of view) and then, associate it to an existing model search engine. | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | === Model Search Participants === | |
| − | + | EMF Search offers extensible model search participants elements mechanism. | |
| − | + | ||
| − | + | ||
| − | + | Users can contribute model search participants potentially combined with any numbers of different model search queries. | |
| − | + | As a result, users can register to <code>org.eclipse.emf.search.modelSearchParticipantTab</code> extension their own model search participant elements (plus the way to handle it from the UI point of view), and associate it to an existing model search engine. | |
| − | + | === Model Search Scope === | |
| + | Model Search Scope stands for a set of ecore resources to be considered by the search query. | ||
| − | + | We can make a comparison with platform search concepts from the scope point of view. | |
| − | + | As in the text search or java search, a user can search into the whole workspace or reduce its scope to selected resources, selected projects or even a given working set. | |
| − | + | ||
| − | + | ||
| + | === Model Search Result === | ||
| + | Query evaluation produces matches, being collected in a result object or each resource evaluated. | ||
| + | Matches can be considered as result entries of top level result object. | ||
| + | These matches are considered as Model Search Result and will populate the Eclipse Search View. | ||
| − | + | == Eclipse Search Integration == | |
| − | + | ||
| − | + | ||
| + | === Eclipse Search Ecore Integration === | ||
| − | + | [[EMF_Search---Ecore_Integration|Ecore Search Feature Tour]] | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | [[ | + | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
=== EMF Search Replace === | === EMF Search Replace === | ||
| − | + | [[EMF_Search---Replace_Integration|EMF Search Replace Feature Tour]] | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | [[ | + | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
=== UML2 Search Integration === | === UML2 Search Integration === | ||
| − | + | [[EMF_Search---UML2_integration|UML2 Search Feature Tour]] | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | [[ | + | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
=== GenModel Search Integration === | === GenModel Search Integration === | ||
| − | + | [[EMF_Search---GenModel_Integration|GenModel Search Feature Tour]] | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | [[ | + | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
=== Custom Textual Search Code Generation === | === Custom Textual Search Code Generation === | ||
| − | + | [[EMF_Search---Custom_Textual_Search_Generation|Custom Textual Search Generation Feature Tour]] | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | [[ | + | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
=== Misc EMF Search Based Tooling === | === Misc EMF Search Based Tooling === | ||
| − | + | [[EMF_Search---Misc_SearchBased_Tooling|Miscellaneous Search Based Tooling Panorama]] | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | [[ | + | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
== Quick Start Guide == | == Quick Start Guide == | ||
| − | + | [[EMF_Search---Quick_Start_Guide|Quick Start : Movies DB Example Tutorial]] | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
== Developer Guide == | == Developer Guide == | ||
| − | + | [[EMF_Search---Developer_Guide|How To Efficiently Use EMF Search APIs And Extension Points]] | |
| − | + | == Extensibility == | |
| − | + | [[EMF_Search_Framework_Extensibility---How_It_Works|How It Works]] | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | [[ | + | [[EMF_Search_Framework_Extensibility|EMF Search Framework Extensibility Example]] |
=== EMF Search Core Extension Points === | === EMF Search Core Extension Points === | ||
| − | [[ | + | [[EMF_Search_Framework_Extensibility---org.eclipse.emf.search.modelSearchEngine|Model Search Engine]] |
=== EMF Search UI Extension Points === | === EMF Search UI Extension Points === | ||
| − | [[ | + | [[EMF_Search_UI_Extensibility---org.eclipse.emf.search.ui.modelSearchEngineMapping|Model Search Engine Mapping]] |
| − | [[ | + | [[EMF_Search_UI_Extensibility---org.eclipse.emf.search.ui.modelSearchPageActionContribution|Model Result Page Action]] |
| − | [[ | + | [[EMF_Search_UI_Extensibility---org.eclipse.emf.search.ui.modelSearchPageMenuContribution|Model Result Page Menu]] |
| − | [[ | + | [[EMF_Search_UI_Extensibility---org.eclipse.emf.search.ui.modelSearchParticipantTab|Model Search Participant Tab]] |
| − | [[ | + | [[EMF_Search_UI_Extensibility---org.eclipse.emf.search.ui.modelSearchQueryTab|Model Search Query Tab]] |
| − | [[ | + | [[EMF_Search_UI_Extensibility---org.eclipse.emf.search.ui.openDiagramParticipants|Open Diagram Participants]] |
=== EMF Search OCL Extension Points === | === EMF Search OCL Extension Points === | ||
| − | [[ | + | [[EMF_Search_OCL_Extensibility---org.eclipse.emf.search.ocl.targetMetaModel|OCL Target MetaModel]] |
Latest revision as of 10:40, 27 September 2012
The project has been "inactive for many years" and is scheduled for termination. See [1]. Project website is at [2].
Contents
Concept
EMF Search provides the fundamental infrastructure and components for search queries on EMF based models. A particular focus is made on integration with the Eclipse Core Search API for end user tight integration.
EMF Search is an Ecore meta-model based extensible search engine which purpose is to provide users query launching services against Ecore based models.
Meta-model based search is basically being able to take advantage of a meta-model structure to run generic search queries onto it. This means that a meta-model structure, defining a minimal modeling "organization", contains information enough to get operations applied to it, and by extension having same operations applied to any inheriting model compliant with this meta-model structure. Ecore based search is in fact a particular case of meta-model based treatment, a typical approach also known as Model Driven Architecture.
In other words, this allows to develop meta-model based generic algorithms, valid across any user defined model extending elements & structure of a given meta-model. Such method are usually employed as part of a code generation development process also known as Model Driven Development, allowing developers to code things once, setting up templates based code generation getting its data from the particular valuation of an instance of a given meta-model (eg: An actual user defined model or domain model populated with pertinent data).
Terminology
For model search explanatory purposes, we need to introduce some terminology. First of all, let's keep in mind that a model search query always needs to deal with entities such as a scope of model resource(s)/element(s) onto which a search query will apply, a set of participant meta-elements which the search query will consider, and finally a search query, whether textual, scriptical or programmatic, which an associated model search engine will evaluate against a scope and participants. This evaluation obviously having the role to produce Model Search Results.
This brief explanation just made main concepts appearing : Model Search Scope, Model Search Participants, Model Search Query, Model Search Engine, and Model Search Results.
Model Search Engine
EMF Search has an extension point allowing a user to contribute custom model search engines
(see org.eclipse.emf.search.modelSearchEngine extension point definition).
A model search engine has responsibility, given a model resource scope, to evaluate a model search query applying only on a set of selected meta-elements (called meta-element participants).
Model Search Query
EMF Search offers an extensible mechanism for model search queries.
Users can contribute model search queries potentially combined with any number of different element participants.
(eg. given the fact that different user defined elements extend Ecore meta-elements). As a result, users can register to org.eclipse.emf.search.modelSearchID extension their own model search queries (plus the way to handle it from the UI point of view) and then, associate it to an existing model search engine.
Model Search Participants
EMF Search offers extensible model search participants elements mechanism.
Users can contribute model search participants potentially combined with any numbers of different model search queries.
As a result, users can register to org.eclipse.emf.search.modelSearchParticipantTab extension their own model search participant elements (plus the way to handle it from the UI point of view), and associate it to an existing model search engine.
Model Search Scope
Model Search Scope stands for a set of ecore resources to be considered by the search query.
We can make a comparison with platform search concepts from the scope point of view. As in the text search or java search, a user can search into the whole workspace or reduce its scope to selected resources, selected projects or even a given working set.
Model Search Result
Query evaluation produces matches, being collected in a result object or each resource evaluated. Matches can be considered as result entries of top level result object. These matches are considered as Model Search Result and will populate the Eclipse Search View.
Eclipse Search Integration
Eclipse Search Ecore Integration
EMF Search Replace
EMF Search Replace Feature Tour
UML2 Search Integration
GenModel Search Integration
Custom Textual Search Code Generation
Custom Textual Search Generation Feature Tour
Misc EMF Search Based Tooling
Miscellaneous Search Based Tooling Panorama
Quick Start Guide
Quick Start : Movies DB Example Tutorial
Developer Guide
How To Efficiently Use EMF Search APIs And Extension Points
Extensibility
EMF Search Framework Extensibility Example