model

type Match struct {
	// ID is UUIDv5 generated from verbatim input name-string.
	ID string
	// Name is verbatim input name-string.
	Name string
	// MatchType describe what kind of match happened.
	MatchType
	// MatchItems provide all matched data. It will be empty if no matches
	// occured.
	MatchItems []MatchItem
}

type MatchItem struct {
	// ID is a UUIDv5 generated out of MatchStr.
	ID string
	// MatchStr is the string that matched a particular input. More often than
	// not it is a canonical form of a name. However for ranked infraspecies it
	// might be a 'full' canonical form that includes rank, and for viruses it
	// can be matched string from the database.
	MatchStr string
	// EditDistance is a Levenshtein edit distance between normalized
	// input and MatchStr.
	EditDistance int
	// EditDistanceStem is a Levenshtein edit distance between stemmed input and
	// stemmed MatchStr.
	EditDistanceStem int
}

type MatchType int

type MatcherService interface {
	// GetPort returns port of the service.
	GetPort() int

	// Ping checks connection to the service.
	Ping() Pong

	// GetVersion sends current version and build timestamp of
	// gnmatcher.
	GetVersion() Version

	// MatchAry takes a list of strings and matches each of them
	// to known scientific names.
	MatchAry([]string) []*Match
}

type Pong string

type Version struct {
	// Version of gnmatcher.
	Version string
	// Build timestamp of gnmatcher.
	Build string
}