EclipseCon 2011 Tutorial

1. Enrich Your Models with OCL Edward Willink, Thales MDT/OCL Project Lead Axel Uhl, SAP 21st March 2011

2. Part 1: OCL in isolation Installation Instructions OCL Basic Principles exercises OCL Collections and Iterators exercises OCL tools and usage exercises OCL in Java - analyzable language

9. Modeling->Graphical Modeling Framework (GMF) Runtime

10. Modeling->OCL Examples and Editors

11. Modeling->Operational QVT SDK

13. Next ... Restart Now

18. 0 errors

19. 98 warnings

24. 2 errors

25. 3 warnings

33. M2M: OMG QVT, Eclipse QVTo, ATL, Epsilon

34. M2T: OMG MOFM2T, Eclipse Acceleo

37. Multiplicity Example Family Tree Meta-Model Ecore Diagram (similar to UML Class Diagram)

40. 1 MALE, 1 FEMALE parent

41. Self is not an ancestor of self

42. Example Family Tree Model Simple GMF Diagram Editor Runtime Workspace: ESEExampleTree/model/default.people_diagram

43. Simple Query Evaluation Window->Show View->Other... Console Console: New: Interactive Xtext OCL Select Zeus as the Model Context (in any model editor) Type children then carriage return

45. side effect free, no model changes, atomic execution

46. strongly typed, using UML generalization

47. Primitive Types and Literals Java (implementation) OCL (specification) boolean,Boolean,true,false Boolean,true,false short,int,long,Integer,BigInteger Integer , UnlimitedNatural float, double, BigDecimal Real Character, String, 'c', " line " String, 'c', ' line ' Object,this,null OclAny, self ,null Exception invalid Integer value value : Integer Java: practical implementation language OCL: simpler, idealistic, specification language

48. Mathematical Operators Java (implementation) OCL (specification) +, -, *, / +, -, *, / !, &&, ||, ^ not, and, or, xor, implies <, >, <=, >= <, >, <=, >= ==, != = , <> Math.max(4,5) 4.max(5) if (a) b else c; if a then b else c endif Integer value = 5; doSomething(value); let value : Integer = 5 in doSomething(value)

49. More Complex Query Selecting Hera defines the implicit context variable self : Person = Hera

55. Setting Delegate for EStructuralFeature initial value

56. Example Validation Delegate

57. The OCLinEcore Editor OCLinEcore editor maintains EAnnotations automatically OCLinEcore editor provides OCL syntax checking OCLinEcore editor will provide OCL semantic checking

60. Searchable/replaceable text

61. Example Validation Failure Open ESEExampleTree/model/People1.xmi in Main Eclipse, with Sample Reflective Ecore Editor Select Universe, Right button menu, Validate

64. revalidate

67. getChildren().get(2) getChildren().add(newChild) OCL needs more than just UML multiplicities

72. OCL Navigation Operators anObject. ... object navigation aCollection-> ... collection navigation Shorthands aCollection. ... implicit collect anObject-> ... implicit as set Object Collection . Navigation ? -> ? Navigation

73. Implicit Collect Query parents.parents = parents->collect(parents) 3 symbols, compared to 4 lines of Java 4 grandparents, but not all different!

74. Cleaned up query parents.parents->asSet()->sortedBy(name) ->asSet() converts to Set(Person), removes duplicates ->sortedBy(name) alphabeticizes

78. OCL as Implementation any(x) iteration selects an arbitrary element for which x is true.

79. Derived Properties For Hera invariant MixedGenderParents: father . gender <> mother . gender ; fails because father is null and mother is null

80. Collection exercises

82. Tuples

83. Association Classes/Qualifiers

84. @pre values

85. Messages

86. States

88. evaluating OCL

89. Facade to hide internals

92. System comprising a set of model elements

93. A model element changes ....

94. Which of the OCL expressions may have changed its value on which context elements?

96. takes O(|expressions| * |modelElements|)

99. only expression for which model element is changed Go to Efficient, Scalable Notification Handling for EMF (2 hours ago).

