Difference between revisions of "MDT-OCLTools"

From Eclipsepedia

Jump to: navigation, search
(Features supported)
(Features supported)
Line 109: Line 109:
  
 
Among others, it supports the following:  
 
Among others, it supports the following:  
 +
 +
==== Syntax highlighting ====
  
 
<ul>
 
<ul>

Revision as of 10:37, 2 November 2007

Contents

What's inside

OCL Tools is a recently added component to the Model Development Tools (MDT) Project aiming at providing first-class support to modelers working with specifications containing expressions written in OCL, the Object Constraint Language. Such support includes editing, refactoring, code generation, execution, and interactive debugging of the OCL constraints given for some underlying (Ecore or UML2) class model. The functionality of OCL Tools builds upon the MDT OCL component, and has been seeded with two initial contributions:

  • an OCL -> Java compiler, that as of now takes as input an .ecore and a textual file containing OCL constraints (handling UML2 is in the ToDo list). This compiler extends EMF code generation, producing Java 5 source code with side-effects-free methods for the given OCL invariants, pre- and postconditions, and derived attributes and operations.
  • an OCL text editor, supporting usability features such as AutoCompletion, navigation by means of hyperlinks, structured views (for the outline of a document and for the Abstract Syntax Tree of an OCL constraint), among others. Although MDT OCL itself is completely fluent in both Ecore and UML2, only the Ecore binding is supported by the OCL text editor at this time.

A longer intro to OCL Tools can be found in the draft article being reviewed for publication at: https://bugs.eclipse.org/bugs/show_bug.cgi?id=204701


OCL Compiler

What it does

In a nutshell, the compiler translates expressions like that in Listing 1 into what is shown in Listing 2:

context LoyaltyAccount
	inv invariant_points :
		self . points > 0
		implies self.transactions->exists ( t | t.points > 0 )
Listing 1 An OCL Invariant
public boolean invariant_points () {
	Boolean implies1 = ( this . getPoints () > 0);
	if (!( implies1 )) {
		implies1 = Boolean . TRUE ;
	} else {
		Boolean exists2 = false ;
		for ( RandL . Transaction t :
		org.eclipse.ocl.util.CollectionUtil.asSet ( this . getTransactions ())) {
				if (!exists2 ) {
					exists2 = (t.getPoints () > 0);
				}
		}
		implies1 = exists2 ;
	}
	return implies1 ;
}
Listing 2 LoyaltyAccount's invariant_points translated into Java



How to use it

Step 1: Prepare an .ocl file

Figure 1(a) Start situation


Step 2: Invoke the compiler

Figure 1(b) Invoking the compiler by right-clicking on the .ecore file

The compiler works ...

Figure 1(c) The compiler works ...

Step 3: Java code is ready

Figure 1(d) End result

OCL Text Editor

The big picture of the editor is:

OCLTools oclEditor screenshots.png

Features supported

Among others, it supports the following:

Syntax highlighting

  • Syntax highlighting
  • AutoEdit 1: Auto-completion of closing brace
  • AutoEdit 2: Upon typing a colon : and pressing Enter. A new indented line will be added, letting the cursor ready for typing the body of the OCL expression.
  • Bracket matching
  • Content Assist
    [Image content_assist.png]
  • Current line highlighting and Show range indicator
  • Text Folding
  • Templates, customizable through Preference pages File:OCLTools editor preference page.png
  • Problem and Warning markers, "red squigglies"
    OCLTools problem markers.png
  • Outline view
  • OCL AST View
    OCLTools oclASTView.png