Difference between revisions of "Acceleo/Acceleo Operations Reference"

From Eclipsepedia

Jump to: navigation, search
m (current (Integer index) : OclAny)
m (eInverse () : Sequence(EObject))
 
(8 intermediate revisions by 2 users not shown)
Line 99: Line 99:
  
  
=== strcmp (String s1) : Integer ===
+
=== strcmp (String s1) : Integer ===
Returns an integer that is either negative, zero or positive depending on whether *s1* is alphabetically less than, equal to or greater than *self*. Note that upper case letters come before lower case ones, so that 'AA' is closer to 'AC' than it is to 'Ab'.
+
 
 +
Returns an integer that is either negative, zero or positive depending on whether *s1* is alphabetically less than, equal to or greater than *self*. Note that upper case letters come before lower case ones, so that 'AA' is closer to 'AC' than it is to 'Ab'.  
  
 
{| border="1" cellpadding="5" cellspacing="0"
 
{| border="1" cellpadding="5" cellspacing="0"
 
|-
 
|-
! style="background: #BCBCBC;" align="center"| Expression
+
! style="background: #BCBCBC;" align="center" | Expression  
! style="background: #BCBCBC;" align="center"| Result
+
! style="background: #BCBCBC;" align="center" | Result
 
|-
 
|-
| 'strcmp operation'.strstr('strcmp')
+
| 'strcmp operation'.strcmp('strcmp')  
 
| 10
 
| 10
 
|-
 
|-
| 'strcmp operation'.strstr('strcmp operation')
+
| 'strcmp operation'.strcmp('strcmp operation')  
 
| 0
 
| 0
 
|-
 
|-
| 'strcmp operation'.strstr('strtok')
+
| 'strcmp operation'.strcmp('strtok')  
 
| -17
 
| -17
 
|}
 
|}
 
  
 
=== strstr (String r) : Boolean ===
 
=== strstr (String r) : Boolean ===
Line 563: Line 563:
 
|-
 
|-
 
| Class2.eInverse()
 
| Class2.eInverse()
| Sequence{aClass2}
+
| Sequence{package11,aClass2}
 
|-
 
|-
 
| package11.eInverse()
 
| package11.eInverse()
| Sequence{}
+
| Sequence{package1}
 
|}
 
|}
 
  
 
=== eInverse (OclType oclType) : Sequence(oclType) ===
 
=== eInverse (OclType oclType) : Sequence(oclType) ===
Line 715: Line 714:
  
 
=== current (OclType filter) : OclAny ===
 
=== current (OclType filter) : OclAny ===
 +
This will have the same effect as current(Integer) except that is will return the first context (*self* variable) of the given type, at or above the current one. The following example is explained line by line in the "result" column.
  
  This will have the same effect as current(Integer) except that is will return the first context (*self* variable) of
+
[for (p: Package | root.packagedElement)]     Iterates over all packages of the Model root
  the given type, at or above the current one.
+
    [for (c: Class | p.packagedElement)]       Iterates over all classes of the current package
 
+
        [current(Class)/]                      Allows access to the current class (equivalent to c)
  The following example is explained line by line in the "result" column.
+
        [current(Package)/]                    Allows access to the current package (equivalent to p)
 
+
        [current(Model)/]                      Allows access to the the root Model
 
+
    [/for]
      * - Expression
+
[/for]
        - Result
+
      * - | [for (p: Package |pipe| root.packagedElement)]
+
          |    [for (c: Class |pipe| p.packagedElement)]
+
          |        [current(Class)/]
+
          |        [current(Package)/]
+
          |        [current(Model)/]
+
          |    [/for]
+
          | [/for]
+
        - | Iterates over all packages of the Model *root*
+
          | Iterates over all classes of the current package
+
          | allows access to the current class (equivalent to *c*)
+
          | allows access to the current package (equivalent to *p*)
+
          | allows access to the the *root* **Model**
+
 
+
 
+
  
 
=== getProperty (String key) : OclAny ===
 
=== getProperty (String key) : OclAny ===
 +
Returns the value of the property corresponding to the given *key*. Note that parameterized properties will be returned "as is" by this operation (parameters are not processed).
  
  Returns the value of the property corresponding to the given *key*. Note that parameterized properties will be
+
{| border="1" cellpadding="5" cellspacing="0"
  returned "as is" by this operation (parameters are not processed).
+
|-
 
+
! style="background: #BCBCBC;" align="center"| Expression
  +--------------------------------------------------+------------------------------------------+
+
! style="background: #BCBCBC;" align="center"| Result
  | Expression                                       | Result                                  |
+
|-
  +==================================================+==========================================+
+
| getProperty('a.b.c')
  | getProperty('a.b.c')                             | 'This is a parameterized property: {0}' |
+
| 'This is a parameterized property: {0}'
  +--------------------------------------------------+------------------------------------------+
+
|-
  | getProperty('a.b.c.d')                           | 'This is a standard property'           |
+
| getProperty('a.b.c.d')
  +--------------------------------------------------+------------------------------------------+
+
| 'This is a standard property'
  | getProperty('a.b.c.d.e')                         | null                                     |
+
|-
  +--------------------------------------------------+------------------------------------------+
+
| getProperty('a.b.c.d.e')
 
+
| null
 +
|}
  
  
 
