Chapter | Name | Excerpt | Usage |
---|
Array Operations | arrays_of_arrays |
Multiexcerpt |
---|
MultiExcerptName | arrays_of_arrays |
---|
shouldDisplayInlineCommentsInIncludes | false |
---|
| Arrays of arrays are not supported by the Designer. |
| |
Array Operations | creating_arrays |
Multiexcerpt |
---|
MultiExcerptName | creating_arrays |
---|
| You can create arrays using the create statement (see action script example below): Code Block |
---|
| create anArray;
append "Hello World!" to anArray; |
Most of the time the xUML Runtime will create the array implicitly on appending the first item. There is one exception to this rule, though: Arrays that contain array elements having a complex type with multiplicity. Let's assume you have an array of complex type ArrayElement and this complex type has a property subArray with multiplicity 0..*. What you can do, if subArray is NULL : Code Block |
---|
set array1[0].subArray = anotherArray; |
The reference subArray is changed to point to anotherArray . What you can't do, if subArray is NULL: Code Block |
---|
append "something" to array1[0].subArray; |
In this case (get statement on the right side of a statement), the Runtime will throw a get error for array1[0].subArray .
|
| |
Blob Operations | blob_definition
|
Multiexcerpt |
---|
MultiExcerptName | blob_definition |
---|
shouldDisplayInlineCommentsInIncludes | false |
---|
| A blob represents base64-encoded arbitrary binary data. |
| |
DateTime Operations | calculate_dates |
Multiexcerpt |
---|
MultiExcerptName | calculate_dates |
---|
shouldDisplayInlineCommentsInIncludes | false |
---|
| This is calculated e.g. as follows: - 31.01.2017 + 1 month = 31.02.2017
- The resulting date 31.02.2017 is normalized to 03.03.2017.
|
| |
DateTime Operations | timeticks |
Multiexcerpt |
---|
MultiExcerptName | timeticks |
---|
shouldDisplayInlineCommentsInIncludes | false |
---|
| Within this context TimeTicks are UNIX timestamps. Unix time, or POSIX time, is a system for describing points in time: it is the number of seconds elapsed since midnight UTC of January 1, 1970, not counting leap seconds. It is widely used not only on Unix-like operating systems but also in many other computing systems. |
| |
Integer Operations | boolean_definition
|
Multiexcerpt |
---|
MultiExcerptName | boolean_definition |
---|
shouldDisplayInlineCommentsInIncludes | false |
---|
| Boolean values represent binary-valued logic (true, false). |
| |
Integer Operations | datetime_definition
|
Multiexcerpt |
---|
MultiExcerptName | datetime_definition |
---|
shouldDisplayInlineCommentsInIncludes | false |
---|
| CCYY-MM-DDThh:mm:ss[.sss] [Z|[+|-]hh:mm]
Whereas "Z" stands for the time zone: Coordinated Universal Time (UTC). The W3C value space of DateTime is closely related to the dates and times described in ISO 8601. |
| |
Integer Operations | float_definition
|
Multiexcerpt |
---|
MultiExcerptName | float_definition |
---|
shouldDisplayInlineCommentsInIncludes | false |
---|
| A float corresponds to the IEEE single-precision 32-bit floating-point type. Lexical representation: [white spaces] [+|-][nnn][.nnn][e|E[+|-]nnn] (where white spaces are any tab or space character; nnn may be any number of digits) |
| |
Integer Operations | integer_definition
|
Multiexcerpt |
---|
MultiExcerptName | integer_definition |
---|
shouldDisplayInlineCommentsInIncludes | false |
---|
| The W3C defines integers as "decimal", which represents arbitrary precision decimal numbers. |
| - Available Base Types
- Integer Operations
|
Integer Operations | string_definition
|
Multiexcerpt |
---|
MultiExcerptName | string_definition |
---|
shouldDisplayInlineCommentsInIncludes | false |
---|
| A string is a set of finite-length sequences of a character set (the Bridge uses UTF-8 internally). |
| |
JSON | writeTypeDiscriminator |
Multiexcerpt |
---|
MultiExcerptName | writeTypeDiscriminator |
---|
| Use writeTypeDiscriminator to suppress the generation of xUML type properties ("e2e:type") to the generated JSON. If this option is true, the Runtime will write the original xUML type to the generated JSON in form of "e2e:type": "<name of the original xUML type>" if the type being serialized does not match the expected metadata. |
|
|
Types | list_type_strings |
Multiexcerpt |
---|
MultiExcerptName | list_type_strings |
---|
shouldDisplayInlineCommentsInIncludes | false |
---|
| Find below a list of all Base Types of the Designer together with their type string as returned by typeOf() and staticTypeOf() . Bridge Base Type | Type String |
---|
Any | urn:Base_Types.Any | Array | urn:Base_Types.Array | Blob | urn:Base_Types.Blob | Boolean | urn:Base_Types.Boolean | DateTime | urn:Base_Types.DateTime | Float | urn:Base_Types.Float | Integer | urn:Base_Types.Integer | String | urn:Base_Types.String |
Other, e.g. model specific, types can be referenced via their path in the service panel, e.g. a class Customer that has been defined in a package Service/Classes/Customer would have the following type string: " urn:Service.Classes.Customer ". |
|
|
XML Mapping | classToXML_mapping_rules |
Multiexcerpt |
---|
MultiExcerptName | classToXML_mapping_rules |
---|
shouldDisplayInlineCommentsInIncludes | false |
---|
| By default the following mapping rules apply: - Class attributes are mapped to XML attributes.
- Association ends are mapped to XML elements.
These default rules can be overridden by stereotypes (XML, XMLNamespace, XMLElement, XMLAttribute, XMLCharacters) on class attributes. More about these mapping rules, stereotypes and tagged values (e.g. for number and date & time formatting) can be found on Controlling the XML Serialization With Stereotypes. |
| XML Mapping | classToXML_mapping_rules
| Multiexcerpt |
---|
MultiExcerptName | classToXML_mapping_rules |
---|
shouldDisplayInlineCommentsInIncludes | false |
---|
| By default the following mapping rules apply: - Class attributes are mapped to XML attributes.
- Association ends are mapped to XML elements.
These default rules can be overridden by using the stereotypes XMLElement, XMLAttribute, and XMLCharacters on class properties. More about these mapping rules, stereotypes and tagged values (e.g. for number and date & time formatting) can be found on Controlling the XML Serialization With Stereotypes. |
|
|
XML Mapping | classToXML_options
|
Multiexcerpt |
---|
MultiExcerptName | classToXML_options |
---|
shouldDisplayInlineCommentsInIncludes | false |
---|
| This optional parameter is an object of type XMLComposeOptions.
Its attributes are: Attribute | Type | Description | Example |
---|
prolog | Array of String | The string values are inserted right before the root element of the generated document. This mechanism can be used to insert processing instructions (e.g. DTD and Schema references), comments, entities or any other prolog you may think of. However, be aware that using prolog arrays makes it easy to generate non-well-formed documents. |
| timezone | String | Time zone string as specified on Time Zones. The timezone is used to print dateTime expressions. If no timezone is given, UTC is used. If " local" is used, the date/time is printed relative to the local timezone of the server, e.g. 2012-10-01T12:36:47.0+02:00 (the timezone of the server is UTC+02:00). | "Australia/Melbourne" , "CET ", "Etc/GMT+10"
| dateFormatString | String | A format string to be used when printing DateTime values as xs:date (e.g. %F to print a date without timezone). The allowed formats can be found on Time Zones. If nothing is defined, the XSD standard is used. | %F | encoding | String | Encoding of the target xml. Default encoding is UTF-8. For a list of possible encodings see Charset Definitions. | "UTF-8" | rootName | String | Name of the generated XML root element. Use this tagged value to override the default behavior. | TXTRAW01 | rootNamespace | String | Name of the namespace of the generated XML root element. |
|
|
|
|