Skip to main content

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.

Jump to: navigation, search

Difference between revisions of "VIATRA/Query"

 
(72 intermediate revisions by 12 users not shown)
Line 1: Line 1:
= EMF-IncQuery Wiki Documentation =
+
{{VIATRA}}
 +
{{caution|Old information|This page is not updated anymore; for more up-to-date details look at the language specification at https://www.eclipse.org/viatra/documentation/ instead.}}
 +
= VIATRA Incremental Query Wiki Documentation =
  
These are the (work-in-progress) wiki pages for the EMF-IncQuery project. At the moment, much of the EMF-IncQuery documentation resides on IncQuery.net, this will change as the development of this wiki progresses.
+
For the query language, we reuse the concepts of graph patterns (which is a key concept in many graph transformation tools) as a concise and easy way to specify complex structural model queries. High runtime performance is achieved by adapting incremental graph pattern matching techniques based on the Rete algorithm.
  
== EMF-IncQuery User Documentation ==
+
We believe the average programmer using EMF models will like VIATRA Query for the following reasons:
* Developing Incremental Model Queries using the EMF-IncQuery Tooling
+
** [[EMFIncQuery/UserDocumentation/Installation|Installing EMF-IncQuery]]
+
** [[EMFIncQuery/UserDocumentation/QueryLanguage|A Short Introduction to the Query Language]]
+
** [[EMFIncQuery/UserDocumentation/RETE_Visualizer|RETE Visualizer]]
+
* Using the EMF-IncQuery Runtime library
+
** [[EMFIncQuery/UserDocumentation/HeadlessExecution|Headless (standalone) execution of EMF-IncQuery queries and unit tests]]
+
** [[EMFIncQuery/UserDocumentation/API|API documentation]]
+
** [[EMFIncQuery/UserDocumentation/API/Advanced|Advanced API features]]
+
** [[EMFIncQuery/UserDocumentation/API/RunOnce|Run once querying API documentation]]
+
** [[EMFIncQuery/UserDocumentation/API/BaseIndexer|IncQuery Base Indexer]]
+
** [[EMFIncQuery/UserDocumentation/AdvancedPatterns|Advanced pattern language constructs]]
+
* Integration Components
+
** [[EMFIncQuery/UserDocumentation/Databinding|Databinding]]
+
** [[EMFIncQuery/UserDocumentation/Validation|Validation Framework]]
+
** [[EMFIncQuery/UserDocumentation/Query_Based_Features|Defining Query-based Features]]
+
** [[EMFIncQuery/UserDocumentation/IncQuery_Viewers|IncQuery Viewers]]
+
* [[EMFIncQuery/UserDocumentation/Examples|Examples]]
+
  
The original version of these guides were maintained in [http://incquery.net/incquery/documentation incquery.net]. Most content is already migrated to the Eclipse wiki.
+
* declarative queries can be evaluated over EMF without manually traversing the models,
 +
* complex interrelated constellations of EMF objects can be easily formulated as a graph pattern,
 +
** the language is expressive and provides powerful features such as negation or counting,
 +
** graph patterns are composable and reusable,
 +
** queries can be evaluated with great freedom, i.e. input and output parameters can be selected at run-time,
 +
** some frequently encountered shortcomings of EMF’s interfaces are addressed:
 +
** easy and efficient enumeration of all instances of a class regardless of location,
 +
** simple backwards navigation along all kinds of references (even without eOpposite)
 +
** finding objects based on attribute value,
 +
* the incremental query evaluation mechanism offers a significant performance boost when frequently querying complex structural patterns with a moderate amount of modifications in-between (e.g. during continuous validation),
 +
* from the declarative representation of queries, pattern matcher code is generated which can be distributed as Eclipse plug-ins with very few dependencies.
  
== Contributors Guide ==
 
  
* [[EMFIncQuery/DeveloperDocumentation|Developer's Documentation]]
+
== VIATRA Query User Documentation ==
** [[EMFIncQuery/DeveloperDocumentation/DevEnvironment|Setting up the Development Environment]]
+
* Developing Incremental Model Queries using the VIATRA Query Tooling
** [[EMFIncQuery/DeveloperDocumentation/BuildConfig|The EMF-IncQuery Build Configuration]]
+
** [https://www.eclipse.org/viatra/documentation/tutorial.html Getting started with Query Development]
* Documentation
+
** [[VIATRA/Query/UserDocumentation/QueryLanguage|A Short Introduction to the Query Language]]
** [[EMFIncQuery/DeveloperDocumentation/Model_connectors|Model Connectors]]
+
** Advanced topics
** [[EMFIncQuery/DeveloperDocumentation/IncQuery_Viewers|IncQuery Viewers]]
+
*** [[VIATRA/Query/UserDocumentation/AdvancedPatterns|Advanced pattern language constructs (incl. recursion)]]  
** [[EMFIncQuery/DeveloperDocumentation/EventDrivenVM|Event-driven Virtual Machine]]
+
*** [[VIATRA/Query/UserDocumentation/SDK/QueryHotspotTesting|Finding query evaluation hotspots]] (since 1.0.0)
** [[EMFIncQuery/DeveloperDocumentation/Builder|Builder Architecture]]
+
*** [[VIATRA/Query/UserDocumentation/QueryTestFramework|Query Test Framework]]
** [[EMFIncQuery/DeveloperDocumentation/IncQueryXcore|Notes on IncQuery & Xcore integration]]
+
*** [[VIATRA/Query/UserDocumentation/DebuggerTooling|VIATRA Query Debugger Tooling]] (since 0.8.0)
** [[EMFIncQuery/DeveloperDocumentation/Debug|EMF-IncQuery Debugger Tooling]]
+
*** [[VIATRA/Query/UserDocumentation/RETE_Visualizer|RETE Visualizer]]
* Developer Meeting Minutes
+
*** [[VIATRA/Query/UserDocumentation/LocalSearch_DebuggerTooling|Local Search Debugger Tooling]]
** [[EMFIncQuery/DeveloperMeetingMinutes|Meeting minutes]]
+
* Using the VIATRA Query Runtime library
 
+
** [[VIATRA/Query/UserDocumentation/API|API documentation]]
The original version of these guides were maintained in [http://incquery.net/incquery/devguide incquery.net]. Most content is already migrated to the Eclipse wiki.
+
** [[VIATRA/Query/UserDocumentation/API/LocalSearch|Local Search Support]]
 
+
** [[VIATRA/Query/UserDocumentation/API/BaseIndexer|Base Indexer]]
== Releases ==
+
** [[VIATRA/Query/UserDocumentation/API/Advanced|Advanced API features]]
* Version 0.7.0
+
** [[VIATRA/Query/UserDocumentation/API/RunOnce|Run once querying API documentation]]
** [[EMFIncQuery/Releases/MigrateTo0.7|Migration guide]]
+
** [[VIATRA/Query/UserDocumentation/HeadlessExecution|Headless (standalone) execution of VIATRA queries and unit tests]]
** [[EMFIncQuery/Releases/KnownIssuesFor0.7.1|Known issues affecting version 0.7.1]]
+
* Query language extensibility
* Version 0.8.0
+
** [[VIATRA/Query/UserDocumentation/PureWhitelist|Pure whitelist]] (since 1.0.0) for custom code in <code>check()</code> or <code>eval()</code>
** [[EMFIncQuery/Releases/NewAndNoteWorthy0.8|New and Noteworthy]]
+
** [[VIATRA/Query/UserDocumentation/CustomAggregators|Custom aggregation operators]] (since 1.4.0)
** [[EMFIncQuery/Releases/MigrateTo0.8|Migration guide]]
+
* [[VIATRA/Query/UserDocumentation/Examples|Examples]]
 
+
* [[VIATRA/UserDocumentation/Build|VIATRA Query in CI Environments (Maven artifacts)]] (since 0.8.0)
[[Category:EmfIncQuery]]
+
* [[VIATRA/Query/FAQ|Frequently Asked Questions]]

Latest revision as of 09:38, 30 November 2017

Stop.png
Old information
This page is not updated anymore; for more up-to-date details look at the language specification at https://www.eclipse.org/viatra/documentation/ instead.

VIATRA Incremental Query Wiki Documentation

For the query language, we reuse the concepts of graph patterns (which is a key concept in many graph transformation tools) as a concise and easy way to specify complex structural model queries. High runtime performance is achieved by adapting incremental graph pattern matching techniques based on the Rete algorithm.

We believe the average programmer using EMF models will like VIATRA Query for the following reasons:

  • declarative queries can be evaluated over EMF without manually traversing the models,
  • complex interrelated constellations of EMF objects can be easily formulated as a graph pattern,
    • the language is expressive and provides powerful features such as negation or counting,
    • graph patterns are composable and reusable,
    • queries can be evaluated with great freedom, i.e. input and output parameters can be selected at run-time,
    • some frequently encountered shortcomings of EMF’s interfaces are addressed:
    • easy and efficient enumeration of all instances of a class regardless of location,
    • simple backwards navigation along all kinds of references (even without eOpposite)
    • finding objects based on attribute value,
  • the incremental query evaluation mechanism offers a significant performance boost when frequently querying complex structural patterns with a moderate amount of modifications in-between (e.g. during continuous validation),
  • from the declarative representation of queries, pattern matcher code is generated which can be distributed as Eclipse plug-ins with very few dependencies.


VIATRA Query User Documentation

Back to the top