Jump to: navigation, search

Difference between revisions of "OCL"

(Documentation, Publications and FAQs)
(Downloads and Updates)
 
(38 intermediate revisions by 2 users not shown)
Line 13: Line 13:
  
 
* Provides an Interactive OCL Console to evaluate queries on models.
 
* Provides an Interactive OCL Console to evaluate queries on models.
* Provides an [[MDT/OCLinEcore | OCLinEcore]] [[Xtext]] editor for OCL embedded in an Ecore meta-model.
+
* Provides an [[OCL/OCLinEcore | OCLinEcore]] [[Xtext]] editor for OCL embedded in an Ecore meta-model.
 
* Provides a CompleteOCL editor for an OCL document complementing a meta-model.
 
* Provides a CompleteOCL editor for an OCL document complementing a meta-model.
 
* Provides an EssentialOCL editor for individual OCL expressions.
 
* Provides an EssentialOCL editor for individual OCL expressions.
  
The grammars for the Xtext-based editors auto-generate ANTLR parsers. In MDT/OCL 3.0, the ANTLR parsers are used solely within the editors. As from MDT/OCL 3.1 the Xtext grammars and parsers provide full evaluation and validation capabilities too. Since the Xtext grammars are associated with a re-engineering to support a model-defined standard library and full OMG compliance, the original LPG parser will be increasingly deprecated.
+
The grammars for the Xtext-based editors auto-generate ANTLR parsers. In Eclipse OCL 3.0, the ANTLR parsers are used solely within the editors. As from Eclipse OCL 3.1 the Xtext grammars and parsers provide full evaluation and validation capabilities too. Since the Xtext grammars are associated with a re-engineering to support a model-defined standard library and full OMG compliance, the original LPG parser will be increasingly deprecated.
  
 
== Downloads and Updates ==
 
== Downloads and Updates ==
  
