SubstantiveValueDomain¶
Generalization is ValueDomain.
Superclass hierarchy
Definition¶
Value domain for a substantive conceptual domain.
Examples¶
All real decimal numbers relating to the subject matter of interest between 0 and 1 specified in Arabic numerals. [GSIM 1.1]. The codes “M” male and “F” for female .
Explanatory notes¶
In DDI-CDI the value domain for a variable is separated into “substantive” and “sentinel” values. Substantive values are the values of primary interest. Sentinel values are additional values that may carry supplementary information, such as reasons for missing. This duality is described in ISO 11404. Substantive values for height might be real numbers expressed in meters. The full value domain might also include codes for different kinds of missing values - one code for “refused” and another for “don’t know”. Sentinel Values may also convey some substantive information and at the same time represent missing values. An example might be where a numeric variable like number of employees be sometimes a count and sometimes a code representing a range of counts in order to avoid disclosure of information about a specific entity.
The SubstantiveValueDomain may use either a ValueDescription, for described values, or a CodeList for enumerated values, or both.
A value domain may consist of substantive values or sentinel values. Substantive values are those associated directly with some subject matter area. They do not address concerns around processing, such as missing values. Substantive values are called “regular values” in ISO/IEC 11404 - General purpose datatypes.
The enumerated case is one where all values are listed. An example is the categorical values for gender: The conceptual domain could consist of the concept of male and the concept of female. These might be represented in codes and associated labels as 1 (“”Male”) 2 (“”Female”)
The described case is one where some description is needed to define the set of values. Take the following description for height in meters: “a real number between 0 and 3, represented to two Arabic decimal places”. This description might be structured in some way to be machine actionable (datatype””double”, min”0, max”3, decimals”2).
Subclasses¶
Inherited 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..* |
|
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 |
Associations¶
Multiplicity |
Association |
Navigable Class |
Multiplicity |
---|---|---|---|
0..* |
SubstantiveValueDomain_takesConceptsFrom_SubstantiveConceptualDomain |
0..1 |
|
0..* |
SubstantiveValueDomain_takesValuesFrom_EnumerationDomain |
0..1 |
|
0..* |
SubstantiveValueDomain_isDescribedBy_ValueAndConceptDescription |
0..1 |
TBD
Diagram¶
TBD