model

Documentation

Index

• type AddAll
• type Age
• type AgeData
• type AgeValue
• type Dimension
• type Download
• type Filter
• type FilterOverview
• type GroupedSelection
• type Hierarchy
• type HierarchyData
• type LatestVersion
• type Link
• type List
• type ListSelector
• type Metadata
• type Month
• type Overview
• type Preview
• type PreviewDimension
• type PreviewPage
• type Range
• type Selector
• type Time
• type TimeData
• type TimeValue
• type Value

Types

type AddAll

type AddAll struct {
	Amount string `json:"amount"`
	URL    string `json:"url"`
}

AddAll represents the data to add all options

type Age

type Age struct {
	core.Page
	Data     AgeData `json:"data"`
	FilterID string  `json:"filter_id"`
}

Age represents an age selection page

type AgeData

type AgeData struct {
	Youngest      string     `json:"youngest"`
	Oldest        string     `json:"oldest"`
	FirstSelected string     `json:"first_selected"`
	LastSelected  string     `json:"last_selected"`
	Ages          []AgeValue `json:"ages"`
	CheckedRadio  string     `json:"checked_radio"`
	FormAction    Link       `json:"form_action"`
	HasAllAges    bool       `json:"has_all_ages"`
	AllAgesOption string     `json:"all_ages_option"`
}

Data represents the data for the age page

type AgeValue

type AgeValue struct {
	Label      string
	Option     string
	IsSelected bool
}

Value represents a single age value

type Dimension

type Dimension struct {
	Filter          string   `json:"filter"`
	AddedCategories []string `json:"added_categories"`
	Link            Link     `json:"link"`
	HasNoCategory   bool     `json:"has_no_category"`
}

Dimension represents the data for a single dimension

type Download

type Download struct {
	Extension string `json:"extension"`
	Size      string `json:"size"`
	URI       string `json:"uri"`
	Skipped   bool   `json:"skipped"`
}

Download has the details for an individual downloadable file

type Filter

type Filter struct {
	Label     string `json:"label"`
	RemoveURL string `json:"remove_url"`
	ID        string `json:"id"`
}

Filter represents the data for a single filter item

type FilterOverview

type FilterOverview struct {
	Dimensions         []Dimension   `json:"dimensions"`
	UnsetDimensions    []string      `json:"unset_dimensions"`
	ClearAll           Link          `json:"clear_all"`
	Cancel             Link          `json:"cancel"`
	IsLatestVersion    bool          `json:"is_latest_version"`
	LatestVersion      LatestVersion `json:"latest_version"`
	DatasetTitle       string        `json:"dataset_title"`
	HasUnsetDimensions bool          `json:"has_unset_dimensions"`
}

FilterOverview represents the metadata for a overview page

type GroupedSelection

type GroupedSelection struct {
	Months    []Month `json:"months"`
	YearStart string  `json:"year_start"`
	YearEnd   string  `json:"year_end"`
}

GroupedSelection represents the data required to a group a selection

type Hierarchy

type Hierarchy struct {
	core.Page
	Data     HierarchyData `json:"data"`
	FilterID string        `json:"filter_id"`
}

Hierarchy represents the data for a hierarchy page

type HierarchyData

type HierarchyData struct {
	Title           string   `json:"title"`
	SaveAndReturn   Link     `json:"save_and_return"`
	Cancel          Link     `json:"cancel"`
	FiltersAmount   string   `json:"filters_amount"`
	AddAllFilters   AddAll   `json:"add_all"`
	FilterList      []List   `json:"filter_list"`
	FiltersAdded    []Filter `json:"filters_added"`
	RemoveAll       Link     `json:"remove_all"`
	GoBack          Link     `json:"go_back"`
	DimensionName   string   `json:"dimension_name"`
	Parent          string   `json:"parent"`
	Type            string   `json:"type"`
	Metadata        Metadata `json:"metadata"`
	DatasetTitle    string   `json:"dataset_title"`
	SearchURL       string   `json:"search_url"`
	IsSearchResults bool     `json:"is_search_results"`
	Query           string   `json:"query"`
	IsSearchError   bool     `json:"is_search_error"`
	LandingPageURL  string   `json:"landing_page_url"`
	HasData         bool     `json:"has_data"`
}

HierarchyData represents the metadata for a hierarchy page

type LatestVersion

type LatestVersion struct {
	DatasetLandingPageURL          string `json:"dataset_landing_page_url"`
	FilterJourneyWithLatestJourney string `json:"filter_journey_with_latest_version"`
}

LatestVersion represents the data to display the latest version

type Link

type Link struct {
	URL   string `json:"url"`
	Label string `json:"label"`
}

Link represents the data required to display a link

type List