=== getProperty (String key, Sequence(OclAny) parameters) : OclAny ===
 
=== getProperty (String key, Sequence(OclAny) parameters) : OclAny ===
 +
Returns the value of the property corresponding to the given key, with its parameters substituted with the given values if any.
  
  Returns the value of the property corresponding to the given key, with its parameters substituted with the given
+
{| border="1" cellpadding="5" cellspacing="0"
  values if any.
+
|-
 
+
! style="background: #BCBCBC;" align="center"| Expression
  +--------------------------------------------------+---------------------------------------------------+
+
! style="background: #BCBCBC;" align="center"| Result
  | Expression                                       | Result                                            |
+
|-
  +==================================================+===================================================+
+
| getProperty('a.b.c', Sequence{'substitution'})
  | getProperty('a.b.c', Sequence{'substitution'})   | 'This is a parameterized property: substitution' |
+
| 'This is a parameterized property: substitution'
  +--------------------------------------------------+---------------------------------------------------+
+
|-
  | getProperty('a.b.c', Sequence{})                 | 'This is a parameterized property: {0}'           |
+
| getProperty('a.b.c', Sequence{})
  +--------------------------------------------------+---------------------------------------------------+
+
| 'This is a parameterized property: {0}'
  | getProperty('a.b.c.d', Sequence{'substitution'}) | 'This is a standard property'                     |
+
|-
  +--------------------------------------------------+---------------------------------------------------+
+
| getProperty('a.b.c.d', Sequence{'substitution'})
 
+
| 'This is a standard property'
 +
|}
  
  
 
=== getProperty (String name, String key) : OclAny ===
 
=== getProperty (String name, String key) : OclAny ===
 +
Returns the value of the property corresponding to the given *key* from a properties file corresponding to the given *name*. Note that parameterized properties will be returned as is with this.
  
  Returns the value of the property corresponding to the given *key* from a properties file corresponding to the
+
{| border="1" cellpadding="5" cellspacing="0"
  given *name*. Note that parameterized properties will be returned as is with this.
+
|-
 
+
! style="background: #BCBCBC;" align="center"| Expression
  +--------------------------------------------------+-----------------------------------------------------+
+
! style="background: #BCBCBC;" align="center"| Result
  | Expression                                       | Result                                              |
+
|-
  +==================================================+=====================================================+
+
| getProperty('b.properties', 'a.b.c')
  | getProperty('b.properties', 'a.b.c')             | 'Parameterized property with a name conflict: {0}' |
+
| 'Parameterized property with a name conflict: {0}'
  +--------------------------------------------------+-----------------------------------------------------+
+
|-
  | getProperty('a.properties', 'a.b.c.d')           | |invalid|                                           |
+
| getProperty('a.properties', 'a.b.c.d')
  +--------------------------------------------------+-----------------------------------------------------+
+
| '''''invalid'''''
 
+
|}
  
  
 
=== getProperty (String name, String key, Sequence(OclAny) parameters) : OclAny ===
 
=== getProperty (String name, String key, Sequence(OclAny) parameters) : OclAny ===
 +
Returns the value of the property corresponding to the given *key* from a properties file corresponding to the given *name*, with its parameters substituted with the given values if any.
  
  Returns the value of the property corresponding to the given *key* from a properties file corresponding to the
+
{| border="1" cellpadding="5" cellspacing="0"
  given *name*, with its parameters substituted with the given values if any.
+
|-
 
+
! style="background: #BCBCBC;" align="center"| Expression
  +------------------------------------------------------------------+--------------------------------------------------------------+
+
! style="background: #BCBCBC;" align="center"| Result
  | Expression                                                       | Result                                                      |
+
|-
  +==================================================================+==============================================================+
+
| getProperty('b.properties', 'a.b.c', Sequence{'substitution'})
  | getProperty('b.properties', 'a.b.c', Sequence{'substitution'})   | 'Parameterized property with a name conflict: substitution' |
+
| 'Parameterized property with a name conflict: substitution'
  +------------------------------------------------------------------+--------------------------------------------------------------+
+
|-
  | getProperty('b.properties', 'a.b.c', Sequence{})                 | 'Parameterized property with a name conflict: {0}'           |
+
| getProperty('b.properties', 'a.b.c', Sequence{})
  +------------------------------------------------------------------+--------------------------------------------------------------+
+
| 'Parameterized property with a name conflict: {0}'
  | getProperty('a.properties', 'a.b.c.d', Sequence{'substitution'}) | |invalid|                                                   |
+
|-
  +------------------------------------------------------------------+--------------------------------------------------------------+
+
| getProperty('a.properties', 'a.b.c.d', Sequence{'substitution'})
 
+
| '''''invalid'''''
 +
|}
  
  
 
