@twin.org/standards-w3c-dcat/dist/types/models/IDataset.d.ts

Models which define the structure of W3C DCAT Standard

import type { ObjectOrArray } from "@twin.org/core";
import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
import type { IPeriodOfTime } from "@twin.org/standards-dublin-core";
import type { DcatClasses } from "./dcatClasses.js";
import type { IDistribution } from "./IDistribution.js";
import type { IResource } from "./IResource.js";
import type { DecimalType, DurationType } from "./types/dcatPropertyTypes.js";
/**
 * Interface for DCAT Dataset.
 * A collection of data, published or curated by a single agent, and available
 * for access or download in one or more representations.
 * @see https://www.w3.org/TR/vocab-dcat-3/#Class:Dataset
 */
export interface IDataset extends IResource {
    /**
     * The type identifier, typically "Dataset".
     * Can also be "Catalog" or "DatasetSeries" for subclasses.
     */
    "@type": typeof DcatClasses.Dataset | typeof DcatClasses.Catalog | typeof DcatClasses.DatasetSeries;
    /**
     * An available distribution of the dataset.
     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_distribution
     */
    "dcat:distribution"?: ObjectOrArray<IDistribution>;
    /**
     * The frequency at which the dataset is published.
     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_frequency
     */
    "dcterms:accrualPeriodicity"?: string;
    /**
     * A dataset series of which the dataset is part.
     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_in_series
     */
    "dcat:inSeries"?: string;
    /**
     * The geographical area covered by the dataset.
     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_spatial
     */
    "dcterms:spatial"?: IJsonLdNodeObject | ObjectOrArray<string>;
    /**
     * Minimum spatial separation resolvable in a dataset, measured in meters.
     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_spatial_resolution
     */
    "dcat:spatialResolutionInMeters"?: DecimalType;
    /**
     * The temporal period that the dataset covers.
     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_temporal
     */
    "dcterms:temporal"?: IPeriodOfTime;
    /**
     * Minimum time period resolvable in the dataset.
     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_temporal_resolution
     */
    "dcat:temporalResolution"?: DurationType;
    /**
     * An activity that generated, or provides the business context for, the creation of the dataset.
     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_was_generated_by
     */
    "prov:wasGeneratedBy"?: IJsonLdNodeObject | string;
}