100. Benchmark Context Reduction (Average Case) Naive Event-Filtered (*6 Speed-Up) Event-Filtered and Context-Reduced (*1300 Speed-Up vs. Naive, *220 vs. Event-Filtered-Only) Total Re-Evaluation Time in Seconds Number of Model Elements

101. Benchmark Context Reduction (Worst Case) Naive Event-Filtered (*2.4 Speed-Up) Event-Filtered and Context-Reduced (*27 Speed-Up vs. Naive, *11 vs. Event-Filtered-Only) Total Re-Evaluation Time in Seconds Number of Model Elements (apply changes to very central elements, referenced by all other model packages)

104. Use QVTo and OCL to flatten state machine

106. Tailor Editor

108. Start Run-time

110. Start Run-time

112. Simple State Machine DSL module &quot;simple.states&quot; statemachine Machine { events START STOP; state Start { STOP => Stop } initial state Stop { START => Start } }

113. The Xtext States Grammar http://www.eclipse.org/modeling/mdt/ocl/docs/publications/EclipseCon2011Tutorial /org.eclipse.ocl.tutorial.eclipsecon2011.states/src/org/eclipse/ocl/tutorial/eclipsecon2011/States.xtext grammar org.eclipse.ocl.tutorial.eclipsecon2011.States with org.eclipse.xtext.common.Terminals generate states &quot;http://ocl.eclipse.org/tutorial/eclipsecon2011/States&quot; Module: 'module' name=STRING (machines+=Statemachine)*; Statemachine: (initial?= 'initial' )? 'statemachine' name=ID ( 'value' value=INT)? '{' 'events' (events+=Event)* ';' (states+=State)* '}' ; Event: name=ID; State: SimpleState | CompoundState; SimpleState: (initial?= 'initial' )? 'state' name=ID ( 'value' value=INT)? '{' (transitions+=Transition)* '}' ; CompoundState: 'compound' (initial?= 'initial' )? 'state' name=ID 'machine' machine=[ Statemachine ] '{' (transitions+=Transition)* '}' ; Transition: event=[ Event ] '=>' state=[ State ];

116. Embedded OCLinEcore Validation

119. Complete OCL Validation 1 /org.eclipse.ocl.tutorial.eclipsecon2011.states.ocl/model/States.ocl import 'http://ocl.eclipse.org/tutorial/eclipsecon2011/States' package states context Statemachine inv HasInitialState( 'No initial state' ): states -> exists ( s : State | s . initial ) endpackage Evaluates: states -> exists ( s : State | s . initial ) true => silent, invariant is satisfied false => invariant is not satisfied evaluates 'No initial state' to determine warning diagnostic null => invariant is not satisfied evaluates 'No initial state' to determine error diagnostic invalid => exception, evaluation failure

120. Example Invariant Violation

121. Complete OCL Validation 2 context Statemachine def : asError(verdict : Boolean ) : Boolean = if verdict then true else null endif inv HasInitialState( 'No initial state' ): asError ( states -> exists ( s : State | s . initial )) context SimpleState inv NameLength( 'apos;' + name + 'apos; has ' + name . size (). toString () + ' characters when at least 4 wanted' ): name . size () >= 4 inv NameIsLeadingUpperCase( 'apos;' + name + 'apos; must be Leading Uppercase' ): let firstLetter : String = name . substring ( 1 , 1 ) in firstLetter . toUpperCase () = firstLetter

122. Complete OCL Validation 3 context SimpleState def : statemachine : Statemachine = oclContainer ()-> oclAsType ( Statemachine ) inv UniqueInitialState( 'There is more than one initial state' ): initial implies statemachine . states -> select ( initial )-> size () = 1 inv EveryEventIsHandled( let allEvents : Set ( Event ) = statemachine . events -> asSet (), myEvents : Set ( Event ) = self . transitions . event -> asSet () in ( allEvents - myEvents )-> iterate ( e : Event ; s : String = 'The following events are not handled:' | s + ' ' + e . name )): let allEvents : Set ( Event ) = statemachine . events -> asSet (), myEvents : Set ( Event ) = self . transitions . event -> asSet () in ( allEvents - myEvents )-> isEmpty ()

123. Composite Validation Errors

128. AccessorName: http://ocl.eclipse.org/tutorial/eclipsecon2011/States

129. Model URI: platform:/resource/org.eclipse.ocl.tutorial.eclipsecon2011.states/ src-gen/org/eclipse/ocl/tutorial/eclipsecon2011/States.ecore

132. check that NameIsUppercase is working

135. tip 2: the closure of all transitions from all initial states includes the state in question

141. Tailor Editor

144. Start Run-time

146. Start Run-time

151. to org.eclipse.ocl.tutorial.eclipsecon2011.oclstates/ model/OCLStates.ecore

152. change all ... States.ecore refs to OCLStates.ecore

153. set genmodel Operation Reflection to true

157. ( states ) is over protective pretty-printing

158. [?] is UML oriented [1] not [?] is the default

159. { ordered } is UML oriented { ! ordered unique } is the default

160. Embedded Constraints 2 invariant UniqueInitialState( 'There is more than one initial state' ): initial implies ((( statemachine ). states )-> select ( initial ))-> size () = 1 ; invariant NameIsLeadingUpperCase( 'apos;' + name + 'apos; must be Leading Uppercase' ): let firstLetter : String = ( name ). substring ( 1 , 1 ) in firstLetter . toUpperCase () = firstLetter ; invariant NameLength( 'apos;' + name + 'apos; has ' + (( name ). size ()). toString () + ' characters when at least 4 wanted' ): ( name ). size () >= 4 ; invariant EveryEventIsHandled( let allEvents : Set ( Event ) = (( statemachine ). events )-> asSet () in let myEvents : Set ( Event ) = (( self . transitions )-> collect ( event ))-> asSet () in ( allEvents - myEvents )-> iterate ( e : Event ; s : String = 'The following events are not handled:' | s + ' ' + e . name )): let allEvents : Set ( Event ) = (( statemachine ). events )-> asSet () in let myEvents : Set ( Event ) = (( self . transitions )-> collect ( event ))-> asSet () in ( allEvents - myEvents )-> isEmpty (); property statemachine : Statemachine [?] { derived } { derivation : ( oclContainer ()). oclAsType ( Statemachine ); }

162. Use an extended Validator API for

167. Add a new constraint to OCLStates.ecore

168. Regenerate Java with OCLStates.genmodel

171. or simple.states

172. Close simple.states

173. Run Generate Simple States

174. Inspect *.java generate.mtl

177. one class for the State Machine

178. one class for each State

179. one method for each Event

