reffinder

package
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 30, 2022 License: MIT Imports: 3 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type RefFinder

type RefFinder interface {
	// ReferencesBHL takes a name-string and returns back back BHL references
	// where this name-string was detected.  If a name-string occurrence has a
	// nomenclatural annotaion (like 'sp. nov.') attached to it somewhere in the
	// reference, the position of that occurrence is returned. If there is no
	// such annotation, the first detection of the name-string in the reference
	// is returned.  When a reference is an `item` (a journal volume usually)
	// with `parts` (a publication/article usually), we return one occurrence for
	// every `part`, but also first occurrence of a name-string in the `item`, if
	// it exists outside of all `parts`.
	ReferencesBHL(
		inp input.Input,
		cfg config.Config,
	) (*namerefs.NameRefs, error)

	// Close cleans up all the database, key-value store, files locks and blocks,
	// releasing resources for the next usage of the program.
	Close() error
}

RefFinder interface is a lower-level one, that tells how to find BHL references for name_strings.

Directories

Path Synopsis
Code generated by counterfeiter.
Code generated by counterfeiter.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL