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 "OCL"
m (→Articles) |
(→Documentation, Publications and FAQs) |
||
| (43 intermediate revisions by 4 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 [[ | + | * 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 | + | 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 == |
| − | + | Eclipse OCL Downloads are available via the [http://www.eclipse.org/modeling/mdt/downloads/?project=ocl Project Downloads] page. | |
| − | + | 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/kepler/ 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, an Interactive Console and Debugger. | |
| − | + | 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 source code is available from git://git.eclipse.org/gitroot/mdt/org.eclipse.ocl.git, [http://git.eclipse.org/c/mdt/org.eclipse.ocl.git http://git.eclipse.org/c/mdt/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. |
| − | + | 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]] | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | == | + | == Documentation, Publications and [[OCL/FAQ|FAQs]] == |
| − | * [[ | + | * [[OCL/Compliance|(OMG) OCL Compliance]] and [[OCL/Limitations|(Eclipse) OCL Limitations]] |
| + | * [http://help.eclipse.org/ Eclipse Help Center] Current documentation | ||
| + | ** Luna OCL Documentation [http://help.eclipse.org/kepler/topic/org.eclipse.ocl.doc/help/Overview.htm HTML] [http://download.eclipse.org/ocl/doc/5.0.0/ocl.pdf PDF] | ||
| + | ** Kepler OCL Documentation [http://help.eclipse.org/kepler/topic/org.eclipse.ocl.doc/help/Overview.html HTML] | ||
| + | ** Juno OCL Documentation [http://help.eclipse.org/juno/topic/org.eclipse.ocl.doc/help/Overview.html HTML] | ||
| + | ** Indigo OCL Documentation [http://help.eclipse.org/indigo/topic/org.eclipse.ocl.doc/help/Overview.html HTML] [[OCL/Indigo Documentation Errata| Errata]] | ||
| + | ** Helios OCL Developer Guide [http://help.eclipse.org/helios/nav/40 HTML] | ||
| + | * [[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 | ||
| − | * [ | + | * [[OCL/Articles|Articles and Presentations]] |
| + | * [[OCL/FAQ|Frequently Asked Questions]] | ||
| + | |||
| + | == Example Code == | ||
| + | |||
| + | * [[CustomizingOclEnvironments | Customizing OCL Environments]] | ||
| + | * [[StereotypeOCLwithEcore | Evaluating Stereotype Constraints using the Ecore Environment]] | ||
| + | * [[OCLSnippets | OCL Snippets]] | ||
== Releases and Development == | == Releases and Development == | ||
| + | |||
| + | 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_indigo.xml&component=OCL Indigo | + | * [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_helios.xml&component=OCL Helios | + | * [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.xml&component=OCL Galileo | + | * [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/modeling/mdt/ocl/docs/ocl_project_plan_1_2.html R1.2 | + | * [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/modeling/mdt/ocl/docs/ocl_project_plan_1_1.html R1.1 | + | * [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.xml&component=Eclipse OCL 1.3 Galileo Plan] | ||
| + | * [http://www.eclipse.org/modeling/mdt/ocl/docs/ocl_project_plan_1_2.html R1.2 Plan] | ||
| + | * [http://www.eclipse.org/modeling/mdt/ocl/docs/ocl_project_plan_1_1.html R1.1 Plan] | ||
| − | * [[ | + | * [[OCL/Debugger|Evaluator + Console ideas]] |
=== API Changes === | === API Changes === | ||
| − | * [[MDT/OCL_3.0.0_API_Changes| API Changes]] made in the Helios | + | * [[MDT/OCL_3.0.0_API_Changes| API Changes]] made in the Helios Eclipse OCL release. |
| − | * [[MDT/OCL_3.1.0_API_Changes| API Changes]] made in the Indigo | + | * [[MDT/OCL_3.1.0_API_Changes| API Changes]] made in the Indigo Eclipse OCL release. |
| − | + | * [[MDT/OCL_Juno_Deprecations| Deprecations]] announced in the Juno Eclipse OCL release. | |
| − | + | * [[MDT/OCL_Limitations| Limitations]] of the Ecore/UML bindings and OCL 2.3 compared to the Pivot binding and 'OCL 2.5'. | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | * | + | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
=== Architecture === | === Architecture === | ||
| − | * [[MDT/OCL/1.X_Architecture| | + | * [[MDT/OCL/Plugins_and_Features|Eclipse OCL Plugins and Features]] |
| − | * [[MDT/OCL/4.X_Architecture| | + | * [[MDT/OCL/1.X_Architecture|Eclipse OCL 1.X Architecture]] |
| + | * [[MDT/OCL/4.X_Architecture|Eclipse OCL 4.X Architecture]] | ||
The remainder of this section has links to pages of interest primarily to those developing | The remainder of this section has links to pages of interest primarily to those developing | ||
| Line 92: | Line 85: | ||
=== Development Environment === | === Development Environment === | ||
| − | * [[ | + | * [[OCL/Dev/Setup|Team Standard Settings and Procedures]] |
=== Release Engineering === | === Release Engineering === | ||
| − | * [[ | + | * [[OCL/Dev/Releng/Buckminster | How to Make and Publish Builds Using Buckminster]] |
| − | * [[ | + | * [[OCL/Dev/Releng/ReleasesTransition | Transition between releases]] |
| − | * [[ | + | * [[OCL/Dev/Releng/Quiet_Week | Quiet week]] |
| − | * [[ | + | * [[OCL/Dev/Releng/P2_Repositories_Organization| P2 Repositories Organization]] |
| + | * [[OCL/Dev/Releng/Features_Organization| Features Organization]] | ||
| + | * [[OCL/Dev/Releng/Issues_Documentation| Issues Documentation]] | ||
== Related Links == | == Related Links == | ||
Revision as of 13:53, 9 June 2014
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.
Contents
Downloads and Updates
Eclipse OCL Downloads are available via the Project Downloads page.
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/kepler/ 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, an Interactive Console and Debugger.
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.
Eclipse OCL source code is available from git://git.eclipse.org/gitroot/mdt/org.eclipse.ocl.git, http://git.eclipse.org/c/mdt/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.
Eclipse OCL has Open Bugs and a newsgroup or forum. See the OCL Forum Netiquette
Documentation, Publications and FAQs
- (OMG) OCL Compliance and (Eclipse) OCL Limitations
- Eclipse Help Center Current documentation
- New and Noteworthy features of the Eclipse OCL releases.
- Javadoc API Reference
- Articles and Presentations
- Frequently Asked Questions
Example Code
- Customizing OCL Environments
- Evaluating Stereotype Constraints using the Ecore Environment
- OCL Snippets
Releases and Development
You may want to check the New and Noteworthy features of the Eclipse OCL releases.
Planning
- OCL 5.0/3.4 Luna Draft Plan
- OCL 4.1/3.3 Kepler Plan
- OCL 4.0/3.2 Juno Plan
- OCL 3.1 Indigo Plan
- OCL 3.0 Helios Plan
- OCL 1.3 Galileo Plan
- R1.2 Plan
- R1.1 Plan
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
- How to Make and Publish Builds Using Buckminster
- Transition between releases
- Quiet week
- P2 Repositories Organization
- Features Organization
- Issues Documentation
Related Links
- Modeling Project Category Wiki
- Model Development Tools Category Wiki
- How to build Modeling sub-projects like OCL