models

package
v2.17.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 12, 2023 License: MIT Imports: 1 Imported by: 16

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Code

type Code struct {
	ID    string
	Code  string
	Label string
}

Code for a single dimensions type

type CodeList

type CodeList struct {
	ID string
}

CodeList containing the ID of a codelist

type CodeListResults

type CodeListResults struct {
	Items []CodeList
}

CodeListResults contains an array of code lists

type CodeResults

type CodeResults struct {
	Items []Code
}

CodeResults contains an array of codes which can be paginated

type Dataset

type Dataset struct {
	ID             string
	DimensionLabel string
	Editions       []DatasetEdition
}

Dataset represents an individual dataset

type DatasetEdition

type DatasetEdition struct {
	ID            string
	CodeListID    string
	LatestVersion int
}

DatasetEdition represents an object containing edition data

type Datasets

type Datasets struct {
	Items []Dataset
}

Datasets represents a list of dataset objects

type Dimension

type Dimension struct {
	DimensionID string
	Option      string
	NodeID      string
}

Dimension struct encapsulating Dimension details.

func (*Dimension) Validate

func (d *Dimension) Validate() error

Validate checks the dimension object

type DimensionOption

type DimensionOption struct {
	DimensionName string
	Name          string
}

DimensionOption represents the a single dimension option for an observation.

type Edition

type Edition struct {
	ID    string
	Label string
}

Edition represents a single edition object

type Editions

type Editions struct {
	Items []Edition
}

Editions represents a list of editions

type HierarchyElement

type HierarchyElement struct {
	ID           string
	Label        string
	NoOfChildren int64
	Order        *int64 // nil if order property not present
	HasData      bool
}

HierarchyElement is a item in a list within a HierarchyResponse

type HierarchyResponse

type HierarchyResponse struct {
	ID           string
	Label        string
	Children     []*HierarchyElement
	NoOfChildren int64
	Order        *int64 // nil if order property not present
	HasData      bool
	Breadcrumbs  []*HierarchyElement
}

HierarchyResponse models a node in the hierarchy

type Instance

type Instance struct {
	InstanceID string
	CSVHeader  []string
	Dimensions []interface{}
}

Instance struct to hold instance information.

func (*Instance) Validate

func (i *Instance) Validate() error

Validate checks that the instance ID is not empty

type Observation

type Observation struct {
	Row              string
	RowIndex         int64
	InstanceID       string
	DimensionOptions []*DimensionOption
}

Observation represents a single observation value and its associated data.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL