Class FieldPhraseList

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

Inheritance
object
FieldPhraseList
Inherited Members
Namespace: Lucene.Net.Search.VectorHighlight
Assembly: Lucene.Net.Highlighter.dll
Syntax
public class FieldPhraseList

Constructors

FieldPhraseList(FieldPhraseList[])

Merging constructor.

Declaration
public FieldPhraseList(FieldPhraseList[] toMerge)
Parameters
Type Name Description
FieldPhraseList[] toMerge

FieldPhraseLists to merge to build this one

FieldPhraseList(FieldTermStack, FieldQuery)

create a FieldPhraseList that has no limit on the number of phrases to analyze

Declaration
public FieldPhraseList(FieldTermStack fieldTermStack, FieldQuery fieldQuery)
Parameters
Type Name Description
FieldTermStack fieldTermStack

FieldTermStack object
FieldQuery fieldQuery

FieldQuery object

FieldPhraseList(FieldTermStack, FieldQuery, int)

a constructor.

Declaration
public FieldPhraseList(FieldTermStack fieldTermStack, FieldQuery fieldQuery, int phraseLimit)
Parameters
Type Name Description
FieldTermStack fieldTermStack

FieldTermStack object
FieldQuery fieldQuery

FieldQuery object
int phraseLimit

maximum size of phraseList

Properties

PhraseList

return the list of FieldPhraseList.WeightedPhraseInfo.

Declaration
public virtual IList<FieldPhraseList.WeightedPhraseInfo> PhraseList { get; }
Property Value
Type Description
IList<FieldPhraseList.WeightedPhraseInfo>

Methods

AddIfNoOverlap(WeightedPhraseInfo)

NOTE: When overriding this method, be aware that the constructor of this class calls a private method and not this virtual method. So if you need to override the behavior during the initialization, call your own private method from the constructor with whatever custom behavior you need.

Declaration
public virtual void AddIfNoOverlap(FieldPhraseList.WeightedPhraseInfo wpi)
Parameters
Type Name Description
FieldPhraseList.WeightedPhraseInfo wpi