180. States to Java Classes module &quot;simple.states&quot; statemachine Machine { events START STOP; state Start { START => Start } initial state Stop { STOP => Stop } } package simple.states; public class Stop implements Machine.State { private final Machine sm ; public Stop(Machine sm) { this . sm = sm; } public void doSTOP() { sm .setState(STATES. STATE_Stop ); } } package simple.states; public class Machine { public interface State { public void doSTART(); public void doSTOP(); enum STATES { STATE_Start , STATE_Stop } }

183. doesn't work standalone

189. OCL: e.name + '.java' e.states

192. package simple.states; public class Machine { public interface State { public void doSTART(); public void doSTOP(); enum STATES { STATE_Start , STATE_Stop } } Acceleo Text Template 2 [template public generateStatemachineClass(m : Module, e : Statemachine)] package [ m.getPackageName() /] ; public class [ e.getStateMachineClassName() /] { public interface State { [for ( v : Event | e.events) ] public void [ v.getEventMethodName() /] (); [/for] enum STATES { [for ( s : State | e.states) separator ( ',' ) after ( '' ) ] [ s.getStateEnumName() /] [/for] } } ... public [ e.getStateMachineClassName() /] () { setState(State.STATES. [ e.getInitialState().getStateEnumName() /] ); } public Machine() { setState(State.STATES. STATE_Stop ); }

194. protects downstream from garbage in ...

196. Change the enums from STATE to ENUM prefix

197. ReLaunch, verify changes

199. Eliminate the 'EveryStateIsHandled' editor validation

201. or compound.states

202. Run Flatten States to XMI or Flatten States

203. Inspect flattened.xmi Inspect flattened.states FlattenStates.qvto

207. Statemachine Flattening Example module &quot;compound.states&quot; statemachine Outer { events START STOP; initial state Start value 4 { START => CompoundA } state Stop value 5 { STOP => CompoundB } compound state CompoundA machine Inner { START => Stop } compound state CompoundB machine Inner { STOP => Stop } } statemachine Inner { events LEFT RIGHT; initial state Left value 1 { LEFT => Right } state Right { RIGHT => Left } } module &quot;flattened.compound.states&quot; statemachine Outer { events STOP RIGHT LEFT START; initial state Start value 4 { START => CompoundA_Left } state Stop value 5 { STOP => CompoundB_Left } state CompoundA_Left value 1 { LEFT => CompoundA_Right START => Stop } state CompoundA_Right { RIGHT => CompoundA_Left START => Stop } state CompoundB_Left value 1 { LEFT => CompoundB_Right STOP => Stop } state CompoundB_Right { RIGHT => CompoundB_Left STOP => Stop } }

208. root mapping mapping HIER :: Module :: model2FLATModel () : FLAT :: Module { name := 'flattened.' + self . name ; var name2state : Dict ( String , HIER :: State ); var allMachines : Set ( HIER :: Statemachine ) = self . machines . allMachines ()-> asSet (); var allStates : Set ( HIER :: State ) = allMachines. states -> asSet (); var allCompoundStates : Set ( HIER :: CompoundState ) = allStates-> select ( oclIsTypeOf ( HIER :: CompoundState )) -> collect ( oclAsType ( HIER :: CompoundState ))-> asSet (); var rootMachines : Set ( HIER :: Statemachine ) = allMachines-> select (m : HIER :: Statemachine | not allCompoundStates-> exists ( machine = m)); machines := rootMachines-> map machine2machine (name2state); }

213. from-compound => all exitTransitions

214. iterate to form concatenated string query HIER :: State :: getStateName (hierarchy : Sequence ( HIER :: CompoundState )) : String { return hierarchy->iterate(c : HIER :: CompoundState ; s : String = self . name | c. name + '_' + s) }

215. conditional hierachical selection query HIER :: State :: initialStateName (hierarchy : Sequence ( HIER :: CompoundState )) : String { var stateName : String = self . getStateName (hierarchy); return if self . oclIsKindOf ( HIER :: CompoundState ) then let compoundState : HIER :: CompoundState = self . oclAsType ( HIER :: CompoundState ) in compoundState. machine . states -> any ( initial ) . initialStateName (hierarchy-> append (compoundState)) else stateName endif }

216. simple navigation/logic mapping HIER :: SimpleState :: simpleState2state ( name2state : Dict ( String , HIER :: State ), hierarchy : Sequence ( HIER :: CompoundState ) ) : FLAT :: SimpleState { var stateName : String = self . getStateName (hierarchy); name := stateName; value := self . value ; initial := hierarchy-> isEmpty () and self . initial ; name2state-> put (stateName, result ); }

217. iterate to create objects mapping HIER :: SimpleState :: simpleState2transitions2 ( name2state : Dict ( String , HIER :: State ), hierarchy : Sequence ( HIER :: CompoundState ), exitTransitions : Dict ( FLAT :: Event , FLAT :: State ) ) : FLAT :: State { init { var stateName : String = self . getStateName (hierarchy); result := name2state-> get (stateName); } transitions := exitTransitions-> keys ()->iterate(v : FLAT :: Event ; acc : Sequence ( HIER :: Transition ) = self . transitions . map transition2transition (name2state, hierarchy) | acc-> append ( object FLAT :: Transition { state := exitTransitions-> get (v); event := v; }) ); }

221. inspect Flattened.qvto

223. add more hierachical states

224. regenerate

228. 'var' used to cache partial/temporary states

236. Ecore behavioral extension - OCLinEcore editor

237. dynamic and genmodeled validation

239. Eclipse OCL evolving an extensible GUI