highlight

Documentation

Index

• type Fragment
  • func (f *Fragment) Overlaps(other *Fragment) bool
• type FragmentFormatter
• type FragmentScorer
• type Fragmenter
• type Highlighter
• type TermLocation
  • func (tl *TermLocation) Overlaps(other *TermLocation) bool
• type TermLocations
  • func OrderTermLocations(tlm search.TermLocationMap) TermLocations
  • func (t TermLocations) Len() int
  • func (t TermLocations) Less(i, j int) bool
  • func (t TermLocations) MergeOverlapping()
  • func (t TermLocations) Swap(i, j int)

Types

type Fragment

type Fragment struct {
	Orig           []byte
	ArrayPositions []uint64
	Start          int
	End            int
	Score          float64
	Index          int // used by heap
}

func (*Fragment) Overlaps

func (f *Fragment) Overlaps(other *Fragment) bool

type FragmentFormatter

type FragmentFormatter interface {
	Format(f *Fragment, orderedTermLocations TermLocations) string
}

type FragmentScorer

type FragmentScorer interface {
	Score(f *Fragment) float64
}

type Fragmenter

type Fragmenter interface {
	Fragment([]byte, TermLocations) []*Fragment
}

type Highlighter

type Highlighter interface {
	Fragmenter() Fragmenter
	SetFragmenter(Fragmenter)

	FragmentFormatter() FragmentFormatter
	SetFragmentFormatter(FragmentFormatter)

	Separator() string
	SetSeparator(string)

	BestFragmentInField(*search.DocumentMatch, *document.Document, string) string
	BestFragmentsInField(*search.DocumentMatch, *document.Document, string, int) []string
}

type TermLocation

type TermLocation struct {
	Term           string
	ArrayPositions search.ArrayPositions
	Pos            int
	Start          int
	End            int
}

func (*TermLocation) Overlaps

func (tl *TermLocation) Overlaps(other *TermLocation) bool

type TermLocations

type TermLocations []*TermLocation

func OrderTermLocations

func OrderTermLocations(tlm search.TermLocationMap) TermLocations

func (TermLocations) Len

func (t TermLocations) Len() int

func (TermLocations) Less

func (t TermLocations) Less(i, j int) bool

func (TermLocations) MergeOverlapping

func (t TermLocations) MergeOverlapping()

func (TermLocations) Swap

func (t TermLocations) Swap(i, j int)