=== invoke (String class, String method, Sequence(OclAny) arguments ) : OclAny ===
 
=== invoke (String class, String method, Sequence(OclAny) arguments ) : OclAny ===
 +
Invokes the Java method *method* of class *class* with the given arguments. This will return OclInvalid if the method cannot be called in any way (bad arguments, mispelled name, mispelled signature, encapsulation errors, ...). This is only intended to be used to call Java methods for now.
  
  Invokes the Java method *method* of class *class* with the given arguments. This will return OclInvalid if the method
+
{| border="1" cellpadding="5" cellspacing="0"
  cannot be called in any way (bad arguments, mispelled name, mispelled signature, encapsulation errors, ...). This is
+
|-
  only intended to be used to call Java methods for now.
+
! style="background: #BCBCBC;" align="center"| Expression
 
+
! style="background: #BCBCBC;" align="center"| Result
 
+
|-
  +------------------------------------------------------------------+---------------------+
+
| invoke('java.lang.String', 'toUpperCase()', Sequence{root.name})
  | Expression                                                       | Result              |
+
| ROOT
  +==================================================================+=====================+
+
|}
  | invoke('java.lang.String', 'toUpperCase()', Sequence{root.name}) | ROOT               |
+
  +------------------------------------------------------------------+---------------------+
+
 
+
  
  
 
=== toString () : String ===
 
=== toString () : String ===
 +
Returns the String representation of the receiver. Examples depend on the "toString()" implementation of *self*. Let's assume it has been changed to return the object's name:
  
  Returns the String representation of the receiver.
+
{| border="1" cellpadding="5" cellspacing="0"
 
+
|-
  examples depend on the "toString()" implementation of *self*. Let's assume it has been changed to return the
+
! style="background: #BCBCBC;" align="center"| Expression
  object's name:
+
! style="background: #BCBCBC;" align="center"| Result
 
+
|-
  +--------------------------------------------------+---------------------+
+
| Class11.toString()
  | Expression                                       | Result              |
+
| 'Class11'
  +==================================================+=====================+
+
|}
  | Class11.toString()                               | 'Class11'           |
+
  +--------------------------------------------------+---------------------+
+
  
 
== Non-standard *Collection* operations ==
 
== Non-standard *Collection* operations ==
Line 837: Line 826:
  
 
=== sep (String separator) : Sequence(OclAny) ===
 
=== sep (String separator) : Sequence(OclAny) ===
 +
Returns all elements from the source collection separated by an element composed of the String *separator*.
  
  Returns all elements from the source collection separated by an element composed of the String *separator*.
+
{| border="1" cellpadding="5" cellspacing="0"
 
+
|-
  examples:
+
! style="background: #BCBCBC;" align="center"| Expression
 
+
! style="background: #BCBCBC;" align="center"| Result
  .. class:: exampletable
+
|-
 
+
| package1.eContents().name.sep('2009')
  +---------------------------------------+-------------------------------------------------------------+
+
| Sequence{'Package11', '2009', 'Class1a', '2009', 'Class1b'}
  | Expression                           | Result                                                     |
+
|-
  +=======================================+=============================================================+
+
| package1.eContents().sep('2009')
  | package1.eContents().name.sep('2009') | Sequence{'Package11', '2009', 'Class1a', '2009', 'Class1b'} |
+
| Sequence{Package11, '2009', Class1a, '2009', Class1b}
  +---------------------------------------+-------------------------------------------------------------+
+
|}
  | package1.eContents().sep('2009')     | Sequence{Package11, '2009', Class1a, '2009', Class1b}       |
+
  +---------------------------------------+-------------------------------------------------------------+
+
 
+
  
  
 
=== filter (OclType type) : Sequence(OclType) ===
 
=== filter (OclType type) : Sequence(OclType) ===
 +
Filters out of the collection all elements that are not instances of the given type or any of its subtypes. The returned collection is typed according to *type*.  Makes it easier to write @select(e | e.oclIsKindOf(type)).oclAsType(type)@.
  
  Filters out of the collection all elements that are not instances
