concordances

Documentation

Index

• func AuthorityFromURI(uri string) (string, bool)
• func AuthorityToURI(authority string) (string, bool)
• type Concept
• type Concordance
• type Concordances
• type CypherDriver
  • func NewCypherDriver(driver *cmneo4j.Driver, publicAPIURL string) (CypherDriver, error)
  • func (cd CypherDriver) CheckConnectivity() error
  • func (cd CypherDriver) ReadByAuthority(authority string, identifierValues []string) (concordances Concordances, found bool, err error)
  • func (cd CypherDriver) ReadByConceptID(identifiers []string) (concordances Concordances, found bool, err error)
• type Driver
• type HTTPHandler
  • func NewHTTPHandler(log *logger.UPPLogger, driver Driver, cacheControlHeader string) *HTTPHandler
  • func (hh *HTTPHandler) GTG() gtg.Status
  • func (hh *HTTPHandler) GetConcordances(w http.ResponseWriter, r *http.Request)
  • func (hh *HTTPHandler) HealthCheck(serviceName string) fthealth.TimedHealthCheck
• type Identifier

Functions

func AuthorityFromURI

func AuthorityFromURI(uri string) (string, bool)

func AuthorityToURI

func AuthorityToURI(authority string) (string, bool)

Types

type Concept

type Concept struct {
	ID     string `json:"id"`
	APIURL string `json:"apiUrl"`
}

Concept is a concept equivilant to a thing

type Concordance

type Concordance struct {
	Concept    Concept    `json:"concept,omitempty"`
	Identifier Identifier `json:"identifier,omitempty"`
}

Concordance is the structure used for the people API

type Concordances

type Concordances struct {
	Concordance []Concordance `json:"concordances,omitempty"`
}

Concordances is a list of concordances wrapped like this for parity in the JSON currently produced

type CypherDriver

type CypherDriver struct {
	// contains filtered or unexported fields
}

CypherDriver struct

func NewCypherDriver

func NewCypherDriver(driver *cmneo4j.Driver, publicAPIURL string) (CypherDriver, error)

NewCypherDriver instantiate driver

func (CypherDriver) CheckConnectivity

func (cd CypherDriver) CheckConnectivity() error

CheckConnectivity tests neo4j by running a simple cypher query

func (CypherDriver) ReadByAuthority

func (cd CypherDriver) ReadByAuthority(authority string, identifierValues []string) (concordances Concordances, found bool, err error)

func (CypherDriver) ReadByConceptID

func (cd CypherDriver) ReadByConceptID(identifiers []string) (concordances Concordances, found bool, err error)

type Driver

type Driver interface {
	ReadByConceptID(ids []string) (concordances Concordances, found bool, err error)
	ReadByAuthority(authority string, ids []string) (concordances Concordances, found bool, err error)
	CheckConnectivity() error
}

Driver interface

type HTTPHandler

type HTTPHandler struct {
	// contains filtered or unexported fields
}

func NewHTTPHandler

func NewHTTPHandler(log *logger.UPPLogger, driver Driver, cacheControlHeader string) *HTTPHandler

func (*HTTPHandler) GTG

func (hh *HTTPHandler) GTG() gtg.Status

GTG lightly checks the application and conforms to the FT standard GTG format

func (*HTTPHandler) GetConcordances

func (hh *HTTPHandler) GetConcordances(w http.ResponseWriter, r *http.Request)

GetConcordances is the public API

func (*HTTPHandler) HealthCheck

func (hh *HTTPHandler) HealthCheck(serviceName string) fthealth.TimedHealthCheck

HealthCheck provides an FT standard timed healthcheck for the /__health endpoint

type Identifier

type Identifier struct {
	Authority       string `json:"authority"`
	IdentifierValue string `json:"identifierValue"`
}

Identifier identifies the concept with alternative identity