ContextualComponent

Generalization is DataStructureComponent.

Superclass hierarchy

Definition

Encapsulates contextual information of the key-value datastore to provide a scope to the instance key. The instance key is unique within the scope.

Examples

A partition, cluster name and any other key-value datastore organization information.

Explanatory notes

A key-value datastore can be organized into multiple contextual components.

Other data structure components that are part of the instance key, e.g. identifier and dimension components, guarantee uniqueness only within the scope of a contextual component. Synthetic id components do guarantee global uniqueness, but they might complex to setup and maintain in many organizations. Contextual components provide a simple mechanism to achive uniqueness within a single key-value datastore.

When a key-value datastore is organized in contextual components, a contextual component prefix is added to the instance key to make it unique across the entire key-value datastore.


Subclasses


Inherited Properties

Name

Description

Data Type

Multi- plicity

semantic

The semantic of the DataStructureComponent expressed as a PairedExternalControlledVocabulary.

PairedExternalControlledVocabularyEntry

0..*

agency

Agency expressed as filed with the DDI Agency ID registry [registry.ddialliance.org] with optional additional sub-agency extensions.

:ref:``

1..1

id

ID conforming to the allowed structure of the DDI Identifier and must be unique within the Agency.

:ref:``

1..1

isPersistent

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

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

Locally used identifier unique with a specified context, such as a variable name within a dataset.

LocalIdFormat

0..*

version

Version number of the object.

:ref:``

1..1

versionDate

Date and time the object was changed expressed in standard ISO formats.

XSDdate

0..1

versionRationale

Reason for making a new version of the object.

RationaleDefinition

0..1

versionResponsibility

Contributor who has the ownership and responsibility for the current version.

:ref:``

0..1

Diagram

TBD