OCL General Operators
No edit summary
No edit summary
Line 1: Line 1:
== General Operators ==
To find all available operators, you can open the OCL-Editor and type in a class:
To find all available operators, you can open the OCL-Editor and type in a class:
[[File:Ocl-editor 1.png|frameless|433x433px|link=https://wiki.mdriven.net/index.php/File:Ocl-editor_1.png]]
{| class="wikitable"
!Operators
!Description
|-
|'''[https://wiki.mdriven.net/index.php/OCLOperators_allInstances allInstances]'''
|All the objects of the class
|-
|'''[[OCLOperators allInstancesAtTime|allinstancesAtTime]]'''
|All the currently loaded instances
|-
|[[OCLOperators allLoadedObjects|'''allLoadedObjects''']]
|All objects currently in memory, excluding deleted objects
|-
|'''[[OCLOperators allStates|allStates]]'''
|Meta information about available states in state machines the class may contain
|-
|'''[[OCLOperators allSubClasses|allSubClasses]]'''
|Meta information on all the sub-classes this class has
|-
|'''[[OCLOperators allSuperTypes|allSuperTypes]]'''
|Meta information on all the super-classes – in inheritance order the class has
|-
|[[OCLOperators ASCII|'''ASCII''']]
|
|-
|'''[[OCLOperators associationEnds|associationEnds]]'''
|Returns a collection of strings with association names for the class
|-
|[[OCLOperators associationEndsWithType|'''associationEndsWithType''']]
|Returns a collection of strings with association names and type information for the class
|-
|'''[[OCLOperators asString|asString]]'''
|The string representation of the class – the asString operation is available on everything
|-
|[[OCLOperators AsTaJson|'''asTaJson''']]
|Returns a json string defined by the ViewModel
|-
|[[OCLOperators atTime|'''atTime''']]
|Gives the read-only representation of a versioned object as it was at time X.
|-
|'''[[OCLOperators attributes|Attributes]]'''
|Meta information about what attributes the class has
|-
|[[OCLOperators BigEndianUnicode|'''BigEndianUnicode''']]
|
|-
|[[OCLOperators brokenConstraints|'''brokenConstraints''']]
|Returns a collection of the names of broken constraints for the class and object.
|-
|[[OCLOperators canAccess|'''canAccess''']]
|Check ViewModels Access expression for root
|-
|'''[[OCLOperators constraints|Constraints]]'''
|Meta information on what constraints the class has
|-
|[[OCLOperators count|'''count''']]
|Returns how many times the ''object'' is in the collection ''self''.
|-
|[[OCLOperators Default|'''Default''']]
|
|-
|[[OCLOperators Empty|'''Empty''']]
|
|-
|'''[[OCLOperators emptyList|emptylist]]'''
|Returns an empty list typed to hold objects of the class
|-
|[[OCLOperators existing|'''existing''']]
|The existing operator returns true if the object hasn't been deleted.
|-
|[[OCLOperators externalId|'''externalId''']]
|Returns the external ID for the object operated on.
|-
|[[OCLOperators format|'''format''']]
|
|-
|[[OCLOperators IsDirty|'''IsDirty''']]
|Returns true if the objects have been changed since the last save.
|-
|[[OCLOperators IsNew|'''IsNew''']]
|IsNew operator returns true if the object has never been saved to the database.
|-
|'''isDirtyMember'''
|Called on a class attribute to check if this attribute has changes pending to be saved.
|-
|'''isNull'''
|Returns true if the value is null (not assigned any value).
|-
|[[OCLOperators maxValue|'''maxValue''']]
|Gets the maximum value in a collection of values
|-
|[[OCLOperators minValue|'''minValue''']]
|Gets the minimum value in a collection of values
|-
|'''[[OCLOperators nullValue|nullValue]]'''
|A typed null value
|-
|'''[[OCLOperators objectfromExternalId|objectFromExternalId]]'''
|An external identity will be resolved to the object
|-
|'''[[OCLOperators oclAsType|oclAsType]]'''
|The type of the class
|-
|[[OCLOperators oclGetStates|'''oclGetStates''']]
|Gets a list of the objects all state machines currently state as strings.
|-
|'''[[oclIsInvalid]]'''
|Returns true if ''self'' is equal to *invalid*.
|-
|'''[[OCLOperators oclIsKindOf|oclIsKindOf]]'''
|This is to if a class is a subclass or as the class itself and not unrelated
|-
|'''[[OCLOperators oclIsTypeOf|oclIsTypeOf]]'''
|Returns true if
|-
|[[OCLOperators OnCreate|'''OnCreate''']]
|Is often called when a new object has been created.
|-
|[[OCLOperators OnUpdate|'''OnUpdate''']]
|Is called just before the object is saved to the database.
|-
|[[oclIsUndefined|'''oclIsUndefined''']]
|Returns true if ''self'' is equal to invalid or null.
|-
|'''[[OCLOperators OclType|OclType]]'''
|When used on an object, you get the type of the object.
|-
|[[OCLOperators random|'''random''']]
|
|-
|'''[[OCLOperators safeCast|safeCast]]'''
|
|-
|[[OCLOperators Sqlpassthrough|'''sqlpassthrough''']]
|Calls a stored procedure
|-
|[[OCLOperators sqlpassthroughobjects|'''sqlpassthroughobjects''']]
|Return a primary key of SomeClass. This can be combined with other Ocl-PS via ->intersection or union.
|-
|'''[[OCLOperators superTypes|superTypes]]'''
|Returns the set of all direct supertypes of the type.
|-
|'''[[OCLOperators taggedValue|TaggedValue]]'''
|Meta information on tagged values set in the class
|-
|'''[[OCLOperators taggedValueOnFeature|TaggedValueOnFeature]]'''
|Meta information on Tagged values set on a named feature in the class
|-
|'''[[OCLOperators typename|Typename]]'''
|The type name as a string
|-
|'''[[OCLOperators ViewModels|ViewModels]]'''
|A tuple with the ViewModels for this class a members
|}

Revision as of 07:51, 21 April 2023

General Operators

To find all available operators, you can open the OCL-Editor and type in a class:

Ocl-editor 1.png

Operators Description
allInstances All the objects of the class
allinstancesAtTime All the currently loaded instances
allLoadedObjects All objects currently in memory, excluding deleted objects
allStates Meta information about available states in state machines the class may contain
allSubClasses Meta information on all the sub-classes this class has
allSuperTypes Meta information on all the super-classes – in inheritance order the class has
ASCII
associationEnds Returns a collection of strings with association names for the class
associationEndsWithType Returns a collection of strings with association names and type information for the class
asString The string representation of the class – the asString operation is available on everything
asTaJson Returns a json string defined by the ViewModel
atTime Gives the read-only representation of a versioned object as it was at time X.
Attributes Meta information about what attributes the class has
BigEndianUnicode
brokenConstraints Returns a collection of the names of broken constraints for the class and object.
canAccess Check ViewModels Access expression for root
Constraints Meta information on what constraints the class has
count Returns how many times the object is in the collection self.
Default
Empty
emptylist Returns an empty list typed to hold objects of the class
existing The existing operator returns true if the object hasn't been deleted.
externalId Returns the external ID for the object operated on.
format
IsDirty Returns true if the objects have been changed since the last save.
IsNew IsNew operator returns true if the object has never been saved to the database.
isDirtyMember Called on a class attribute to check if this attribute has changes pending to be saved.
isNull Returns true if the value is null (not assigned any value).
maxValue Gets the maximum value in a collection of values
minValue Gets the minimum value in a collection of values
nullValue A typed null value
objectFromExternalId An external identity will be resolved to the object
oclAsType The type of the class
oclGetStates Gets a list of the objects all state machines currently state as strings.
oclIsInvalid Returns true if self is equal to *invalid*.
oclIsKindOf This is to if a class is a subclass or as the class itself and not unrelated
oclIsTypeOf Returns true if
OnCreate Is often called when a new object has been created.
OnUpdate Is called just before the object is saved to the database.
oclIsUndefined Returns true if self is equal to invalid or null.
OclType When used on an object, you get the type of the object.
random
safeCast
sqlpassthrough Calls a stored procedure
sqlpassthroughobjects Return a primary key of SomeClass. This can be combined with other Ocl-PS via ->intersection or union.
superTypes Returns the set of all direct supertypes of the type.
TaggedValue Meta information on tagged values set in the class
TaggedValueOnFeature Meta information on Tagged values set on a named feature in the class
Typename The type name as a string
ViewModels A tuple with the ViewModels for this class a members
This page was edited more than 1 years ago on 05/05/2023. What links here

Pages in category "OCL General Operators"

The following 50 pages are in this category, out of 50 total.

O

Retrieved from "https://newwikicopy.mdriven.net/index.php?title=Category:OCL_General_Operators&oldid=9689"

© MDRIVEN . All Rights Reserved

Glossary API Docs
MDriven World | Portal | Blog | YouTube | StackOverflow | Facebook

© MDRIVEN . All Rights Reserved