# Functions
CheckState checks state against a whitelist of valid states.
CleanDataset trims URI and any hrefs contained in the database.
CreateCantabularMetaDataDoc manages the creation of metadata across dataset and version docs for cantabular datasets note: logic to retrieve the newly-added Cantabular-specific fields to the Metadata model will be created at a later date.
CreateContact manages the creation of a contact from a reader.
CreateDataset manages the creation of a dataset from a reader.
CreateDownloadList manages the creation of a list downloadable items from a reader.
CreateEdition manages the creation of an edition object.
CreateMetaDataDoc manages the creation of metadata across dataset and version docs.
CreateObservationsDoc manages the creation of metadata across dataset and version docs.
CreateVersion manages the creation of a version from a reader.
GetDatasetType returns a dataset type for a given dataset.
ParseAndValidateVersionNumber checks the version is a positive integer above 0.
ValidateDataset checks the dataset has invalid fields.
ValidateDatasetType checks the dataset.type field has valid type.
ValidateImportTask checks the task contains mandatory fields.
ValidateInstanceState checks the list of instance states from a whitelist.
ValidateStateFilter checks the list of filter states from a whitelist.
ValidateVersion checks the content of the version structure TODO: Refactor this to reduce the complexity
nolint:gocyclo,gocognit // high cyclomactic & cognitive complexity not in scope for maintenance.
# Constants
Define the possible values for the AlertType enum.
Define the possible values for the AlertType enum.
A list of reusable states across application.
possible dataset types.
possible dataset types.
possible dataset types.
possible dataset types.
A list of reusable states across application.
A list of reusable states across application.
A list of reusable states across application.
Define the possible values for the DistributionFormat enum.
Define the possible values for the DistributionFormat enum.
Define the possible values for the DistributionFormat enum.
Define the possible values for the DistributionFormat enum.
Define the possible values for the DistributionFormat enum.
Define the possible values for the DistributionFormat enum.
Define the possible values for the DistributionMediaType enum.
Define the possible values for the DistributionMediaType enum.
Define the possible values for the DistributionMediaType enum.
Define the possible values for the DistributionMediaType enum.
Define the possible values for the DistributionMediaType enum.
Define the possible values for the DistributionMediaType enum.
A list of reusable states across application.
A list of reusable states across application.
possible dataset types.
possible dataset types.
A list of reusable states across application.
Define the possible values for the QualityDesignation enum.
Define the possible values for the QualityDesignation enum.
Define the possible values for the QualityDesignation enum.
possible dataset types.
A list of reusable states across application.
# Variables
List of error variables.
List of error variables.
List of error variables.
List of error variables.
# Structs
Alert represents an object containing information on an alert.
BuildHierarchyTask represents a task of importing a single hierarchy.
BuildSearchIndexTask represents a task of importing a single search index into search.
CachedDimensionOption contains information used to create a dimension option.
Contact represents information of individual contact details.
ContactDetails represents an object containing information of the contact.
Dataset represents information related to a single dataset.
DatasetLinks represents a list of specific links related to the dataset resource.
DatasetUpdate represents an evolving dataset with the current dataset and the updated dataset Note: Stored as Dataset (in `dataset` Collection) in MongoDB.
Dimension represents an overview for a single dimension.
DimensionLink contains all links needed for a dimension.
DimensionNodeResults wraps dimension node objects for pagination.
DimensionObject represents the unique dimension option data relevant to the observation.
DimensionOption contains unique information and metadata used when processing the data.
DimensionOptionLinks represents a list of link objects related to dimension options.
DimensionValues holds all unique values for a dimension.
Distribution represents a specific distribution of the dataset.
DownloadList represents a list of objects of containing information on the downloadable files.
DownloadObject represents information on the downloadable file.
EditableMetadata represents the metadata fields that can be edited.
Edition represents information related to a single edition for a dataset.
EditionUpdate represents an evolving edition containing both the next and current edition.
EditionUpdateLinks represents those links common the both the current and next edition.
Event which has happened to an instance.
GeneralDetails represents generic fields stored against an object (reused).
No description provided by the author
ImportObservationsTask represents the task of importing instance observation data into the database.
Instance which presents a single dataset being imported.
InstanceImportTasks represents all of the tasks required to complete an import job.
InstanceLinks holds all links for an instance.
IsBasedOn refers to the Cantabular blob source.
LatestChange represents an object containing information on a single change between versions.
LinkObject represents a generic structure for all links.
Metadata represents information (metadata) relevant to a version.
MetadataLinks represents a link object to list of metadata relevant to a version.
Observation represents an object containing a single observation and its equivalent metadata.
ObservationLinks represents a link object to list of links relevant to the observation.
ObservationsDoc represents information (observations) relevant to a version.
Option represents an object containing a list of link objects that refer to the code url for that dimension option.
PublicDimensionOption hides values which are only used by interval services.
Publisher represents an object containing information of the publisher.
TemporalFrequency represents a frequency for a particular period of time.
UsageNote represents a note containing extra information associated to the resource.
Version represents information related to a single version for an edition of a dataset.
VersionLinks represents a list of specific links related to the version resource for an edition of a dataset.
# Type aliases
AlertType defines possible types of alerts.
DatasetType defines possible dataset types.
DistributionFormat enum type representing the allowable formats for the distribution download file.
DistributionMediaType enum type representing the allowable media types for the distribution download file.
QualityDesignation enum type representing the allowable quality designations for a dataset.