bhlindex

Documentation

Index

• Variables
• type BHLindex
  • func New(cfg config.Config) BHLindex

Variables

var (
	// Version of the bhlindex binary.
	Version = "1.0.2"

	// Build is a timestamp of the bhlindex binary compilation.
	Build string
)

Types

type BHLindex

type BHLindex interface {
	// FindNames traverses BHL corpus directory structure, assembling texts,
	// detecting names, saving the resulting data to storage.
	FindNames(loader.Loader, finder.Finder) error

	// Verify names runs verification on unique detected names and saves the
	// results to storage.
	VerifyNames(verif.VerifierBHL) error

	// CalcOddsVerif calculates relationship between odds and the percentage
	// of successful verifications.
	CalcOddsVerif(verif.VerifierBHL) error

	// DumpOccurrences exports data about detected names and their position
	// on BHL pages in CSV, TSV, or JSON formats.
	DumpOccurrences(output.Dumper) error

	// DumpNames exports results of names verification in CSV,
	// TSV, or JSON formats.
	DumpNames(output.Dumper) error

	// DumpOddsVerification exports mapping of Odds values to verification
	// percentage
	DumpOddsVerification(output.Dumper) error

	// GetVersion outputs the version of BHLindex.
	GetVersion() gnvers.Version

	// GetConfig returns an instance of configuration fields.
	GetConfig() config.Config
}

BHLindex defines main functionality of BHLindex project.

func New

func New(
	cfg config.Config,
) BHLindex

New sets up BHLindex interface using bhlindex instance.