Class BaseFragListBuilder

A abstract implementation of IFragListBuilder.

Inheritance

System.Object

BaseFragListBuilder

SimpleFragListBuilder

WeightedFragListBuilder

Implements

IFragListBuilder

Namespace: Lucene.Net.Search.VectorHighlight

Assembly: Lucene.Net.Highlighter.dll

Syntax

public abstract class BaseFragListBuilder : object, IFragListBuilder

Constructors

| Improve this Doc View Source

BaseFragListBuilder()

Declaration

public BaseFragListBuilder()

| Improve this Doc View Source

BaseFragListBuilder(Int32)

Declaration

public BaseFragListBuilder(int margin)

Parameters

Type	Name	Description
System.Int32	margin

Fields

| Improve this Doc View Source

MARGIN_DEFAULT

Declaration

public static readonly int MARGIN_DEFAULT

Field Value

Type	Description
System.Int32

| Improve this Doc View Source

MIN_FRAG_CHAR_SIZE_FACTOR

Declaration

public static readonly int MIN_FRAG_CHAR_SIZE_FACTOR

Field Value

Type	Description
System.Int32

Methods

| Improve this Doc View Source

AcceptPhrase(FieldPhraseList.WeightedPhraseInfo, Int32, Int32)

A predicate to decide if the given FieldPhraseList.WeightedPhraseInfo should be accepted as a highlighted phrase or if it should be discarded.

The default implementation discards phrases that are composed of more than one term and where the matchLength exceeds the fragment character size.

Declaration

protected virtual bool AcceptPhrase(FieldPhraseList.WeightedPhraseInfo info, int matchLength, int fragCharSize)

Parameters

Type	Name	Description
FieldPhraseList.WeightedPhraseInfo	info	the phrase info to accept
System.Int32	matchLength	the match length of the current phrase
System.Int32	fragCharSize	the configured fragment character size

Returns

Type	Description
System.Boolean	`true` if this phrase info should be accepted as a highligh phrase

| Improve this Doc View Source

CreateFieldFragList(FieldPhraseList, FieldFragList, Int32)

Declaration

protected virtual FieldFragList CreateFieldFragList(FieldPhraseList fieldPhraseList, FieldFragList fieldFragList, int fragCharSize)

Parameters

Type	Name	Description
FieldPhraseList	fieldPhraseList
FieldFragList	fieldFragList
System.Int32	fragCharSize

Returns

Type	Description
FieldFragList

| Improve this Doc View Source

CreateFieldFragList(FieldPhraseList, Int32)

Declaration

public abstract FieldFragList CreateFieldFragList(FieldPhraseList fieldPhraseList, int fragCharSize)

Parameters

Type	Name	Description
FieldPhraseList	fieldPhraseList
System.Int32	fragCharSize

Returns

Type	Description
FieldFragList

Implements

IFragListBuilder