Reference
CDIFCore::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.
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
| Name | Type | Multiplicity | Description |
|---|---|---|---|
| name | string | [0..1] | DocumentationOriginalReferenceschema:name DefinitionThe name of the item. ScopeDomain: Thing (https://schema.org/Thing). Range: Text (https://schema.org/Text). CDIFDefinitionA 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. Scopeschema:name - human-readable label for the reference. |
| description | string | [0..1] | DocumentationOriginalReferenceschema:description DefinitionA description of the item. ScopeDomain: Thing (https://schema.org/Thing). Range: Text (https://schema.org/Text), TextObject (https://schema.org/TextObject). CDIFDefinitionA short summary describing a dataset. This text will be indexed by search applications, so the more information here, the better. Scopeschema:description - short summary of the referenced resource. |
| url | XsdAnyUri | [0..1] | DocumentationOriginalReferenceschema:url DefinitionURL of the item. ScopeDomain: Thing (https://schema.org/Thing). Range: URL (https://schema.org/URL). CDIFDefinitionWeb 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 Scopeschema:url - presentation URL for the referenced resource. |
| relation | XsdAnyUri | [0..1] | DocumentationOriginalReferencedcterms:relation DefinitionA related resource. CDIFDefinitionURI 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). Scopedcterms:relation - canonical URI of the related resource (distinct from schema:url, the presentation URL). |
| hadRole | DefinedTerm | [0..1] | DocumentationOriginalReferencedcat:hadRole DefinitionThe function of an entity or agent with respect to another entity or resource. ScopeRange: Role (http://www.w3.org/ns/dcat#Role). CDIFDefinitionRole of the related resource as a SKOS Concept (DCAT canonical role slot). Scopedcat:hadRole - role of the related resource, as a controlled term (SKOS Concept / DefinedTerm). |
Associations
| Role | Target | Multiplicity | Kind |
|---|---|---|---|
| license | ← Dataset | [0..*] | association |