+
{| border="1" cellpadding="5" cellspacing="0"
  of the given type or any of its subtypes.
+
|-
  The returned collection is typed according to *type*.
+
! style="background: #BCBCBC;" align="center"| Expression
  Makes it easier to write @select(e | e.oclIsKindOf(type)).oclAsType(type)@.
+
! style="background: #BCBCBC;" align="center"| Result
 
+
|-
  examples:
+
| package1.eContents().filter(Class)
 
+
| Sequence{Class1b, Class1a}
  .. class:: exampletable
+
|}
 
+
  +---------------------------------------+------------------------------------+
+
  | Expression                           | Result                            |
+
  +=======================================+====================================+
+
  | package1.eContents().filter(Class)   | Sequence{Class1b, Class1a}         |
+
  +---------------------------------------+------------------------------------+
+
 
+
  
  
 
=== reverse () (Only on ordered collections) ===
 
=== reverse () (Only on ordered collections) ===
 +
Reverses the order of the collection: the last element becomes the first and vice-versa. Only available on **ordered collections** (Sequence and OrderedSet).
  
  Reverses the order of the collection: the last element becomes the first and
+
{| border="1" cellpadding="5" cellspacing="0"
  vice-versa.
+
|-
  Only available on **ordered collections** (Sequence and OrderedSet).
+
! style="background: #BCBCBC;" align="center"| Expression
 
+
! style="background: #BCBCBC;" align="center"| Result
  examples:
+
|-
 
+
| OrderedSet {1, 2, 3}
  .. class:: exampletable
+
| OrderedSet {3, 2, 1}
 
+
|-
  +---------------------------------------+-------------------------------------------------------------+
+
| Sequence {1, 2, 3}
  | Expression                           | Result                                                      |
+
| Sequence {3, 2, 1}
  +=======================================+=============================================================+
+
|}
  | OrderedSet {1, 2, 3}                 | OrderedSet {3, 2, 1}                                       |
+
  +---------------------------------------+-------------------------------------------------------------+
+
  | Sequence {1, 2, 3}                   | Sequence {3, 2, 1}                                         |
+
  +---------------------------------------+-------------------------------------------------------------+
+
 
+
  
  
 
=== lastIndexOf (T elt) : Integer (Only on ordered collections) ===
 
=== lastIndexOf (T elt) : Integer (Only on ordered collections) ===
 +
Returns the position of the given element in the collection it is applied to. Only available on **ordered collections** (Sequence and OrderedSet).
  
  Returns the position of the given element in the collection it is applied to.
+
{| border="1" cellpadding="5" cellspacing="0"
  Only available on **ordered collections** (Sequence and OrderedSet).
+
|-
 
+
! style="background: #BCBCBC;" align="center"| Expression
  examples:
+
! style="background: #BCBCBC;" align="center"| Result
 
+
|-
  .. class:: exampletable
+
| OrderedSet {1, 2, 1}->lastIndexOf(1)
 
+
| 3
  +---------------------------------------+------------------------------+
+
|-
  | Expression                           | Result                       |
+
| Sequence {1, 2, 3}->lastIndexOf(4)
  +=======================================+==============================+
+
| -1
  | OrderedSet {1, 2, 1}->lastIndexOf(1) | 3                           |
+
|-
  +---------------------------------------+------------------------------+
+
| Sequence {1, null}->lastIndexOf(null)
  | Sequence {1, 2, 3}->lastIndexOf(4)   | -1                           |
+
| 2
  +---------------------------------------+------------------------------+
+
|-
  | Sequence {1, null}->lastIndexOf(null) | 2                           |
+
| Sequence {1, 2, 3}->lastIndexOf(null)
  +---------------------------------------+------------------------------+
+
| -1
  | Sequence {1, 2, 3}->lastIndexOf(null) | -1                           |
+
|}
  +---------------------------------------+------------------------------+
+
  
  

Latest revision as of 04:45, 9 January 2013

Contents

[edit] Acceleo operationq reference

[edit] Standard String Operations

[edit] first (Integer n) : String

Returns the first *n* characters of *self*, or *self* if its size is less than *n*.

Expression Result
'first operation'.first(8) 'first op'
'first operation'.first(-1) invalid


[edit] index (String r) : Integer

Returns the index of substring *r* in *self*, or -1 if *self* contains no occurrence of *r*.

  • Important:* String indexes start at 1. Consequently the last character's index in a string is equal to the string's length.


Expression Result
'index operation'.index('op') 7
'index operation'.index('i') 1
'index operation'.index('foo') -1


[edit] isAlpha () : Boolean

Returns *true* if *self* consists only of alphabetical characters, *false* otherwise.

Expression Result
'isAlpha'.isAlpha() true
'isAlpha operation'.isAlpha() false (spaces are not alphabetical characters)
'isAlpha11'.isAlpha() false (digits are not alphabetical characters)


[edit] isAlphanum () : Boolean

Returns *true* if *self* consists only of alphanumeric characters, *false* otherwise.

