datastructures

Documentation

Overview

Package datastructures provides a set of structs which define data structures

Index

• type AlphaKey
• type CompanyName
• type EsCompany
• type EsItem
• type EsLinks
• type MongoCompany
• type MongoData
• type MongoLinks

Types

type AlphaKey

type AlphaKey struct {
	SameAsAlphaKey  string `json:"sameAsAlphaKey"`
	OrderedAlphaKey string `json:"orderedAlphaKey"`
}

AlphaKey holds data returned by the alpha key service

type CompanyName

type CompanyName struct {
	Name string `json:"name"`
}

CompanyName holds the name of a company to be sent to the alpha key service

type EsCompany

type EsCompany struct {
	ID                    string
	CompanyType           string   `json:"company_type"`
	Items                 EsItem   `json:"items"`
	Kind                  string   `json:"kind"`
	Links                 *EsLinks `json:"links"`
	OrderedAlphaKeyWithID string   `json:"ordered_alpha_key_with_id"`
}

EsCompany holds a set of items containing company data relevant to Elastic Search

type EsItem

type EsItem struct {
	CompanyNumber       string `json:"company_number"`
	CompanyStatus       string `json:"company_status,omitempty"`
	CorporateName       string `json:"corporate_name"`
	CorporateNameStart  string `json:"corporate_name_start"`
	CorporateNameEnding string `json:"corporate_name_ending,omitempty"`
	RecordType          string `json:"record_type"`
	AlphaKey            string `json:"alpha_key"`
	OrderedAlphaKey     string `json:"ordered_alpha_key"`
}

EsItem holds an individual company's data

type EsLinks

type EsLinks struct {
	Self string `json:"self"`
}

EsLinks holds a set of links relevant to an EsCompany

type MongoCompany

type MongoCompany struct {
	ID   string     `bson:"_id"`
	Data *MongoData `bson:"data"`
}

MongoCompany wraps MongoData with an accompanying ID

type MongoData

type MongoData struct {
	CompanyName   string     `bson:"company_name"`
	CompanyNumber string     `bson:"company_number"`
	CompanyStatus string     `bson:"company_status"`
	CompanyType   string     `bson:"type"`
	Links         MongoLinks `bson:"links"`
}

MongoData contains company data from MongoDB

type MongoLinks

type MongoLinks struct {
	Self string `bson:"self"`
}

MongoLinks holds a set of links relevant to MongoData