DiscoveryDataDescriptionStructure

Reference inherited from CDIFCore

DiscoveryDataDescriptionStructure::Classes::Reference

Definition

Documentation

CDIF
Definition

Building block to implement relations to other resources using a URL and some semantics.

Scope

A typed reference to an external entity (cdif:Reference). Provides a labeled link surface (name, description, url) plus the DDI-CDI dt-Reference semantics (uri, optional cdif:semantic describing the role). See the cdifDataType/cdifReference building block for the full definition; this is the per-profile UML class that JSON-shape unions reduce to.

JSON serialization: In a JSON instance, a property typed as Reference may also be supplied as a plain string (a URL) or as an object reference ({"@id": ...}) instead of a full cdif:Reference object.

Diagram

Inheritance

No generalization relationships.

Attributes

NameTypeMultiplicityDescription
namestring[0..1]

Documentation

Original
Reference

schema:name

Definition

The name of the item.

Scope

Domain: Thing (https://schema.org/Thing). Range: Text (https://schema.org/Text).

CDIF
Definition

A descriptive name of a dataset (e.g., 'Snow depth in Northern Hemisphere'). The name should uniquely identify the described resource for human use, in the scope of the metadata catalog containing this metadata record.

Scope

schema:name - human-readable label for the reference.

descriptionstring[0..1]

Documentation

Original
Reference

schema:description

Definition

A description of the item.

Scope

Domain: Thing (https://schema.org/Thing). Range: Text (https://schema.org/Text), TextObject (https://schema.org/TextObject).

CDIF
Definition

A short summary describing a dataset. This text will be indexed by search applications, so the more information here, the better.

Scope

schema:description - short summary of the referenced resource.

urlXsdAnyUri[0..1]

Documentation

Original
Reference

schema:url

Definition

URL of the item.

Scope

Domain: Thing (https://schema.org/Thing). Range: URL (https://schema.org/URL).

CDIF
Definition

Web Location of a page describing the dataset (landing page), typically providing links or instructions to get the actual resource content; analogous to dcat:accessURL. If a direct link is available to get the data, put in distribution/contentUrl

Scope

schema:url - presentation URL for the referenced resource.

relationXsdAnyUri[0..1]

Documentation

Original
Reference

dcterms:relation

Definition

A related resource.

CDIF
Definition

URI of the related resource (DCAT canonical pointer to what is being related to; distinct from schema:url which is the presentation URL inherited from labeledLink).

Scope

dcterms:relation - canonical URI of the related resource (distinct from schema:url, the presentation URL).

hadRoleDefinedTerm[0..1]

Documentation

Original
Reference

dcat:hadRole

Definition

The function of an entity or agent with respect to another entity or resource.

Scope

Range: Role (http://www.w3.org/ns/dcat#Role).

CDIF
Definition

Role of the related resource as a SKOS Concept (DCAT canonical role slot).

Scope

dcat:hadRole - role of the related resource, as a controlled term (SKOS Concept / DefinedTerm).

Associations

RoleTargetMultiplicityKind
licenseDataset[0..*]association