Expression Result
'isAlphanum'.isAlphanum() true
'isAlphanum operation'.isAlphanum() false
'isAlphanum11'.isAlphanum() true


[edit] last (Integer n) : String

Returns the last *n* characters of *self*, or *self* if its size is less than *n*.

Expression Result
'first operation'.last(8) 'peration'
'first operation'.last(40) 'first operation'
'first operation'.last(-1) invalid


[edit] strcmp (String s1) : Integer

Returns an integer that is either negative, zero or positive depending on whether *s1* is alphabetically less than, equal to or greater than *self*. Note that upper case letters come before lower case ones, so that 'AA' is closer to 'AC' than it is to 'Ab'.

Expression Result
'strcmp operation'.strcmp('strcmp') 10
'strcmp operation'.strcmp('strcmp operation') 0
'strcmp operation'.strcmp('strtok') -17

[edit] strstr (String r) : Boolean

Searches for string *r* in *self*. Returns *true* if found, *false* otherwise.

Expression Result
'strstr operation'.strstr('ope') true
'strstr operation'.strstr('false') false


[edit] strtok (String r, Integer n) : String

Breaks *self* into a sequence of tokens, each of which delimited by any one of the characters in *s1*, and return the next element in this sequence. The parameter flag should be *0* when strtok is called for the first time and will reset the sequence, *1* subsequently so as to access the next element.

Expression Result
'strtok operation'.strtok('opz', 0) 'strt'
'strtok operation'.strtok('pn', 0) 'strtok o'


[edit] substitute (String r, String t ) : String

Substitutes substring *r* in *self* by substring *t* and returns the resulting string. Will return *self* if it contains no occurrence of the substring *r*.

Expression Result
'substitute operation'.substitute('t', 'T') 'subsTiTuTe operaTion'
'foobar foobar foobar'.substitute('t', 'T') 'foobar foobar foobar'


[edit] toLowerFirst () : String

Creates a copy of *self* with its first character converted to lower case and returns it.

Expression Result
'ToLowerFirst operation'.toLowerFirst() 'toLowerFirst operation'


[edit] toUpperFirst () : String

Creates a copy of *self* with its first character converted to upper case and returns it.

Expression Result
'toUpperFirst operation'.toUpperFirst() 'ToUpperFirst operation'


[edit] Standard Integer operations

[edit] toString () : String

Converts the integer *self* to a string.

Expression Result
2009.toString() '2009'


[edit] Standard Real operations

[edit] toString () : String

Converts the real *self* to a string.

Expression Result
(-5.3).toString() '-5.3'

[edit] Acceleo non standard operations reference

[edit] Non-standard *String* operations

[edit] contains (String substring) : Boolean

Returns *true* if *self* contains the substring *substring*, *false* otherwise.

Expression Result
'contains operation'.contains('ins op') true
'contains operation'.contains('2009') false


[edit] endsWith (String substring) : Boolean

Returns *true* if *self* ends with the substring *substring*, *false* otherwise.

Expression Result
'endsWith operation'.endsWith('ation') true
'endsWith operation'.endsWith('endsWith') false
'anything'.endsWith() true


[edit] equalsIgnoreCase (String other) : Boolean

Returns *true* if *self* is equal to the string *other* ignoring case considerations, otherwise returns *false*. Two strings are considered equal ignoring case if they are of the same length and corresponding characters in the two strings are equal ignoring case.

Expression Result
'lowercase'.equalsIgnoreCase('LOWERCASE') true
'lowercase'.equalsIgnoreCase('lowercase') true
'lowercase'.equalsIgnoreCase('lowerCase') true
'lowercase'.equalsIgnoreCase('uppercase') false


[edit] lastIndex (String r) : Integer

Returns the last index of substring *r* in *self*, or -1 if *self* contains no occurrence of *r*. *Important:* String indexes start at 1. Consequently the last character's index in a string is equal to the string's length.

Expression Result
'index operation'.lastIndex('op') 7
'index operation'.lastIndex('o') 14


[edit] matches (String regex) : Boolean

Returns *true* if *self* matches the given regular expression pattern *regex*, *false* otherwise. The regex engine used is that of your runtime JDK. The given pattern is passed "as is" to the method *matches* of the java class *String*. For more about regular expressions, please refer to the JDK API documentation.

Expression Result
'characters and spaces'.matches('[\\w\\s]+') true
'characters and 3 digits'.matches('[\\w\\s]+') false


[edit] replace (String substring, String replacement) : String

Substitutes the first occurrence of substring *substring* in *self* by substring *replacement* and returns the resulting string. Returns *self* if it contains no occurrence of *substring*. Note that both *substring* and *replacement* are treated as regular expressions.

Expression Result
'replace operation'.replace('p', 'P') 'rePlace operation'
'repla ce operation'.replace('(\\\\w+)\\\\s*', '\\\\1') 'replace operation'


