@twin.org/standards-w3c-dcat 0.0.3-next.9 → 0.9.0

package/docs/reference/interfaces/IDcatDataset.md

@@ -10,35 +10,38 @@ https://www.w3.org/TR/vocab-dcat-3/#Class:Dataset
 
 ## Extends
 
-- [`IDcatResource`](IDcatResource.md)
+- [`IDcatDatasetBase`](IDcatDatasetBase.md)
 
 ## Extended by
 
-- [`IDcatCatalog`](IDcatCatalog.md)
 - [`IDcatDatasetSeries`](IDcatDatasetSeries.md)
 
-## Indexable
+## Properties
 
-\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
+### @context {#context}
 
-## Properties
+> **@context**: [`DcatContextType`](../type-aliases/DcatContextType.md)
 
-### @type
+The JSON-LD context for the resource.
+
+***
+
+### @type {#type}
 
 > **@type**: `"dcat:Catalog"` \| `"dcat:Dataset"` \| `"dcat:DatasetSeries"`
 
 The type identifier, typically "Dataset".
 Can also be "Catalog" or "DatasetSeries" for subclasses.
 
-#### Overrides
+#### Inherited from
 
-[`IDcatResource`](IDcatResource.md).[`@type`](IDcatResource.md#type)
+[`IDcatDatasetBase`](IDcatDatasetBase.md).[`@type`](IDcatDatasetBase.md#type)
 
 ***
 
-### dcat:distribution?
+### dcat:distribution? {#dcatdistribution}
 
-> `optional` **dcat:distribution**: `ObjectOrArray`\<[`DistributionOptionalContext`](../type-aliases/DistributionOptionalContext.md)\>
+> `optional` **dcat:distribution?**: `ObjectOrArray`\<[`IDcatDistributionBase`](IDcatDistributionBase.md)\>
 
 An available distribution of the dataset.
 
@@ -46,11 +49,15 @@ An available distribution of the dataset.
 
 https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_distribution
 
+#### Inherited from
+
+[`IDcatDatasetBase`](IDcatDatasetBase.md).[`dcat:distribution`](IDcatDatasetBase.md#dcatdistribution)
+
 ***
 
-### dcterms:accrualPeriodicity?
+### dcterms:accrualPeriodicity? {#dctermsaccrualperiodicity}
 
-> `optional` **dcterms:accrualPeriodicity**: `string`
+> `optional` **dcterms:accrualPeriodicity?**: `string`
 
 The frequency at which the dataset is published.
 
@@ -58,11 +65,15 @@ The frequency at which the dataset is published.
 
 https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_frequency
 
+#### Inherited from
+
+[`IDcatDatasetBase`](IDcatDatasetBase.md).[`dcterms:accrualPeriodicity`](IDcatDatasetBase.md#dctermsaccrualperiodicity)
+
 ***
 
-### dcat:inSeries?
+### dcat:inSeries? {#dcatinseries}
 
-> `optional` **dcat:inSeries**: `string`
+> `optional` **dcat:inSeries?**: `string`
 
 A dataset series of which the dataset is part.
 
@@ -70,11 +81,15 @@ A dataset series of which the dataset is part.
 
 https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_in_series
 
+#### Inherited from
+
+[`IDcatDatasetBase`](IDcatDatasetBase.md).[`dcat:inSeries`](IDcatDatasetBase.md#dcatinseries)
+
 ***
 
-### dcterms:spatial?
+### dcterms:spatial? {#dctermsspatial}
 
-> `optional` **dcterms:spatial**: `IJsonLdNodeObject` \| `ObjectOrArray`\<`string`\>
+> `optional` **dcterms:spatial?**: `string` \| `string`[] \| `IJsonLdNodeObject`
 
 The geographical area covered by the dataset.
 
@@ -82,11 +97,15 @@ The geographical area covered by the dataset.
 
 https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_spatial
 
+#### Inherited from
+
+[`IDcatDatasetBase`](IDcatDatasetBase.md).[`dcterms:spatial`](IDcatDatasetBase.md#dctermsspatial)
+
 ***
 
-### dcat:spatialResolutionInMeters?
+### dcat:spatialResolutionInMeters? {#dcatspatialresolutioninmeters}
 
-> `optional` **dcat:spatialResolutionInMeters**: `number`
+> `optional` **dcat:spatialResolutionInMeters?**: `number`
 
 Minimum spatial separation resolvable in a dataset, measured in meters.
 
@@ -94,11 +113,15 @@ Minimum spatial separation resolvable in a dataset, measured in meters.
 
 https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_spatial_resolution
 
+#### Inherited from
+
+[`IDcatDatasetBase`](IDcatDatasetBase.md).[`dcat:spatialResolutionInMeters`](IDcatDatasetBase.md#dcatspatialresolutioninmeters)
+
 ***
 
-### dcterms:temporal?
+### dcterms:temporal? {#dctermstemporal}
 
-> `optional` **dcterms:temporal**: `IDublinCorePeriodOfTime`
+> `optional` **dcterms:temporal?**: `IDublinCorePeriodOfTime`
 
 The temporal period that the dataset covers.
 
@@ -106,11 +129,15 @@ The temporal period that the dataset covers.
 
 https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_temporal
 
+#### Inherited from
+
+[`IDcatDatasetBase`](IDcatDatasetBase.md).[`dcterms:temporal`](IDcatDatasetBase.md#dctermstemporal)
+
 ***
 
-### dcat:temporalResolution?
+### dcat:temporalResolution? {#dcattemporalresolution}
 
-> `optional` **dcat:temporalResolution**: `string`
+> `optional` **dcat:temporalResolution?**: `string`
 
 Minimum time period resolvable in the dataset.
 
@@ -118,11 +145,15 @@ Minimum time period resolvable in the dataset.
 
 https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_temporal_resolution
 
+#### Inherited from
+
+[`IDcatDatasetBase`](IDcatDatasetBase.md).[`dcat:temporalResolution`](IDcatDatasetBase.md#dcattemporalresolution)
+
 ***
 
-### prov:wasGeneratedBy?
+### prov:wasGeneratedBy? {#provwasgeneratedby}
 
-> `optional` **prov:wasGeneratedBy**: `string` \| `IJsonLdNodeObject`
+> `optional` **prov:wasGeneratedBy?**: `string` \| `IJsonLdNodeObject`
 
 An activity that generated, or provides the business context for, the creation of the dataset.
 
@@ -130,23 +161,27 @@ An activity that generated, or provides the business context for, the creation o
 
 https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_was_generated_by
 
+#### Inherited from
+
+[`IDcatDatasetBase`](IDcatDatasetBase.md).[`prov:wasGeneratedBy`](IDcatDatasetBase.md#provwasgeneratedby)
+
 ***
 
-### @context
+### @id? {#id}
 
-> **@context**: [`DcatContextType`](../type-aliases/DcatContextType.md)
+> `optional` **@id?**: `string`
 
-The JSON-LD context for the resource.
+The unique identifier for the resource.
 
 #### Inherited from
 
-[`IDcatResource`](IDcatResource.md).[`@context`](IDcatResource.md#context)
+[`IDcatDatasetBase`](IDcatDatasetBase.md).[`@id`](IDcatDatasetBase.md#id)
 
 ***
 
-### dcterms:title?
+### dcterms:title? {#dctermstitle}
 
-> `optional` **dcterms:title**: [`DcatLiteralType`](../type-aliases/DcatLiteralType.md)
+> `optional` **dcterms:title?**: `ObjectOrArray`\<`string`\>
 
 A name given to the resource.
 
@@ -156,13 +191,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_title
 
 #### Inherited from
 
-[`IDcatResource`](IDcatResource.md).[`dcterms:title`](IDcatResource.md#dctermstitle)
+[`IDcatDatasetBase`](IDcatDatasetBase.md).[`dcterms:title`](IDcatDatasetBase.md#dctermstitle)
 
 ***
 
-### dcterms:description?
+### dcterms:description? {#dctermsdescription}
 
-> `optional` **dcterms:description**: [`DcatLiteralType`](../type-aliases/DcatLiteralType.md)
+> `optional` **dcterms:description?**: `ObjectOrArray`\<`string`\>
 
 A free-text account of the resource.
 
@@ -172,13 +207,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_description
 
 #### Inherited from
 
-[`IDcatResource`](IDcatResource.md).[`dcterms:description`](IDcatResource.md#dctermsdescription)
+[`IDcatDatasetBase`](IDcatDatasetBase.md).[`dcterms:description`](IDcatDatasetBase.md#dctermsdescription)
 
 ***
 
-### dcterms:identifier?
+### dcterms:identifier? {#dctermsidentifier}
 
-> `optional` **dcterms:identifier**: [`DcatLiteralType`](../type-aliases/DcatLiteralType.md)
+> `optional` **dcterms:identifier?**: `ObjectOrArray`\<`string`\>
 
 A unique identifier of the resource.
 
@@ -188,13 +223,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_identifier
 
 #### Inherited from
 
-[`IDcatResource`](IDcatResource.md).[`dcterms:identifier`](IDcatResource.md#dctermsidentifier)
+[`IDcatDatasetBase`](IDcatDatasetBase.md).[`dcterms:identifier`](IDcatDatasetBase.md#dctermsidentifier)
 
 ***
 
-### dcterms:issued?
+### dcterms:issued? {#dctermsissued}
 
-> `optional` **dcterms:issued**: `string`
+> `optional` **dcterms:issued?**: `string`
 
 Date of formal issuance (publication) of the resource.
 
@@ -204,13 +239,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_release_date
 
 #### Inherited from
 
-[`IDcatResource`](IDcatResource.md).[`dcterms:issued`](IDcatResource.md#dctermsissued)
+[`IDcatDatasetBase`](IDcatDatasetBase.md).[`dcterms:issued`](IDcatDatasetBase.md#dctermsissued)
 
 ***
 
-### dcterms:modified?
+### dcterms:modified? {#dctermsmodified}
 
-> `optional` **dcterms:modified**: `string`
+> `optional` **dcterms:modified?**: `string`
 
 Most recent date on which the resource was changed, updated or modified.
 
@@ -220,13 +255,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_update_date
 
 #### Inherited from
 
-[`IDcatResource`](IDcatResource.md).[`dcterms:modified`](IDcatResource.md#dctermsmodified)
+[`IDcatDatasetBase`](IDcatDatasetBase.md).[`dcterms:modified`](IDcatDatasetBase.md#dctermsmodified)
 
 ***
 
-### dcterms:language?
+### dcterms:language? {#dctermslanguage}
 
-> `optional` **dcterms:language**: `ObjectOrArray`\<`string`\>
+> `optional` **dcterms:language?**: `ObjectOrArray`\<`string`\>
 
 A language of the resource.
 
@@ -236,13 +271,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_language
 
 #### Inherited from
 
-[`IDcatResource`](IDcatResource.md).[`dcterms:language`](IDcatResource.md#dctermslanguage)
+[`IDcatDatasetBase`](IDcatDatasetBase.md).[`dcterms:language`](IDcatDatasetBase.md#dctermslanguage)
 
 ***
 
-### dcterms:publisher?
+### dcterms:publisher? {#dctermspublisher}
 
-> `optional` **dcterms:publisher**: `string` \| `IFoafAgent`
+> `optional` **dcterms:publisher?**: `string` \| `JsonLdObjectWithAliases`\<`IFoafAgent`, `"foaf"`\>
 
 An entity responsible for making the resource available.
 
@@ -252,13 +287,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_publisher
 
 #### Inherited from
 
-[`IDcatResource`](IDcatResource.md).[`dcterms:publisher`](IDcatResource.md#dctermspublisher)
+[`IDcatDatasetBase`](IDcatDatasetBase.md).[`dcterms:publisher`](IDcatDatasetBase.md#dctermspublisher)
 
 ***
 
-### dcterms:creator?
+### dcterms:creator? {#dctermscreator}
 
-> `optional` **dcterms:creator**: `IFoafAgent`
+> `optional` **dcterms:creator?**: `string` \| `JsonLdObjectWithAliases`\<`IFoafAgent`, `"foaf"`\>
 
 An entity responsible for producing the resource.
 
@@ -268,13 +303,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_creator
 
 #### Inherited from
 
-[`IDcatResource`](IDcatResource.md).[`dcterms:creator`](IDcatResource.md#dctermscreator)
+[`IDcatDatasetBase`](IDcatDatasetBase.md).[`dcterms:creator`](IDcatDatasetBase.md#dctermscreator)
 
 ***
 
-### dcterms:accessRights?
+### dcterms:accessRights? {#dctermsaccessrights}
 
-> `optional` **dcterms:accessRights**: `string` \| `IJsonLdNodeObject`
+> `optional` **dcterms:accessRights?**: `string` \| `IJsonLdNodeObject`
 
 Information about who can access the resource or an indication of its security status.
 
@@ -284,13 +319,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_access_rights
 
 #### Inherited from
 
-[`IDcatResource`](IDcatResource.md).[`dcterms:accessRights`](IDcatResource.md#dctermsaccessrights)
+[`IDcatDatasetBase`](IDcatDatasetBase.md).[`dcterms:accessRights`](IDcatDatasetBase.md#dctermsaccessrights)
 
 ***
 
-### dcterms:license?
+### dcterms:license? {#dctermslicense}
 
-> `optional` **dcterms:license**: `string` \| `IJsonLdNodeObject`
+> `optional` **dcterms:license?**: `string` \| `IJsonLdNodeObject`
 
 A legal document under which the resource is made available.
 
@@ -300,13 +335,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_license
 
 #### Inherited from
 
-[`IDcatResource`](IDcatResource.md).[`dcterms:license`](IDcatResource.md#dctermslicense)
+[`IDcatDatasetBase`](IDcatDatasetBase.md).[`dcterms:license`](IDcatDatasetBase.md#dctermslicense)
 
 ***
 
-### dcterms:rights?
+### dcterms:rights? {#dctermsrights}
 
-> `optional` **dcterms:rights**: `string` \| `IJsonLdNodeObject`
+> `optional` **dcterms:rights?**: `string` \| `IJsonLdNodeObject`
 
 Information about rights held in and over the resource.
 
@@ -316,13 +351,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_rights
 
 #### Inherited from
 
-[`IDcatResource`](IDcatResource.md).[`dcterms:rights`](IDcatResource.md#dctermsrights)
+[`IDcatDatasetBase`](IDcatDatasetBase.md).[`dcterms:rights`](IDcatDatasetBase.md#dctermsrights)
 
 ***
 
-### dcterms:conformsTo?
+### dcterms:conformsTo? {#dctermsconformsto}
 
-> `optional` **dcterms:conformsTo**: `ObjectOrArray`\<`string`\>
+> `optional` **dcterms:conformsTo?**: `ObjectOrArray`\<`string`\>
 
 An established standard to which the resource conforms.
 
@@ -332,13 +367,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_conforms_to
 
 #### Inherited from
 
-[`IDcatResource`](IDcatResource.md).[`dcterms:conformsTo`](IDcatResource.md#dctermsconformsto)
+[`IDcatDatasetBase`](IDcatDatasetBase.md).[`dcterms:conformsTo`](IDcatDatasetBase.md#dctermsconformsto)
 
 ***
 
-### dcterms:type?
+### dcterms:type? {#dctermstype}
 
-> `optional` **dcterms:type**: `string`
+> `optional` **dcterms:type?**: `string`
 
 The nature or genre of the resource.
 
@@ -348,13 +383,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_type
 
 #### Inherited from
 
-[`IDcatResource`](IDcatResource.md).[`dcterms:type`](IDcatResource.md#dctermstype)
+[`IDcatDatasetBase`](IDcatDatasetBase.md).[`dcterms:type`](IDcatDatasetBase.md#dctermstype)
 
 ***
 
-### dcat:contactPoint?
+### dcat:contactPoint? {#dcatcontactpoint}
 
-> `optional` **dcat:contactPoint**: `string` \| `IJsonLdNodeObject`
+> `optional` **dcat:contactPoint?**: `string` \| `IJsonLdNodeObject`
 
 Relevant contact information for the catalogued resource.
 
@@ -364,13 +399,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_contact_point
 
 #### Inherited from
 
-[`IDcatResource`](IDcatResource.md).[`dcat:contactPoint`](IDcatResource.md#dcatcontactpoint)
+[`IDcatDatasetBase`](IDcatDatasetBase.md).[`dcat:contactPoint`](IDcatDatasetBase.md#dcatcontactpoint)
 
 ***
 
-### dcat:keyword?
+### dcat:keyword? {#dcatkeyword}
 
-> `optional` **dcat:keyword**: [`DcatLiteralType`](../type-aliases/DcatLiteralType.md)
+> `optional` **dcat:keyword?**: `ObjectOrArray`\<`string`\>
 
 A keyword or tag describing the resource.
 
@@ -380,13 +415,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_keyword
 
 #### Inherited from
 
-[`IDcatResource`](IDcatResource.md).[`dcat:keyword`](IDcatResource.md#dcatkeyword)
+[`IDcatDatasetBase`](IDcatDatasetBase.md).[`dcat:keyword`](IDcatDatasetBase.md#dcatkeyword)
 
 ***
 
-### dcat:theme?
+### dcat:theme? {#dcattheme}
 
-> `optional` **dcat:theme**: `ObjectOrArray`\<`string`\>
+> `optional` **dcat:theme?**: `ObjectOrArray`\<`string`\>
 
 A main category of the resource. A resource can have multiple themes.
 
@@ -396,13 +431,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_theme
 
 #### Inherited from
 
-[`IDcatResource`](IDcatResource.md).[`dcat:theme`](IDcatResource.md#dcattheme)
+[`IDcatDatasetBase`](IDcatDatasetBase.md).[`dcat:theme`](IDcatDatasetBase.md#dcattheme)
 
 ***
 
-### dcat:landingPage?
+### dcat:landingPage? {#dcatlandingpage}
 
-> `optional` **dcat:landingPage**: `ObjectOrArray`\<`string`\>
+> `optional` **dcat:landingPage?**: `ObjectOrArray`\<`string`\>
 
 A Web page that can be navigated to gain access to the resource.
 
@@ -412,13 +447,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_landing_page
 
 #### Inherited from
 
-[`IDcatResource`](IDcatResource.md).[`dcat:landingPage`](IDcatResource.md#dcatlandingpage)
+[`IDcatDatasetBase`](IDcatDatasetBase.md).[`dcat:landingPage`](IDcatDatasetBase.md#dcatlandingpage)
 
 ***
 
-### dcat:qualifiedRelation?
+### dcat:qualifiedRelation? {#dcatqualifiedrelation}
 
-> `optional` **dcat:qualifiedRelation**: `string` \| [`IDcatRelationship`](IDcatRelationship.md)
+> `optional` **dcat:qualifiedRelation?**: `string` \| [`IDcatRelationship`](IDcatRelationship.md)
 
 Link to a description of a relationship with another resource.
 
@@ -428,13 +463,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_qualified_relation
 
 #### Inherited from
 
-[`IDcatResource`](IDcatResource.md).[`dcat:qualifiedRelation`](IDcatResource.md#dcatqualifiedrelation)
+[`IDcatDatasetBase`](IDcatDatasetBase.md).[`dcat:qualifiedRelation`](IDcatDatasetBase.md#dcatqualifiedrelation)
 
 ***
 
-### odrl:hasPolicy?
+### odrl:hasPolicy? {#odrlhaspolicy}
 
-> `optional` **odrl:hasPolicy**: `IOdrlPolicy`
+> `optional` **odrl:hasPolicy?**: `JsonLdObjectWithOptionalContext`\<`IOdrlPolicy`\>
 
 An ODRL conformant policy expressing the rights associated with the resource.
 
@@ -444,4 +479,4 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_has_policy
 
 #### Inherited from
 
-[`IDcatResource`](IDcatResource.md).[`odrl:hasPolicy`](IDcatResource.md#odrlhaspolicy)
+[`IDcatDatasetBase`](IDcatDatasetBase.md).[`odrl:hasPolicy`](IDcatDatasetBase.md#odrlhaspolicy)