demographics

Documentation

Index

• Variables
• type Bracket
  • func (bracket Bracket) String() string
• type DataFile
  • func (datafile *DataFile) Download() (err error)
  • func (datafile *DataFile) Remove()
• type Demographics
• type Store
  • func (store *Store) AutoRefresh(ctx context.Context, interval time.Duration)
  • func (store *Store) GetAgeBrackets() (brackets []Bracket)
  • func (store *Store) GetAgeGroupFigures() (figures map[string]int)
  • func (store *Store) GetByAge(bracket Bracket) (count int, ok bool)
  • func (store *Store) GetByRegion(region string) (count int, ok bool)
  • func (store *Store) GetRegionFigures() (figures map[string]int)
  • func (store *Store) GetRegions() (regions []string)
  • func (store *Store) Stats() (stats map[string]int)
  • func (store *Store) Update()

Variables

var DefaultAgeBrackets = []float64{12, 16, 18, 25, 35, 45, 55, 65, 75, 85}

DefaultAgeBrackets specifies the default age brackets for the demographics by age

Types

type Bracket

type Bracket struct {
	Low  float64
	High float64
}

Bracket indicates a range of ages by which demographics data is grouped

func (Bracket) String

func (bracket Bracket) String() string

String returns a string representation of a Bracket

type DataFile

type DataFile struct {
	TempDirectory string
	URL           string
	Metrics       metrics.APIClientMetrics
	// contains filtered or unexported fields
}

DataFile represents a demographics data file

func (*DataFile) Download

func (datafile *DataFile) Download() (err error)

Download downloads a demographics data file to disk

func (*DataFile) Remove

func (datafile *DataFile) Remove()

Remove deletes the downloaded demographics data file from disk

type Demographics

type Demographics interface {
	// GetAgeGroupFigures returns the demographics grouped by age groups specified in AgeBrackets
	GetAgeGroupFigures() (figures map[string]int)
	// GetRegionFigures returns the demographics grouped by region
	GetRegionFigures() (figures map[string]int)
	// Stats returns statistics on the cache
	Stats() (stats map[string]int)
	// AutoRefresh periodically updates the cache
	AutoRefresh(ctx context.Context, interval time.Duration)
}

Demographics interface giving access to available data

type Store

type Store struct {
	AgeBrackets   []float64                // age brackets to group the data in. Defaults to DefaultAgeBrackets
	TempDirectory string                   // directory to use for temporary files. Uses system-specified tempdir if left blank
	URL           string                   // used to retrieve the data. Used for unit testing
	Metrics       metrics.APIClientMetrics // metrics to report API performance
	// contains filtered or unexported fields
}

Store holds the demographics data

func (*Store) AutoRefresh

func (store *Store) AutoRefresh(ctx context.Context, interval time.Duration)

AutoRefresh periodically updates the cache

func (*Store) GetAgeBrackets

func (store *Store) GetAgeBrackets() (brackets []Bracket)

GetAgeBrackets returns all age brackets found in the demographics data

func (*Store) GetAgeGroupFigures

func (store *Store) GetAgeGroupFigures() (figures map[string]int)

GetAgeGroupFigures returns the demographics grouped by age groups specified in AgeBrackets

func (*Store) GetByAge

func (store *Store) GetByAge(bracket Bracket) (count int, ok bool)

GetByAge returns the total population in the specified age brackets

func (*Store) GetByRegion

func (store *Store) GetByRegion(region string) (count int, ok bool)

GetByRegion returns the total population for the specified region

func (*Store) GetRegionFigures

func (store *Store) GetRegionFigures() (figures map[string]int)

GetRegionFigures returns the demographics grouped by region

func (*Store) GetRegions

func (store *Store) GetRegions() (regions []string)

GetRegions returns all regions found in the demographics data

func (*Store) Stats

func (store *Store) Stats() (stats map[string]int)

Stats reports statistics on the case

func (*Store) Update

func (store *Store) Update()

Update refreshes the demographics cache