[edit] replaceAll (String substring, String replacement) : String

Substitutes all substrings *substring* in *self* by substring *replacement* and returns the resulting string. Returns *self* if it contains no occurrence of *substring*. Note that both *substring* and *replacement* are treated as regular expressions.

Expression Result
'replaceAll operation'.replaceAll('p', 'P') 'rePlaceAll oPeration'
'Repla ce All Operation'.replaceAll('(\\\\w+)\\\\s*', '\\\\1') 'ReplaceAllOperation'


[edit] startsWith (String substring) : Boolean

Returns *true* if *self* starts with the substring *substring*, *false* otherwise.

Expression Result
'startsWith operation'.startsWith('star') true
'startsWith operation'.startsWith('ope') false
'anything'.startsWith() true


[edit] substituteAll (String substring, String replacement) : String

Substitutes all substrings *substring* in self by substring *replacement* and returns the resulting string. Returns *self* if it contains no occurrence of *substring*. Unlike the *replaceAll* operation, neither *substring* nor *replacement* are considered as regular expressions.

Expression Result
'substituteAll operation'.substituteAll('t', 'T') 'subsTiTuTeAll operaTion'


[edit] substring (Integer startIndex) : String

Returns a substring of *self*, starting at *startIndex* (inclusive), until the end of *self*. Returns |invalid| when the *startIndex* is either negative, zero, or greater than *self*'s length. *Important:* String indexes start at 1. Consequently the last character's index in a string is equal to the string's length.

Expression Result
'short term'.substring(7) 'term'
'short term'.substring(-1) invalid
'short term'.substring(0) invalid
'short term'.substring(10) 'm'
'short term'.substring(11) invalid


[edit] tokenize (String substring) : Sequence(String)

Returns a sequence containing all parts of self split around delimiters defined by the characters in String delim.

Expression Result
'tokenize operation'.tokenize('e') Sequence{'tok', 'niz', ' op', 'ration'}
'tokenize operation'.tokenize('i') Sequence{'token', 'ze operat', 'on'}


[edit] trim () : String

Removes all leading and trailing white space characters (tabulation, space, line feed, ...) of *self*.

Expression Result
' trim operation '.trim() 'trim operation'

[edit] Non-standard *EObject* operations

All of the examples from this section are set in the context of this model (with **root** being an instance of *Model* as per the UML metamodel) :


The example model used for the next operations.


[edit] ancestors () : Sequence(EObject)

Returns a Sequence containing the full set of the receiver's ancestors.

Expression Result
Class11.ancestors() Sequence{package11, package1, root}
package11.ancestors() Sequence{package1, root}


[edit] ancestors (OclType oclType) : Sequence(oclType)

Returns the elements of the given type from the set of the receiver's ancestors as a Sequence. The returned sequence's elements are typed with the expected type (so there's no need to invoke @oclAsType(oclType)@ on the sequence or its elements).

Expression Result
Class11.ancestors(Package) Sequence{package11, package1}
package11.ancestors(Package) Sequence{package1}


[edit] eAllContents () : Sequence(EObject)

Returns the whole content tree of the receiver as a Sequence.

Expression Result
root.eAllContents() Sequence{package1, package11, Class11, Class1a, Class1b, package2, Class2, aClas2}
package1.eAllContents() Sequence{package11, Class11, Class1a, Class1b}


[edit] eAllContents (OclType oclType) : Sequence(oclType)

Returns the elements of the given type from the whole content tree of the receiver as a Sequence. The returned sequence's elements are typed with the expected type (so there's no need to invoke @oclAsType(oclType)@ on the sequence or its elements).

Expression Result
root.eAllContents(Class) Sequence{Class11, Class1a, Class1b, Class2}
package1.eAllContents(Class) Sequence{Class11, Class1a, Class1b}


[edit] eContainer (OclType oclType) : oclType

Returns the first ancestor of the given type, i.e. the first ancestor for which @oclIsKindOf(oclType)@ evaluates to **true**. The returned element is typed with the expected type (so there's no need to invoke @oclAsType(oclType)@ on it). *Important:* users of Acceleo 2.x should note that, contrary to what took place in acceleo 2.x, this operation **never** returns *self* even when @self.oclIsKindOf(oclType)@ is true.

Expression Result
Class11.eContainer(Package) package11
package11.eContainer(Package) package1
aClass2.eContainer(Package) package11


[edit] eContents (OclType oclType) : Sequence(oclType)

Returns a sequence of the direct children of *self* that are of the given type, i.e. the direct children for which @oclIsKindOf(oclType)@ evaluates to **true**. The returned sequence's elements are typed with the expected type (so there's no need to invoke @oclAsType(oclType)@ on the sequence or its elements).

