MDrivenDesignerPropertyInspectorHints
No edit summary
(Automatically adding template at the end of the page.)
 
(8 intermediate revisions by 4 users not shown)
Line 1: Line 1:
This page is fetched by MDriven designer to provide additional information per property in the Property inspector.  
This page is fetched by the MDriven Designer to provide additional information per property in the Property inspector.  


Note to authors: case-insensitive, key must start with #, key is shown in MDrivenDesigner unless value is found below, will not render any links or markup correctly so use plain text
'''Note to authors:''' case-insensitive, the key must start with #, and the key is shown in MDrivenDesigner unless the value is found below, will not render any links or markup correctly so use plain text.
{| class="wikitable"
{| class="wikitable"
!#Class.Prop
!#Class.Prop
Line 10: Line 10:
|-
|-
|#attribute.codecomment
|#attribute.codecomment
|A short documentation available for your usage
|A short documentation is available for your usage
|-
|-
|#attribute.HasUserCode
|#attribute.HasUserCode
|When used in MDriven Framework this flag set will route all access thru the code accessor that has partial methods implementation that can be implemented by you  
|When used in MDriven Framework, this flag set will route all access through the code accessor that has partial methods implementation that can be implemented by you.
|-
|-
|#attribute.SetterVisibility
|#attribute.SetterVisibility
Line 22: Line 22:
|-
|-
|#attribute.defaultDBValue
|#attribute.defaultDBValue
|When attributes are added to classes that already has data in a database - and if this attribute does not allow null - then we need to supply what default value existing rows should have. Common for state attributes: 'SomeState'
|When attributes are added to classes that already have data in a database - and if this attribute does not allow null - then we need to supply what default value existing rows should have. Common for state attributes: 'SomeState' [[DefaultDBValue|See also: DefaultDBValue]]
|-
|-
|#attribute.DelayedFetch
|#attribute.Delayed Fetch
|If set to True, the attribute's data will not be fetch at once with the rest of the objects attributes. It will only be fetched on explicit use. Usually used BLOB och Image attributes.
|If set to True, the attribute's data will not be fetched at once with the rest of the object's attributes. It will only be fetched on explicit use. Usually used BLOB och Image attributes.
|-
|-
|#attribute.FormerNames
|#attribute.FormerNames
|Used during evolve of the database. If a former name is specified, data will be migrated to the new name from the specified old name.
|Used during the evolution of the database. If a former name is specified, data will be migrated to the new name from the specified old name.
|-
|-
|#association.derived
|#association.derived
|A derived association is like a calculated relation between classes. You enter the DerivationOcl for one or both ends of the association, as wanted.Is always updated using subscription to changes
|A derived association is like a calculated relation between classes. You enter the DerivationOcl for one or both ends of the association, as wanted. It is always updated using a subscription to changes
|-
|-
|#associationend.derivationocl
|#associationend.derivationocl
Line 37: Line 37:
|-
|-
|#associationend.aggregation
|#associationend.aggregation
|This sets the how "tight" in a business sense a class is to another. Note that if you set Composite, deleting the a owning class object deletes the owned object
|This sets how "tight" in a business sense a class is to another. Note that if you set Composite, deleting the owning class object deletes the owned object
|-
|-
|#associationend.effectivename
|#associationend.effectivename
Line 43: Line 43:
|-
|-
|#associationend.ordering
|#associationend.ordering
|Designates is this is an ordered or unordered collection of objects in the association. This is not to be confused with the orderBy OCL operator.
|Designates as an ordered or unordered collection of objects in the association. This is not to be confused with the orderBy OCL operator.
|-
|-
|#associationend.embed
|#associationend.embed
Line 49: Line 49:
|-
|-
|#associationend.saveaction
|#associationend.saveaction
|Describes how the first value is set and if it can change. None: No special action. Freeze: Save the first time, changes not allowed. DbAssign: It's up to the database engine to maintain the association
|Describes how the first value is set and if it can change. None: No special action. Freeze: Save the first time, changes are not allowed. DbAssign: It's up to the database engine to maintain the association
|-
|-
|#attribute.attributemode
|#attribute.attributemode
Line 60: Line 60:
|EAL to reverse-derive the value from for example a string. See "Derived Settable" in the wiki.
|EAL to reverse-derive the value from for example a string. See "Derived Settable" in the wiki.
|-
|-
|
|#attribute.presentationunit
|
|UI engines typically use this to render the unit of measure in the label like Presentation(Kg)
|-
|
|
|}
|}
[[Category:MDriven Designer]]
[[Category:MDriven Designer]]
{{Edited|July|12|2024}}

Latest revision as of 15:36, 10 February 2024

This page is fetched by the MDriven Designer to provide additional information per property in the Property inspector.

Note to authors: case-insensitive, the key must start with #, and the key is shown in MDrivenDesigner unless the value is found below, will not render any links or markup correctly so use plain text.

#Class.Prop Description
#aaa.bbb Longish description without markup
#attribute.codecomment A short documentation is available for your usage
#attribute.HasUserCode When used in MDriven Framework, this flag set will route all access through the code accessor that has partial methods implementation that can be implemented by you.
#attribute.SetterVisibility Attributes are default public - both set and get - this property allows you to change the visibility of the set operator
#attribute.column name This is the name the column in the database will get - by default it is the same as the attribute - this is achieved by stating <Name>
#attribute.defaultDBValue When attributes are added to classes that already have data in a database - and if this attribute does not allow null - then we need to supply what default value existing rows should have. Common for state attributes: 'SomeState' See also: DefaultDBValue
#attribute.Delayed Fetch If set to True, the attribute's data will not be fetched at once with the rest of the object's attributes. It will only be fetched on explicit use. Usually used BLOB och Image attributes.
#attribute.FormerNames Used during the evolution of the database. If a former name is specified, data will be migrated to the new name from the specified old name.
#association.derived A derived association is like a calculated relation between classes. You enter the DerivationOcl for one or both ends of the association, as wanted. It is always updated using a subscription to changes
#associationend.derivationocl An OCL statement that "calculates" the resulting item or collection for the association
#associationend.aggregation This sets how "tight" in a business sense a class is to another. Note that if you set Composite, deleting the owning class object deletes the owned object
#associationend.effectivename This is the used name. It's either the default name or the specifically set name in "Name"
#associationend.ordering Designates as an ordered or unordered collection of objects in the association. This is not to be confused with the orderBy OCL operator.
#associationend.embed Controls where database keys are placed. If true, a key attribute will be placed in the "begin end" of the association pointing to this class object id
#associationend.saveaction Describes how the first value is set and if it can change. None: No special action. Freeze: Save the first time, changes are not allowed. DbAssign: It's up to the database engine to maintain the association
#attribute.attributemode Derived uses OCL to calculate value. DerivedSettable uses EAL to reverse-derive the value from for example a string. See "Derived Settable" in the wiki.
#attribute.derivationocl OCL to calculate the attribute's value. See "Derived Settable" in the wiki.
#attribute.derivationoclset EAL to reverse-derive the value from for example a string. See "Derived Settable" in the wiki.
#attribute.presentationunit UI engines typically use this to render the unit of measure in the label like Presentation(Kg)
This page was edited 96 days ago on 02/10/2024. What links here