interface.go

package bhlinker

import (
	entity "github.com/gdower/bhlinker/ent"
	"github.com/gnames/bhlnames/config"
	bhln "github.com/gnames/bhlnames/domain/entity"
)

// Plugger provides API to the module.
type Plugger interface {
	// GetLink takes an input with a name-string and optionally the nomenclatural reference data
	// for the name-string and returns back BHL references filtered by scoring algorithms.
	// The references are the best attempt to find first nomenclatural descriptions
	// for a names in BHL.
	GetLink(input entity.Input) (entity.Output, error)
	// GetLinks takes a stream of name-strings and returns a stream of references in BHL.
	GetLinks(chIn <-chan entity.Input, chOut chan<- entity.Output)
}

// Referencer allows us to inverse dependency to BHLnames. It provides signatures
// to BHLnames methods needed for functionality of BHLinker.
type Referencer interface {
	// Refs takes a name-string and returns an BHLnames' output that contains
	// found BHL references for the name-string.
	Refs(string, ...config.Option) (*bhln.NameRefs, error)
}