Expression Result
package1.eContents(Class) Sequence{Class1b, Class 1a}


[edit] eGet (String featureName) : EJavaObject

This will fetch the value of the feature named *featureName* on the current Object. Return type can as well be a collection as a single value.

Expression Result
package1.eGet('packagedElement') Sequence{Class1b, Class1a, package11}
package1.eGet('name') 'package1'


[edit] eInverse () : Sequence(EObject)

Returns the set of all objects referencing *self*.

Expression Result
Class2.eInverse() Sequence{package11,aClass2}
package11.eInverse() Sequence{package1}

[edit] eInverse (OclType oclType) : Sequence(oclType)

Returns the elements of the given type from the set of the inverse references of *self*. The returned sequence's elements are typed with the expected type (so there's no need to invoke @oclAsType(oclType)@ on the sequence or its elements).

Expression Result
Class2.eInverse(Property) Sequence{aClass2}
Class2.eInverse(Package) Sequence{}


[edit] followingSiblings () : Sequence(EObject)

Returns a Sequence containing the full set of the receiver's following siblings.

Expression Result
Class11.followingSiblings() Sequence{}
Class1b.followingSiblings() Sequence{Class1a, package11}


[edit] followingSiblings (OclType oclType) : Sequence(oclType)

Returns the elements of the given type from the set of the receiver's following siblings as a Sequence. The returned sequence's elements are typed with the expected type (so there's no need to invoke @oclAsType(oclType)@ on the sequence or its elements).

Expression Result
Class1b.followingSiblings(Package) Sequence{package11}
Class1b.followingSiblings(Class) Sequence{Class1a}
Class1a.followingSiblings(Class) Sequence{}


[edit] precedingSiblings () : Sequence(EObject)

Returns a Sequence containing the full set of the receiver's preceding siblings.

Expression Result
package11.precedingSiblings() Sequence{Class1b, Class1a}
Class11.precedingSiblings() Sequence{}
Class1a.precedingSiblings() Sequence{Class1b}


[edit] precedingSiblings (OclType oclType) : Sequence(oclType)

Returns the elements of the given type from the set of the receiver's preceding siblings as a Sequence. The returned sequence's elements are typed with the expected type (so there's no need to invoke @oclAsType(oclType)@ on the sequence or its elements).

Expression Result
package11.precedingSiblings() Sequence{Class1b, Class1a}
Class1a.precedingSiblings(Package) Sequence{}
Class1a.precedingSiblings(Class) Sequence{Class1b}


[edit] siblings () : Sequence(EObject)

Returns a Sequence containing the full set of the receiver's siblings.

Expression Result
Class11.siblings() Sequence{}
Class1a.siblings() Sequence{package11, Class1b}


[edit] siblings (OclType oclType) : Sequence(oclType)

Returns the elements of the given type from the set of the receiver's siblings as a Sequence. The returned sequence's elements are typed with the expected type (so there's no need to invoke @oclAsType(oclType)@ on the sequence or its elements).

Expression Result
Class11.siblings(Class) Sequence{}
Class1a.siblings(Class) Sequence{Class1b}

[edit] Non-standard *OclAny* operations

  • A note on properties*: properties can be accessed only if they've been added through the API. For this purpose, a number of facilities is provided. You can either override the generated launcher's *addProperties* method and add new paths to properties files there, call manually one of the methods **AcceleoService#addPropertiesFile()** or manually add key/value pairs through **AcceleoService#addProperties()**. Take note that the key/value pairs manually added will *always* take precedence over the properties taken from *.properties* files; and the *first* added property file will always take precedence over subsequently added files.

The example on all four *getProperty* variants will take into account the following setup: we provided the environment with a properties file *a.properties* containing the key/value pair:

  a.b.c = This is a parameterized property: {0}

Then we provided it with a file *b.properties* containing the pairs:

  a.b.c.d = This is a standard property
  a.b.c = Parameterized property with a name conflict: {0}

[edit] current (Integer index) : OclAny

Returns the value of the context *index* ranks above the current context. The following example is explained line by line in the "result" column.

[for (p: Package | root.packagedElement)]     Iterates over all packages of the Model root
   [for (c: Class | p.packagedElement)]       Iterates over all classes of the current package
      [current(0)/]                           Allows access to the current class (equivalent to c)
      [current(1)/]                           Allows access to the current package (equivalent to p)
      [current(2)/]                           Allows access to self as it was before the first for loop
   [/for]
[/for]

[edit] current (OclType filter) : OclAny

This will have the same effect as current(Integer) except that is will return the first context (*self* variable) of the given type, at or above the current one. The following example is explained line by line in the "result" column.

[for (p: Package | root.packagedElement)]      Iterates over all packages of the Model root
    [for (c: Class | p.packagedElement)]       Iterates over all classes of the current package
        [current(Class)/]                      Allows access to the current class (equivalent to c)
        [current(Package)/]                    Allows access to the current package (equivalent to p)
        [current(Model)/]                      Allows access to the the root Model
    [/for]
[/for]

[edit] getProperty (String key) : OclAny

Returns the value of the property corresponding to the given *key*. Note that parameterized properties will be returned "as is" by this operation (parameters are not processed).

Expression Result
getProperty('a.b.c') 'This is a parameterized property: {0}'
getProperty('a.b.c.d') 'This is a standard property'
getProperty('a.b.c.d.e') null


[edit] getProperty (String key, Sequence(OclAny) parameters) : OclAny

Returns the value of the property corresponding to the given key, with its parameters substituted with the given values if any.

Expression Result
getProperty('a.b.c', Sequence{'substitution'}) 'This is a parameterized property: substitution'
getProperty('a.b.c', Sequence{}) 'This is a parameterized property: {0}'
getProperty('a.b.c.d', Sequence{'substitution'}) 'This is a standard property'


[edit] getProperty (String name, String key) : OclAny

Returns the value of the property corresponding to the given *key* from a properties file corresponding to the given *name*. Note that parameterized properties will be returned as is with this.

Expression Result
getProperty('b.properties', 'a.b.c') 'Parameterized property with a name conflict: {0}'
getProperty('a.properties', 'a.b.c.d') invalid


[edit] getProperty (String name, String key, Sequence(OclAny) parameters) : OclAny

Returns the value of the property corresponding to the given *key* from a properties file corresponding to the given *name*, with its parameters substituted with the given values if any.

Expression Result
getProperty('b.properties', 'a.b.c', Sequence{'substitution'}) 'Parameterized property with a name conflict: substitution'
getProperty('b.properties', 'a.b.c', Sequence{}) 'Parameterized property with a name conflict: {0}'
getProperty('a.properties', 'a.b.c.d', Sequence{'substitution'}) invalid


[edit] invoke (String class, String method, Sequence(OclAny) arguments ) : OclAny

Invokes the Java method *method* of class *class* with the given arguments. This will return OclInvalid if the method cannot be called in any way (bad arguments, mispelled name, mispelled signature, encapsulation errors, ...). This is only intended to be used to call Java methods for now.

Expression Result
invoke('java.lang.String', 'toUpperCase()', Sequence{root.name}) ROOT


[edit] toString () : String

Returns the String representation of the receiver. Examples depend on the "toString()" implementation of *self*. Let's assume it has been changed to return the object's name:

Expression Result
Class11.toString() 'Class11'

[edit] Non-standard *Collection* operations

[edit] sep (String separator) : Sequence(OclAny)

Returns all elements from the source collection separated by an element composed of the String *separator*.

Expression Result
package1.eContents().name.sep('2009') Sequence{'Package11', '2009', 'Class1a', '2009', 'Class1b'}
package1.eContents().sep('2009') Sequence{Package11, '2009', Class1a, '2009', Class1b}


[edit] filter (OclType type) : Sequence(OclType)

Filters out of the collection all elements that are not instances of the given type or any of its subtypes. The returned collection is typed according to *type*. Makes it easier to write @select(e | e.oclIsKindOf(type)).oclAsType(type)@.

Expression Result
package1.eContents().filter(Class) Sequence{Class1b, Class1a}


[edit] reverse () (Only on ordered collections)

Reverses the order of the collection: the last element becomes the first and vice-versa. Only available on **ordered collections** (Sequence and OrderedSet).

Expression Result
OrderedSet {1, 2, 3} OrderedSet {3, 2, 1}
Sequence {1, 2, 3} Sequence {3, 2, 1}


[edit] lastIndexOf (T elt) : Integer (Only on ordered collections)

Returns the position of the given element in the collection it is applied to. Only available on **ordered collections** (Sequence and OrderedSet).

Expression Result
OrderedSet {1, 2, 1}->lastIndexOf(1) 3
Sequence {1, 2, 3}->lastIndexOf(4) -1
Sequence {1, null}->lastIndexOf(null) 2
Sequence {1, 2, 3}->lastIndexOf(null) -1



Acceleo Portal
Project Project · Installation · New & noteworthy · Release review · API policy · Retention policy · Next · Checklist
Features Acceleo Features · Runtime · Acceleo editor · Views & Perspective · Debugger · Profiler · Traceability · Wishlist · Interpreter · Maven
User documentation Getting Started · Acceleo operations reference · OCL operations reference · Text Production Rules · Migration From Acceleo 2.x · Best Practices · Videos · FAQ
Developer documentation Source code · How to contribute · Compatibility · MOFM2T specification · OCL specification
Community Conferences · Twitter & Blogs · Professional Support · Report a bug