Derived settable attributes
No edit summary
(Replacing message template with parser tag)
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<message>Write the content here to display this box</message>
=== What Are These? ===
=== What Are These? ===
* Derived attributes use an OCL expression to calculate the presentation of another attribute.
* Derived attributes use an OCL expression to calculate the presentation of another attribute.
Line 10: Line 11:
This special handling makes user input much simpler because it handles the user's need to change any of the three values, updating the others behind the scenes.
This special handling makes user input much simpler because it handles the user's need to change any of the three values, updating the others behind the scenes.
[[File:TimeSpent class example.png|thumb|none]]
[[File:TimeSpent class example.png|thumb|none]]
 
* '''/Date''' is a derived attribute for easy access to a neighboring class containing the date in DateTime format.
'''/Date''' is a derived attribute for easy access to a neighboring class containing the date in DateTime format.
* '''/EffectiveToTime''' is a derived attribute used as a companion to the FromTime, again for symmetry in accessing the information.
 
'''/EffectiveToTime''' is a derived attribute used as a companion to the FromTime, again for symmetry in accessing the information.
 
Support function '''StringToTime()'''
Support function '''StringToTime()'''


Line 24: Line 22:
   DateTime.Parse('1900-01-01 ' + aText)
   DateTime.Parse('1900-01-01 ' + aText)
  endif
  endif
Note the addition of "''':00'''" to the text if it is short. This helps the user out of entering just the hour part.
* Note the addition of "''':00'''" to the text if it is short. This helps the user out of entering just the hour part.
 
* '1900-01-01' is an ugly hack to prevent storing the current date as part of the time entry. It would still work, but this is slightly better.
'1900-01-01' is an ugly hack to prevent storing the current date as part of the time entry. It would still work, but this is slightly better.


===== Property Inspector =====
===== Property Inspector =====
Line 45: Line 42:
  self.FromTime := self.StringToTime(vInputParameter)
  self.FromTime := self.StringToTime(vInputParameter)


'''/HoursText: String?'''
===== '''/HoursText: String?''' =====
 
''OCL''
''OCL''


Line 59: Line 55:
  self.Hours := Decimal.Parse(vInputParameter.Replace(',', '.')).Round(2)
  self.Hours := Decimal.Parse(vInputParameter.Replace(',', '.')).Round(2)


'''/ToTimeText: String?'''
===== '''/ToTimeText: String?''' =====
 
The to-time is all calculated and only exists when showing and entering values.
The to-time is all calculated and only exists when showing and entering values.


Line 71: Line 66:
  endif
  endif


''EAL (OclSet)''
===== ''EAL (OclSet)'' =====
 
Handle both setting '''Hours''' or '''FromTime''' based on what information is already present.
Handle both setting '''Hours''' or '''FromTime''' based on what information is already present.


Line 81: Line 75:
   0
   0
  endif
  endif
    [[Category:MDriven Designer]]
    [[Category:MDriven Designer]]
See also:  
'''See also:'''


[[Derived attributes & associations]]
[[Training:Derived attributes & associations|Derived attributes & associations]]


[[Derived settable associations]]
[[Derived settable associations]]
{{Edited|July|12|2024}}
[[Category:TOC]]

Latest revision as of 07:41, 17 June 2024

What Are These?

  • Derived attributes use an OCL expression to calculate the presentation of another attribute.
  • Derived settable attributes use EAL to do the reverse, i.e. setting the source attribute from the entered value. The user input is in the vInputParameter variable.

This opens up special handling of user input and "user shortcuts" in the UI - for example, accepting only a number as a time entry.

Example with Time (DateTime) and Decimal

This example uses FromTimeText, HoursText, and ToTimeText for user input, but only FromTime and Hours for storing information in the database.

This special handling makes user input much simpler because it handles the user's need to change any of the three values, updating the others behind the scenes.

TimeSpent class example.png
  • /Date is a derived attribute for easy access to a neighboring class containing the date in DateTime format.
  • /EffectiveToTime is a derived attribute used as a companion to the FromTime, again for symmetry in accessing the information.

Support function StringToTime()

To help the other function with conversion, a help function like this was created:

if aText.length <= 2 then
  DateTime.Parse('1900-01-01 ' + aText + ':00')
else
  DateTime.Parse('1900-01-01 ' + aText)
endif
  • Note the addition of ":00" to the text if it is short. This helps the user out of entering just the hour part.
  • '1900-01-01' is an ugly hack to prevent storing the current date as part of the time entry. It would still work, but this is slightly better.
Property Inspector

Below is the property inspector setting for a derived settable attribute. Note the AttributeMode and then the OCL and OclSet code.

DerivedSettable property inspector.png
/FromTimeText: String?

OCL

if self.FromTime.notNull then
  self.FromTime.formatDateTime('HH:mm')
else
  String.nullValue
endif

EAL (OclSet)

self.FromTime := self.StringToTime(vInputParameter)
/HoursText: String?

OCL

In Sweden, we use the comma instead of the dot as a decimal separator. Hard-coded replacement:

self.Hours.ToString('N2').Replace('.', ',')

EAL (OclSet)

Enable the use of both the comma and dot as decimal separators. Round to 2 decimals.

self.Hours := Decimal.Parse(vInputParameter.Replace(',', '.')).Round(2)
/ToTimeText: String?

The to-time is all calculated and only exists when showing and entering values.

OCL

if self.FromTime.notNull then
  self.FromTime.AddHours(self.Hours.Value.ToDouble).formatDateTime('HH:mm')
else
  String.nullValue
endif
EAL (OclSet)

Handle both setting Hours or FromTime based on what information is already present.

if self.FromTime.notNull then
  self.Hours := Decimal.Create(self.StringToTime(vInputParameter).Subtract(self.FromTime).TotalHours)
else
  self.FromTime := self.StringToTime(vInputParameter).AddHours(-self.Hours.ToDouble);
  0
endif

See also:

Derived attributes & associations

Derived settable associations

This page was edited 95 days ago on 06/17/2024. What links here