Synopsis
Overview
Specification
classes
A class is any important non technical thing that is used by an application.
field |
required |
Description |
name |
Yes |
Unique name amongst entities |
parentName |
No |
Must be an entity found in the model |
attributes |
name |
Yes |
Unique name amongst data for this entity |
type |
Yes |
Options:
- String
- int
- double
- float
- boolean
- Date
- Any enum defined within the model
|
defaultValue |
No |
If not assigned, defaults to an empty value |
associations |
name |
Yes |
Uniquely named amongst relations for this entity |
type |
Yes |
Any entity defined within the model |
multiplicity |
No |
If none assigned, defaults to OneToOne,
Options:
- OneToOne
- OneToMany
- ManyToOne
- ManyToMany
|
enums
An enum or enumerated type is a type whose legal values consist of a fixed set of constants. Common examples include days of the week, which take the values Monday, Tuesday, Wednesday, etc….
field |
required |
Description |
name |
Yes |
Unique name amongst enums |
attributes |
name |
Yes |
Unique amongst attributes for this enum |
type |
Yes |
Options:
|
defaultValue |
Yes |
Typically, the default value is incremental from one declaration to the next, i.e. 0, 1, 2, etc… Some tech stacks will ignore this and assign an enum value according to the language specification. |