EMF Search

From Eclipsepedia

Jump to: navigation, search

Project website at Eclipse [1]

Contents

Concept

EMF Search will provide 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 "organizaton", 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 at all, lets keep in mind a model search query always need 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, textual, scriptical,programatic 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 Entites Overview]

This brief explanation just made main concepts appearing : Model Search Scope, Model Search Participants, Model Search Query, Model Search Engine, Model Search Results.

   * Model Search Engine:
   EMF Search has extension point allowing user to contribute custom model search engines
   (see org.eclipse.emf.search.modelSearchEngine extension point definition).
   A model search engine has responsability, given a model resource scope,
   to evaluate a model search query applying only on a set of selected meta-elements (called meta-elements participants).
   * Model Search Query
   EMF Search offers extensible model search queries mechanism.
   Users can contribute model search queries potentially combined with any numbers of diferent elements particpants.
   (eg. given the fact different user defined elements extends 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 UI point of view)
   and the, associating it to an existing model search engine.
   * Model Search Particiants
   EMF Search offers extensible model search participants elements mechanism.
   Users can contribute model search participants potentially combined with any numbers of diferent 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 UI point of view) and, associating it to an existing model search engine.
   * Model Search Scope
   Model Search Scope stands for a set of ecore resources to be considerer 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, user can search into the whole workspace or reduce its scope to selected resources, 
   selected projects or even 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 reult entries of top level reult object. 
   These matches are considered as Model Search Result and will populate the Eclipse Search View.

Eclipse Search Integration

Eclipse Search Ecore Integration

Ecore Search Page have two main query kinds : Textual & OCL

  • Textual queries
    • normal (?, * available)
    • case sensitive
    • regex (Java regular expression based)


Textual queries are very similar to JDT, PDE or File ones. Query evaluation is done against meta elemnt names as users can see in Ecore editors. Thanks to the fact Most Ecore elements are inheriting from ENamedElement, exposing a usefull getName:String method, it is possible evaluate regex pattern against them.


  • OCL queries

OCL queries for Ecore are simple OCL invariants evaluations, these queries are ran against a particular meta element. OCL contextual edition is allowed according to a meta element user selection. Thus, users wanting to evaluate invariant expression against an EClass would have to set the OCL Expression wigdet context set to 'EClass' before being able to edit the invariant body.


As a result an OCL query expression body can take advantage of syntax coloring & contextual completion proposal.


Ecore Textual Search

Ecore Textual Search Page is composed of two parts : query & participants.


  • Query : Textual expression edit area with normal, case sentitive & regex support
  • Participants : All Ecore meta elements possibly particpating to Ecore Textual query


The figure below depict a user textual query against selected participant meta elements.

Here, the user want find all EClass elements with name matching "Movie*" regex.

Note that the search scope can be chosen between Workspace, Selected, Resource, Working Set.

Note also that query participants can be filtered in order to ease elements selection user experience.


Ecore Textual Search Page


Ecore Results page collects and display matches for Ecore queries. An header label summarize the query configuration in terms of expression, participants and scope.


Matches are display in black, hierarchical intermediary results are colored in gray and get number of match occurences their sub tree owns.


Ecore Textual Result Page

Ecore OCL Search

OCL queries for Ecore are simple OCL invariants evaluations, these queries are ran against a particular meta element. OCL contextual edition is allowed according to a meta element user selection.


Thus, users wanting to evaluate invariant expression against an EClass would have to set the OCL Expression wigdet context set to 'EClass' before being able to edit the invariant body.


As a result an OCL query expression body can take advantage of syntax coloring & contextual completion proposal.


Below we can see the completion proposal list obtained by hitting "Ctrl+Space" from the OCL Expression widget.


Ecore OCL Search Page


Results are collected and displayed accordingly to the resource & OCL invariant they have been evaluated against.


Ecore OCL Result Page

EMF Search Replace

Replace infrastructure is offered. It allows users to replace a match occurence by a given text.

Normal & Case Sensitive queries replace the whole matched occurence. Regex queries replace only the region matched with given text.

It is planned to improve replace infrastructure to offer full regex replace support.


Ecore Regex Replace Parametrization


Once, user gave a new value to replace occurences with, a dialog pops up proposing to apply or not changes.


Ecore Regex Replace Discrimination

UML2 Search Integration

UML2 Search is a kind of enhanced sample example demonstrating extensibilty of EMF Search framework. It has same features has Ecore ones by extesnion and add some UML specific ones.

Textual queries are against NamedElement objects. OCL Queries are ran against any ModelElement.


UML2 Textual Search Page


Results are collected in a dedicated result page, offering custom actions and navigation.


UML2 Textual Result Page

GenModel Search Integration

GenModel is basically an Ecore model for Ecore generation. Thus, it was a natural candidate for an EMF Search integration.

GenModel elements are pretty similar to those defined in Ecore meta model. Search page has a simple textual expression area. GenModel extension of the EMF Search framework is very similar to the UML2 one. They are all inheriting from the Ecore one.


GenModel Textual Search Page

GenModel Navigation

Reuslts are displayed in a very similar form then Ecore or UML2 ones.


GenModel Textual Result Page


Results allow to perform code generation actions as in the EMF genmodel legacy editor.


[[Image:GenModelResultPageGenerationActions.png


]]GenModel owns information enough to generate code *AND* navigate to source.


GenModel Textual Result Navigation To Java Code Action


User can come back to legacy genmodel editor at any time.


GenModel Textual Result Page Navigation To Ecore Element

Developer Guide

Introduction

Developers have several levels/contexts/persitences configurations for which they want to use EMF Search.

One aspect is which modeling level they want their extension to address :

  • meta modeling level
    • Ecore meta-modeling (M3)
    • UML2 meta-modeling or custom meta-models (M2)
    • Model instance (M1)


Another aspect is where and how their meta models are stored :

  • meta model perstistence layer type
    • Eclipse Resources
    • Local File System
    • WWW distant resources (Close to be supported)
    • DB persitence (Support planned)


Depending on these particular situations, EMF Search typical usages exist.

Search Scope & Visitors

EMF Search defines a Scope API contract with IModelSearchScope :

public interface IModelSearchScope

{ List<P> getParticipants(); void addParticipant(P resource); void addParticipants(P[] resources); void removeParticipant(P resource); void removeParticipants(P[] resources); List<P> findPartcipant(Class<O> clazz); String getLabel(); }

  • Eclipse Workspace resource
  • Local File System
  • Distant locations (Http URIs)
  • EE repositories

Ecore Query & Helper

Custom Queries & Helper

Extensibility

[EMF Search Framework Extensibility Example]

EMF Search Core Extension Points

[Model Search Engine]

EMF Search UI Extension Points

[Model Search Engine Mapping]

[Model Result Page Action]

[Model Result Page Menu]

[Model Search Participant Tab]

[Model Search Query Tab]

[Open Diagram Participants]

EMF Search OCL Extension Points

[OCL Target MetaModel]