Eclipse OCL Downloads are available via the [http://www.eclipse.org/modeling/mdt/downloads/?project=ocl Project Downloads] page.
+
=== For Users ===
  
Eclipse OCL Updates are available at http://download.eclipse.org/modeling/mdt/ocl/updates and from the Modeling category of the main http://download.eclipse.org/releases/indigo/ Update Site. The ''OCL End User SDK'' feature supports OCL in conjunction with Ecore or UML meta-models. The ''OCL Examples and Editors'' feature additionally provides an IDE comprising Xtext-based editors and an Interactive Console.
+
Eclipse OCL may be installed directly from the main Eclipse http://download.eclipse.org/releases/neon/ Update Site.
 +
* ''Help''->''Install New Software...''
 +
* ''Works with:'' Neon - http://download.eclipse.org/releases/neon
 +
* Select ''Modeling''->''OCL Examples and Editors SDK''
 +
or from an OCL-specific site: http://download.eclipse.org/modeling/mdt/ocl/updates. The Eclipse OCL Repositories and Updates for Milestone, Interim and Nightly builds are described in [[OCL/Dev/Releng/P2_Repositories_Organization | P2 Repositories Organization]] and retained in accordance with the [[OCL/Dev/Policies#Retention_Policy | Retention Policy]].
  
Eclipse OCL Repositories and Updates for Milestone, Interim and Nightly builds are described in [[MDT/OCL/Dev/Releng/P2_Repositories_Organization | P2 Repositories Organization]] and retained in accordance with the [[MDT/OCL/Dev/Policies#Retention_Policy | Retention Policy]].
+
The ''OCL Examples and Editors SDK'' feature provides the full IDE comprising Xtext-based editors, Interactive Console, Debugger and Java Code Generator all using the new Unified Pivot -based OCL.
  
Eclipse OCL source code is available from git://git.eclipse.org/gitroot/mdt/org.eclipse.ocl.git and [https://github.com/eclipse/ocl/network github Network].
+
The ''OCL End User SDK'' feature provides the Classic OCL support with distinct Ecore and UML APIs.  
  
Eclipse OCL has [https://bugs.eclipse.org/bugs/buglist.cgi?query_format=advanced;bug_status=UNCONFIRMED;bug_status=NEW;bug_status=ASSIGNED;bug_status=REOPENED;component=OCL;product=MDT;classification=Modeling Open Bugs] and a [news://new.eclipse.org:119/eclipse.modeling.mdt.ocl newsgroup] or [http://www.eclipse.org/forums/eclipse.modeling.mdt.ocl forum].
+
Eclipse OCL may be installed indirectly by downloading an archive ZIP from [http://www.eclipse.org/modeling/mdt/downloads/?project=ocl Project Downloads] and then using the downloaded ZIP as the ''Works with'' site for ''Help''->''Install New Software...''
  
== Documentation, Publications and [[MDT/OCL/FAQ|FAQs]] ==
+
Eclipse OCL has [https://bugs.eclipse.org/bugs/buglist.cgi?query_format=advanced;bug_status=UNCONFIRMED;bug_status=NEW;bug_status=ASSIGNED;bug_status=REOPENED;product=MDT.OCL;classification=Modeling Open Bugs] and a [news://new.eclipse.org:119/eclipse.modeling.mdt.ocl newsgroup] or [http://www.eclipse.org/forums/eclipse.modeling.mdt.ocl forum]. See the [[OCL/ForumNetiquette | OCL Forum Netiquette]].
 +
 
 +
=== For Developers ===
 +
 
 +
An Eclipse OCL development environment may be created automatically using the [https://wiki.eclipse.org/Eclipse_Installer OOMPH] Eclipse Installer. Follow the OOMPH instructions to first create an Eclipse installation with a Java VM, then invoke ''File''->''Import Projects''->''Oomph''->''Projects into Workspace''->''Eclipse Projects''->''OCL''->''Development''. After a few minutes the required dependencies have been downloaded and a restart is required. Then after a few tens of minutes the required GIT repositories have been cloned and you are ready to go; there should be no errors in the ''Problems View''. You may wish to select ''Working Sets'' as the top level elements in the ''Package Explorer''. You may ''Run''->''Run Configurations...''->''JUnit''->''org.eclipse.ocl.examples.xtext.tests (standalone)'' to demonstrate that the standard tests are passing.
 +
 
 +
Alternatively an Eclipse OCL development environment may be created manually using the Eclipse OCL source code from git://git.eclipse.org/c/ocl/org.eclipse.ocl.git, [http://git.eclipse.org/c/ocl/org.eclipse.ocl.git http://git.eclipse.org/c/ocl/org.eclipse.ocl.git] and [https://github.com/eclipse/ocl/network github Network]. All source projects may be installed by Import...->Team->Team Project Set, then entering [http://git.eclipse.org/c/ocl/org.eclipse.ocl.git/plain/releng/org.eclipse.ocl.releng/psfs/ocl-all.psf?h=master http://git.eclipse.org/c/ocl/org.eclipse.ocl.git/plain/releng/org.eclipse.ocl.releng/psfs/ocl-all.psf?h=master] as the URL for import. Be patient; the repository clone takes a while, and there are no obvious progress indicators during the third phase while projects are actually created.
 +
 
 +
If you plan to contribute to Eclipse OCL, please have a look to the project [https://projects.eclipse.org/projects/modeling.mdt.ocl/developer Developer Resources]
 +
 
 +
== Documentation, Publications and [[OCL/FAQ|FAQs]] ==
 +
 
 +
* [[OCL/Compliance|(OMG) OCL Compliance]] and [[OCL/Limitations|(Eclipse) OCL Limitations]]
 +
* Eclipse OCL Documentation from the [http://help.eclipse.org/ Eclipse Help Center]
 +
** Neon OCL 6.1/3.6/1.1 Documentation [http://help.eclipse.org/neon/topic/org.eclipse.ocl.doc/help/OverviewandGettingStarted.html HTML] [http://download.eclipse.org/ocl/doc/6.1.0/ocl.pdf PDF]
 +
** Mars OCL 6.0/3.5/1.0 Documentation [http://help.eclipse.org/mars/topic/org.eclipse.ocl.doc/help/OverviewandGettingStarted.html HTML] [http://download.eclipse.org/ocl/doc/6.0.0/ocl.pdf PDF]
 +
** Luna OCL 5.0/3.4 Documentation [http://help.eclipse.org/luna/topic/org.eclipse.ocl.doc/help/OverviewandGettingStarted.html HTML] [http://download.eclipse.org/ocl/doc/5.0.0/ocl.pdf PDF]
 +
** Kepler OCL 4.1/3.3 Documentation [http://help.eclipse.org/kepler/topic/org.eclipse.ocl.doc/help/Overview.html  HTML]
 +
** Juno OCL 4.0/3.2 Documentation [http://help.eclipse.org/juno/topic/org.eclipse.ocl.doc/help/Overview.html  HTML]
 +
** Indigo OCL 3.1 Documentation [http://help.eclipse.org/indigo/topic/org.eclipse.ocl.doc/help/Overview.html  HTML] [[OCL/Indigo Documentation Errata| Errata]]
 +
** Helios OCL 3.0 Developer Guide [http://help.eclipse.org/helios/topic/org.eclipse.ocl.doc/help/Overview.html  HTML]
 +
* [[OCL/New_and_Noteworthy|New and Noteworthy]] features of the Eclipse OCL releases.
 +
** [[OCL/New_and_Noteworthy/Oxygen|6.3/3.7/1.3 Oxygen release (June 2017)]]
 +
** [[OCL/New_and_Noteworthy/Neon++|6.2/3.6/1.2 Neon++ release (July 2016)]]
 +
** [[OCL/New_and_Noteworthy/Neon|6.1/3.6/1.1 Neon release (June 2016)]]
 +
** [[OCL/New_and_Noteworthy/Mars|6.0/3.5/1.0 Mars release (June 2015)]]
 +
** [[OCL/New_and_Noteworthy/Luna|5.0/3.4 Luna release (June 2014)]]
 +
** [[OCL/New_and_Noteworthy/Kepler|4.1/3.3 Kepler release (June 2013)]]
 +
** [[OCL/New_and_Noteworthy/Juno|4.0/3.2 Juno release (June 2012)]]
 +
** [[OCL/New_and_Noteworthy/Indigo|3.1 Indigo release (June 2011)]]
 +
** [[OCL/New_and_Noteworthy/Helios|3.0 Helios release (June 2010)]]
 +
** [[OCL/New_and_Noteworthy/Galileo|1.3 Galileo release (June 2009)]]
 +
** [[MDT_1.1_New_and_Noteworthy#Object_Constraint_Language (OCL) Component|1.2.0 Ganymede release (June 2008)]]
 +
** [[MDT_1.0_New_and_Noteworthy#Object Constraint Language (OCL) Component|1.1.0 Europa release (June 2007)]]
  
* [[MDT/OCL/Compliance|(OMG) OCL Compliance]] and [[MDT/OCL/Limitations|(Eclipse) OCL Limitations]]
 
* [http://help.eclipse.org/ Eclipse Help Center] Current documentation
 
** [http://help.eclipse.org/juno/index.jsp?topic=%2Forg.eclipse.ocl.doc%2Fhelp%2FOverview.html&cp=46_0 Juno OCL Documentation] (select OCL Documentation in left hand frame to see content)
 
** [http://help.eclipse.org/indigo/topic/org.eclipse.ocl.doc/help/index.html Indigo OCL Documentation] [[MDT/OCL/Indigo Documentation Errata| Errata]]
 
** [http://help.eclipse.org/helios/nav/40 Helios OCL Developer Guide]
 
* [[MDT/OCL/New_and_Noteworthy|New and Noteworthy]] features of the Eclipse OCL releases.
 
 
* [http://www.eclipse.org/modeling/mdt/javadoc/#ocl Javadoc] API Reference
 
* [http://www.eclipse.org/modeling/mdt/javadoc/#ocl Javadoc] API Reference
* [[MDT/OCL/Articles|Articles and Presentations]]
+
* [[OCL/Articles|Articles and Presentations]]
* [[MDT/OCL/FAQ|Frequently Asked Questions]]
+
* [[OCL/FAQ|Frequently Asked Questions]]
  
 
== Example Code ==
 
== Example Code ==
Line 51: Line 82:
 
== Releases and Development ==
 
== Releases and Development ==
  
You may want to check the [[MDT/OCL/New_and_Noteworthy|New and Noteworthy]] features of the Eclipse OCL releases.
+
You may want to check the [[OCL/New_and_Noteworthy|New and Noteworthy]] features of the Eclipse OCL releases.
  
 
=== Planning ===
 
=== Planning ===
  
* [http://www.eclipse.org/projects/project-plan.php?planurl=http://www.eclipse.org/modeling/mdt/ocl/project-info/plan_juno.xml&component=Eclipse OCL 4.0 Juno Draft Plan]
+
* [http://www.eclipse.org/projects/project-plan.php?planurl=http://www.eclipse.org/modeling/mdt/ocl/project-info/plan_luna.xml&component=Eclipse OCL 5.0/3.4 Luna Draft Plan]
 +
* [http://www.eclipse.org/projects/project-plan.php?planurl=http://www.eclipse.org/modeling/mdt/ocl/project-info/plan_kepler.xml&component=Eclipse OCL 4.1/3.3 Kepler Plan]
 +
* [http://www.eclipse.org/projects/project-plan.php?planurl=http://www.eclipse.org/modeling/mdt/ocl/project-info/plan_juno.xml&component=Eclipse OCL 4.0/3.2 Juno Plan]
 
* [http://www.eclipse.org/projects/project-plan.php?planurl=http://www.eclipse.org/modeling/mdt/ocl/project-info/plan_indigo.xml&component=Eclipse OCL 3.1 Indigo Plan]
 
* [http://www.eclipse.org/projects/project-plan.php?planurl=http://www.eclipse.org/modeling/mdt/ocl/project-info/plan_indigo.xml&component=Eclipse OCL 3.1 Indigo Plan]
 
* [http://www.eclipse.org/projects/project-plan.php?planurl=http://www.eclipse.org/modeling/mdt/ocl/project-info/plan_helios.xml&component=Eclipse OCL 3.0 Helios Plan]
 
* [http://www.eclipse.org/projects/project-plan.php?planurl=http://www.eclipse.org/modeling/mdt/ocl/project-info/plan_helios.xml&component=Eclipse OCL 3.0 Helios Plan]
Line 62: Line 95:
 
* [http://www.eclipse.org/modeling/mdt/ocl/docs/ocl_project_plan_1_1.html R1.1 Plan]
 
* [http://www.eclipse.org/modeling/mdt/ocl/docs/ocl_project_plan_1_1.html R1.1 Plan]
  
* [[MDT/OCL/Debugger|Evaluator + Console ideas]]
+
* [[OCL/Debugger|Evaluator + Console ideas]]
  
 
=== API Changes ===
 
=== API Changes ===
Line 81: Line 114:
 
=== Development Environment ===
 
=== Development Environment ===
  
* [[MDT/OCL/Dev/Setup|Team Standard Settings and Procedures]]
+
* [[OCL/Dev/Setup|Team Standard Settings and Procedures]]
  
 
=== Release Engineering ===
 
=== Release Engineering ===
  
* [[MDT/OCL/Dev/Releng/Cheatsheet| How to Make and Publish Builds Using Athena CBI (DEPRECATED)]]
+
* [[OCL/Dev/Releng/Buckminster | How to Make and Publish Builds Using Buckminster]]
* [[MDT/OCL/Dev/Releng/Buckminster | How to Make and Publish Builds Using Buckminster]]
+
* [[OCL/Dev/Releng/ReleasesTransition | Transition between releases]]
* [[MDT/OCL/Dev/Releng/P2_Repositories_Organization| P2 Repositories Organization]]
+
* [[OCL/Dev/Releng/Quiet_Week | Quiet week]]
* [[MDT/OCL/Dev/Releng/Features_Organization| Features Organization]]
+
* [[OCL/Dev/Releng/P2_Repositories_Organization| P2 Repositories Organization]]
* [[MDT/OCL/Dev/Releng/Issues_Documentation| Issues Documentation]]
+
* [[OCL/Dev/Releng/Features_Organization| Features Organization]]
 +
* [[OCL/Dev/Releng/Issues_Documentation| Issues Documentation]]
  
 
== Related Links ==
 
== Related Links ==

Latest revision as of 04:20, 22 August 2016

The Eclipse OCL Project provides an implementation of the Object Constraint Language (OCL) OMG standard for EMF-based models.

The Core OCL component provides the following capabilities to support OCL integration:

  • Defines APIs for parsing and evaluating OCL constraints and queries on EMF models.
  • Defines Ecore and UML implementations of the OCL abstract syntax model, including support for serialization of parsed OCL expressions.
  • Provides a Visitor API for analyzing/transforming the AST model of OCL expressions.
  • Provides an extensibility API for clients to customize the parsing and evaluation environments used by the parser.

The Core OCL parser is generated by the LALR Parser Generator, a SourceForge project, licensed under the EPL v1.0. Download it from the LPG home page. This site includes the generator executable required to regenerate the parser code.

The additional OCL Examples and Editors component provides interactive support for OCL:

  • Provides an Interactive OCL Console to evaluate queries on models.
  • Provides an OCLinEcore Xtext editor for OCL embedded in an Ecore meta-model.
  • Provides a CompleteOCL editor for an OCL document complementing a meta-model.
  • Provides an EssentialOCL editor for individual OCL expressions.

The grammars for the Xtext-based editors auto-generate ANTLR parsers. In Eclipse OCL 3.0, the ANTLR parsers are used solely within the editors. As from Eclipse OCL 3.1 the Xtext grammars and parsers provide full evaluation and validation capabilities too. Since the Xtext grammars are associated with a re-engineering to support a model-defined standard library and full OMG compliance, the original LPG parser will be increasingly deprecated.

Downloads and Updates

For Users

Eclipse OCL may be installed directly from the main Eclipse http://download.eclipse.org/releases/neon/ Update Site.

or from an OCL-specific site: http://download.eclipse.org/modeling/mdt/ocl/updates. The Eclipse OCL Repositories and Updates for Milestone, Interim and Nightly builds are described in P2 Repositories Organization and retained in accordance with the Retention Policy.

The OCL Examples and Editors SDK feature provides the full IDE comprising Xtext-based editors, Interactive Console, Debugger and Java Code Generator all using the new Unified Pivot -based OCL.

The OCL End User SDK feature provides the Classic OCL support with distinct Ecore and UML APIs.

Eclipse OCL may be installed indirectly by downloading an archive ZIP from Project Downloads and then using the downloaded ZIP as the Works with site for Help->Install New Software...

Eclipse OCL has Open Bugs and a newsgroup or forum. See the OCL Forum Netiquette.

For Developers

An Eclipse OCL development environment may be created automatically using the OOMPH Eclipse Installer. Follow the OOMPH instructions to first create an Eclipse installation with a Java VM, then invoke File->Import Projects->Oomph->Projects into Workspace->Eclipse Projects->OCL->Development. After a few minutes the required dependencies have been downloaded and a restart is required. Then after a few tens of minutes the required GIT repositories have been cloned and you are ready to go; there should be no errors in the Problems View. You may wish to select Working Sets as the top level elements in the Package Explorer. You may Run->Run Configurations...->JUnit->org.eclipse.ocl.examples.xtext.tests (standalone) to demonstrate that the standard tests are passing.

Alternatively an Eclipse OCL development environment may be created manually using the Eclipse OCL source code from git://git.eclipse.org/c/ocl/org.eclipse.ocl.git, http://git.eclipse.org/c/ocl/org.eclipse.ocl.git and github Network. All source projects may be installed by Import...->Team->Team Project Set, then entering http://git.eclipse.org/c/ocl/org.eclipse.ocl.git/plain/releng/org.eclipse.ocl.releng/psfs/ocl-all.psf?h=master as the URL for import. Be patient; the repository clone takes a while, and there are no obvious progress indicators during the third phase while projects are actually created.

If you plan to contribute to Eclipse OCL, please have a look to the project Developer Resources

Documentation, Publications and FAQs

Example Code

Releases and Development

You may want to check the New and Noteworthy features of the Eclipse OCL releases.

Planning

API Changes

  • API Changes made in the Helios Eclipse OCL release.
  • API Changes made in the Indigo Eclipse OCL release.
  • Deprecations announced in the Juno Eclipse OCL release.
  • Limitations of the Ecore/UML bindings and OCL 2.3 compared to the Pivot binding and 'OCL 2.5'.

Architecture

The remainder of this section has links to pages of interest primarily to those developing the OCL component.

Development Environment

Release Engineering

Related Links