bhlindex

Documentation

Index

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

Variables

var (
	Version = "v0.13.2+"
	Build   string
)

Types

type BHLindex

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

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

	// DumpOccurrences creates output with detected names in CSV,
	// TSV, or JSON formats.
	DumpOccurrences(output.Dumper) error

	// DumpNames creates output with verified names in CSV,
	// TSV, or JSON formats.
	DumpNames(output.Dumper) error

	// DumpPages creates output with pages info in CSV, TSV, or JSON formats.
	DumpPages(output.Dumper) error

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

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

BHLindex us the main usecase interface that defines functionality of BHLindex

func New

func New(
	cfg config.Config,
) BHLindex

New sets up BHLindex interface using bhlindex instance.