type List struct {
	Label    string `json:"label"`
	Selected bool   `json:"selected"`
	SubNum   string `json:"sub_num"`
	ID       string `json:"id"`
	SubType  string `json:"sub_type"`
	SubURL   string `json:"sub_url"`
	HasData  bool   `json:"has_data"`
}

List represents the data required for a list

type ListSelector

type ListSelector struct {
	Title         string   `json:"title"`
	AddFromRange  Link     `json:"add_from_range"`
	AddAllChecked bool     `json:"add_all_checked"`
	SaveAndReturn Link     `json:"save_and_return"`
	Cancel        Link     `json:"cancel"`
	FiltersAmount int      `json:"filters_amount"`
	FiltersAdded  []Filter `json:"filters_added"`
	AddAllInRange Link     `json:"add_all"`
	RemoveAll     Link     `json:"remove_all"`
	RangeData     Range    `json:"range_values"`
	DatasetTitle  string   `json:"dataset_title"`
}

ListSelector represents the metadata for a selector page

type Metadata

type Metadata struct {
	Name        string `json:"name"`
	Description string `json:"description"`
}

Metadata represents the metadata for the hierarchy

type Month

type Month struct {
	Name       string `json:"name"`
	IsSelected bool   `json:"is_selected"`
}

Month represents the data required to display a month

type Overview

type Overview struct {
	core.Page
	Data     FilterOverview `json:"data"`
	FilterID string         `json:"filter_id"`
}

Overview represents the data for a overview page

type Preview

type Preview struct {
	core.Page
	Data                 PreviewPage `json:"data"`
	EnableDatasetPreview bool        `json:"enable_dataset_preview"`
	IsPreviewLoaded      bool        `json:"is_preview_loaded"`
	IsDownloadLoaded     bool        `json:"is_download_loaded"`
	NoDimensionData      bool        `json:"no_dimension_data"`
}

Preview represents the data for a preview page

type PreviewDimension

type PreviewDimension struct {
	Name   string   `json:"name"`
	Values []string `json:"values"`
}

PreviewDimension represents a single dimension for the preview page

type PreviewPage

type PreviewPage struct {
	FilterID              string             `json:"filter_id"`
	Downloads             []Download         `json:"downloads"`
	Dimensions            []PreviewDimension `json:"dimensions"`
	IsLatestVersion       bool               `json:"is_latest_version"`
	LatestVersion         LatestVersion      `json:"latest_version"`
	CurrentVersionURL     string             `json:"current_version_url"`
	DatasetTitle          string             `json:"dataset_title"`
	DatasetID             string             `json:"dataset_id"`
	Edition               string             `json:"edition"`
	ReleaseDate           string             `json:"release_date"`
	UnitOfMeasurement     string             `json:"unit_of_measurement"`
	SingleValueDimensions []PreviewDimension `json:"single_value_dimensions"`
	FilterOutputID        string             `json:"filter_output_id"`
}

PreviewPage represents the metadata for a preview page

type Range

type Range struct {
	URL    string  `json:"url"`
	Values []Value `json:"values"`
}

Range represents the data to display a range

type Selector

type Selector struct {
	core.Page
	Pagination core.Pagination `json:"pagination,omitempty"`
	Data       ListSelector    `json:"data"`
	FilterID   string          `json:"job_id"`
}

Selector represents the data for a selector page

type Time

type Time struct {
	core.Page
	Data     TimeData `json:"data"`
	FilterID string   `json:"filter_id"`
}

Time represents a time selection page

type TimeData

type TimeData struct {
	LatestTime         TimeValue        `json:"latest_value"`
	FirstTime          TimeValue        `json:"fist_time"`
	Values             []TimeValue      `json:"values"`
	Months             []string         `json:"months"`
	Years              []string         `json:"years"`
	CheckedRadio       string           `json:"checked_radio"`
	FormAction         Link             `json:"form_action"`
	SelectedStartMonth string           `json:"selected_start_month"`
	SelectedStartYear  string           `json:"selected_start_year"`
	SelectedEndMonth   string           `json:"selected_end_month"`
	SelectedEndYear    string           `json:"selected_end_year"`
	Type               string           `json:"type"`
	DatasetTitle       string           `json:"dataset_title"`
	GroupedSelection   GroupedSelection `json:"grouped_selection"`
}

Data represents the metadata for the time page

type TimeValue

type TimeValue struct {
	Month      string `json:"month,omitempty"`
	Year       string `json:"year,omitempty"`
	Option     string `json:"option"`
	IsSelected bool   `json:"is_selected"`
}

TimeValue represents the data to display a single time value

type Value

type Value struct {
	Label      string `json:"label"`
	ID         string `json:"id"`
	IsSelected bool   `json:"is_selected"`
}

Value represents the data to display an individual value