ValueAndConceptDescription inherited from CDIFDataStructure

DiscoveryDataDescriptionStructure::Classes::ValueAndConceptDescription

Definition

Documentation

Original

Reference

cdi:ValueAndConceptDescription

Definition

Formal description of a set of values.

Examples

1. The integers between 1 and 10, inclusive. The values of x satisfying the logicalExpression property: " (1 less than or equal to X less than or equalto 10) AND mod(x,10)=0" Also described with minimumValueInclusive = 1 and maximumValueInclusive = 10 (and datatype of integer). 2. The upper case letters A through C and X described with the regularExpression "/[A-CX]/". 3. A date-time described with the Unicode Locale Data Markup Language pattern yyyy.MM.dd G 'at' HH:mm:ss zzz.

Explanatory notes

The value and concept description may be used to describe either a value domain or a conceptual domain. For a value domain, the value and concept description contains the details for a described" domain (as opposed to an enumerated domain). There are a number of properties which can be used for the description. The description could be just text such as: "an even number greater than zero", or a more formal logical expression like "x>0 and mod(x,2)=0". A regular expression might be useful for describing a textual domain. It could also employ a format pattern from the Unicode Locale Data Markup Language (LDML: http://www.unicode.org/reports/tr35/tr35.html). Some conceptual domains might be described with just a narrative. Others, though, might be described in much the same way as a value domain depending on the specificity of the concept. In ISO 11404 a value domain may be described either through enumeration or description, or both. This class provides the facility for that description. It may be just a text description, but a description through a logical expression is machine actionable and might, for example, be rendered as an integrity constraint. If both text and a logical expression are provided the logical expression is to be taken as the canonical description. The logical expression could conform to an expression syntax like that of the Validation and Transformation Language (VTL: https://sdmx.org/?page_id=5096) or the Structured Data Transformation Language (SDTL: https://ddialliance.org/products/sdtl/1.0).

CDIF

Definition

Formal description of a set of values.

Scope

Description of the values / concepts a value domain admits: ranges (min/max value inclusive/exclusive), patterns (regularExpression, formatPattern, logicalExpression), classification level, recommended data type, default / required / external-definition info, plus general label / description / purpose annotations.

Diagram

Inheritance

No generalization relationships.

Attributes

Name	Type	Multiplicity	Description
identifier	XsdAnyUri	[0..1]	Documentation Original Reference schema:identifier Definition The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details. Scope Domain: Thing (https://schema.org/Thing). Range: PropertyValue (https://schema.org/PropertyValue), Text (https://schema.org/Text), URL (https://schema.org/URL). CDIF Definition The primary identifier for the dataset; other identifiers should be listed in the sameAs field. Schema.org has three ways of encoding identifiers-- a text description, a URL, or by using the schema:PropertyValue field. The Science on Schema.org guidance strongly recommends using the PropertyValue approach. see https://github.com/ESIPFed/science-on-schema.org .... Dataset.md#identifier. Ideally, for any given data provided they would provide identifiers either all as strings or all as identifier_type. Scope @id.
logicalExpression	string	[0..1]	Documentation Original Reference cdi:logicalExpression CDIF Definition A logical expression where the values of "x" making the expression true are the members of the set of valid values. For example, "(all reals x such that x > 0)" describes the real numbers greater than 0. Scope cdi:logicalExpression - logical expression constraining the domain.
regularExpression	string	[0..1]	Documentation Original Reference cdi:regularExpression CDIF Definition A regular expression where strings matching the expression belong to the set of valid values. Scope cdi:regularExpression - regex constraining the domain.
classificationLevel	string	[0..1]	Documentation Original Reference cdi:classificationLevel CDIF Definition Indicates the type of relationship, nominal, ordinal, interval, ratio, or continuous. Use where appropriate for the representation type. Scope cdi:classificationLevel - measurement level (nominal / ordinal / interval / ratio).
formatPattern	string	[0..1]	Documentation Original Reference cdi:ValueAndConceptDescription-formatPattern Definition A pattern for a number as described in Unicode Locale Data Markup Language (LDML) (http://www.unicode.org/reports/tr35/tr35.html) Part 3: Numbers (http://www.unicode.org/reports/tr35/tr35-numbers.html#Number_Format_Patterns) and Part 4. Dates (http://www.unicode.org/reports/tr35/tr35-dates.html#Date_Format_Patterns) . Examples would be #,##0.### to describe the pattern for a decimal number, or yyyy.MM.dd G 'at' HH:mm:ss zzz for a datetime pattern. CDIF Definition A pattern for a number as described in Unicode Locale Data Markup Language (LDML) (http://www.unicode.org/reports/tr35/tr35.html) Part 3: Numbers (http://www.unicode.org/reports/tr35/tr35-numbers.html#Number_Format_Patterns) and Part 4. Dates (http://www.unicode.org/reports/tr35/tr35-dates.html#Date_Format_Patterns) . Examples would be #,##0.### to describe the pattern for a decimal number, or yyyy.MM.dd G 'at' HH:mm:ss zzz for a datetime pattern. Scope cdi:formatPattern - format pattern.
maximumValueInclusive	string	[0..1]	Documentation Original Reference cdi:maximumValueInclusive CDIF Definition A string denoting the maximum possible value. From the W3C Recommendation "Metadata Vocabulary for Tabular Data" (https://www.w3.org/TR/tabular-metadata/) 5.11.2: "maximum: An atomic property that contains a single number or string that is the maximum valid value (inclusive); equivalent to maxInclusive. The value of this property becomes the maximum annotation for the described datatype. See Value Constraints in [tabular-data-model] for details." Scope cdi:maximumValueInclusive - inclusive upper bound.
maximumValueExclusive	string	[0..1]	Documentation Original Reference cdi:maximumValueExclusive CDIF Definition A string denoting the maximum possible value (excluding this value). From the W3C Recommendation "Metadata Vocabulary for Tabular Data" (https://www.w3.org/TR/tabular-metadata/) 5.11.2: "maxExclusive: An atomic property that contains a single number or string that is the maximum valid value (exclusive). The value of this property becomes the maximum exclusive annotation for the described datatype. See Value Constraints in [tabular-data-model] for details." Scope cdi:maximumValueExclusive - exclusive upper bound.
minimumValueInclusive	string	[0..1]	Documentation Original Reference cdi:minimumValueInclusive CDIF Definition A string denoting the minimum possible value. From the W3C Recommendation "Metadata Vocabulary for Tabular Data" (https://www.w3.org/TR/tabular-metadata/) 5.11.2: "minimum: An atomic property that contains a single number or string that is the minimum valid value (inclusive); equivalent to minInclusive. The value of this property becomes the minimum annotation for the described datatype. See Value Constraints in [tabular-data-model] for details." Scope cdi:minimumValueInclusive - inclusive lower bound.
minimumValueExclusive	string	[0..1]	Documentation Original Reference cdi:minimumValueExclusive CDIF Definition A string denoting the minimum possible value (excluding this value). From the W3C Recommendation "Metadata Vocabulary for Tabular Data" (https://www.w3.org/TR/tabular-metadata/) 5.11.2: "minExclusive: An atomic property that contains a single number or string that is the minimum valid value (exclusive). The value of this property becomes the minimum exclusive annotation for the described datatype. See Value Constraints in [tabular-data-model] for details." Scope cdi:minimumValueExclusive - exclusive lower bound.
isRequired	boolean	[0..1]	Documentation Original Reference cdi:ValueAndConceptDescription-isRequired CDIF Definition cdi:isRequired - whether a value is required.
defaultValue	string	[0..1]	Documentation Original Reference cdi:defaultValue CDIF Definition A default string indicating the value to substitute for an empty string. Scope cdi:defaultValue - default value if not provided.
externalDefinition	XsdAnyUri	[0..1]	Documentation Original Reference cdi:ValueAndConceptDescription-externalDefinition CDIF Definition A reference to an external definition of a concept (that is, a concept which is described outside the content of the DDI-CDI metadata description). An example is a SKOS concept. The definition property is assumed to duplicate the external one referenced if externalDefinition is used. Other corresponding properties are assumed to be included unchanged if used. Scope cdi:externalDefinition - URI of an external definition.
recommendedDataType	string	[0..1]	Documentation Original Reference cdif:recommendedDataType CDIF Definition The data types that are recommended for use with this domain. Scope cdif:recommendedDataType - recommended xsd-style data type for serialized values.
definition	string	[0..1]	Documentation Original Reference cdif:definition CDIF Definition Formal explanation of the meaning or purpose of this concept scheme. Scope cdif:definition - canonical definition text.
descriptiveText	string	[0..1]	Documentation Original Reference cdif:descriptiveText CDIF Definition A short natural language account of the characteristics of the object. Scope cdif:descriptiveText - descriptive prose.
displayLabel	string	[0..1]	Documentation Original Reference cdif:displayLabel CDIF Definition Human-readable label(s) for display. CDIF simplification (plain string) of DDI-CDI TextMapping.displayLabel, whose model type is LabelForDisplay. Per the cdi/cdif namespace policy a structured-string type simplified to a plain string is in the cdif namespace. Scope cdif:displayLabel - human display label.
purpose	string	[0..1]	Documentation Original Reference cdi:purpose CDIF Definition Intent or reason for the object/the description of the object. Scope cdif:purpose - intended purpose.

Associations

Role	Target	Multiplicity	Kind
isDescribedBy	← SubstantiveValueDomain	[0..1]	association
isDescribedBy	← SentinelValueDomain	[0..1]	association
isDescribedBy	← DescriptorValueDomain	[0..1]	association