Show / Hide Table of Contents

    Namespace Lucene.Net.Search.VectorHighlight

    Classes

    BaseFragListBuilder

    A abstract implementation of IFragListBuilder.

    BaseFragmentsBuilder

    Base IFragmentsBuilder implementation that supports colored pre/post tags and multivalued fields.

    Uses IBoundaryScanner to determine fragments.

    FastVectorHighlighter

    Another highlighter implementation.

    FieldFragList

    FieldFragList has a list of "frag info" that is used by IFragmentsBuilder class to create fragments (snippets).

    FieldFragList.WeightedFragInfo

    List of term offsets + weight for a frag info

    FieldFragList.WeightedFragInfo.SubInfo

    Represents the list of term offsets for some text

    FieldPhraseList

    FieldPhraseList has a list of WeightedPhraseInfo that is used by FragListBuilder to create a FieldFragList object.

    FieldPhraseList.WeightedPhraseInfo

    Represents the list of term offsets and boost for some text

    FieldPhraseList.WeightedPhraseInfo.Toffs

    Term offsets (start + end)

    FieldQuery

    FieldQuery breaks down query object into terms/phrases and keeps them in a FieldQuery.QueryPhraseMap structure.

    FieldQuery.QueryPhraseMap

    Internal structure of a query for highlighting: represents a nested query structure

    FieldTermStack

    FieldTermStack is a stack that keeps query terms in the specified field of the document to be highlighted.

    FieldTermStack.TermInfo

    Single term with its position/offsets in the document and IDF weight. It is System.IComparable<T> but considers only position.

    ScoreOrderFragmentsBuilder

    An implementation of FragmentsBuilder that outputs score-order fragments.

    ScoreOrderFragmentsBuilder.ScoreComparer

    System.Collections.Generic.IComparer<T> for FieldFragList.WeightedFragInfo by boost, breaking ties by offset.

    SimpleBoundaryScanner

    Simple boundary scanner implementation that divides fragments based on a set of separator characters.

    SimpleFieldFragList

    A simple implementation of FieldFragList.

    SimpleFragListBuilder

    A simple implementation of IFragListBuilder.

    SimpleFragmentsBuilder

    A simple implementation of FragmentsBuilder.

    SingleFragListBuilder

    An implementation class of IFragListBuilder that generates one FieldFragList.WeightedFragInfo object. Typical use case of this class is that you can get an entire field contents by using both of this class and SimpleFragmentsBuilder.

    FastVectorHighlighter h = new FastVectorHighlighter( true, true,
        new SingleFragListBuilder(), new SimpleFragmentsBuilder() );

    WeightedFieldFragList

    A weighted implementation of FieldFragList.

    WeightedFragListBuilder

    A weighted implementation of IFragListBuilder.

    Interfaces

    IBoundaryScanner

    Finds fragment boundaries: pluggable into BaseFragmentsBuilder

    IFragListBuilder

    IFragListBuilder is an interface for FieldFragList builder classes. A IFragListBuilder class can be plugged in to Highlighter.

    IFragmentsBuilder

    IFragmentsBuilder is an interface for fragments (snippets) builder classes. A IFragmentsBuilder class can be plugged in to FastVectorHighlighter.

    Back to top Copyright © 2019 Licensed to the Apache Software Foundation (ASF)