ValueDomain¶
Class is abstract. Generalization is AnnotatedIdentifiable.
Superclass hierarchy
Definition¶
Set of permissible values for a variable [adapted from ISO/IEC 11179].
Examples¶
Age categories with a numeric code list; Age in years; Young, Middle-aged and Old.
Explanatory notes¶
The values can be described by enumeration or by an expression. Value domains can be either substantive/sentinel, or described/enumeration.
Properties¶
Name |
Description |
Data Type |
Multi- plicity |
---|---|---|---|
displayLabel
from ValueDomain
|
A display label for the object. May be expressed in multiple languages. Repeat for labels with different content, for example, labels with differing length limitations. |
0..* |
|
recommendedDataType
from ValueDomain
|
The data types that are recommended for use with this domain. |
0..* |
Inherited Properties¶
Name |
Description |
Data Type |
Multi- plicity |
---|---|---|---|
agency
from Identifiable
|
Agency expressed as filed with the DDI Agency ID registry [registry.ddialliance.org] with optional additional sub-agency extensions. |
:ref:`` |
1..1 |
id
from Identifiable
|
ID conforming to the allowed structure of the DDI Identifier and must be unique within the Agency. |
:ref:`` |
1..1 |
isPersistent
from Identifiable
|
Default value is false indicating that the content of the current version may change (may be in development mode). Set to true when the content of this version will no longer change. |
:ref:`` |
1..1 |
isUniversallyUnique
from Identifiable
|
Default value is false. If the id of the object was created as a Universally Unique ID (UUID) set to true. |
:ref:`` |
1..1 |
localId
from Identifiable
|
Locally used identifier unique with a specified context, such as a variable name within a dataset. |
0..* |
|
version
from Identifiable
|
Version number of the object. |
:ref:`` |
1..1 |
versionDate
from Identifiable
|
Date and time the object was changed expressed in standard ISO formats. |
0..1 |
|
versionRationale
from Identifiable
|
Reason for making a new version of the object. |
0..1 |
|
versionResponsibility
from Identifiable
|
Contributor who has the ownership and responsibility for the current version. |
:ref:`` |
0..1 |
Diagram¶
TBD