Class FieldPhraseList.WeightedPhraseInfo

Represents the list of term offsets and boost for some text

Inheritance

object

FieldPhraseList.WeightedPhraseInfo

Implements

IComparable<FieldPhraseList.WeightedPhraseInfo>

IFormattable

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: Lucene.Net.Search.VectorHighlight

Assembly: Lucene.Net.Highlighter.dll

Syntax

public class FieldPhraseList.WeightedPhraseInfo : IComparable<FieldPhraseList.WeightedPhraseInfo>, IFormattable

Constructors

WeightedPhraseInfo(ICollection<WeightedPhraseInfo>)

Merging constructor. Note that this just grabs seqnum from the first info.

Declaration

public WeightedPhraseInfo(ICollection<FieldPhraseList.WeightedPhraseInfo> toMerge)

Parameters

Type	Name	Description
ICollection<FieldPhraseList.WeightedPhraseInfo>	toMerge

WeightedPhraseInfo(IList<TermInfo>, float)

Represents the list of term offsets and boost for some text

Declaration

public WeightedPhraseInfo(IList<FieldTermStack.TermInfo> terms, float boost)

Parameters

Type	Name	Description
IList<FieldTermStack.TermInfo>	terms
float	boost

WeightedPhraseInfo(IList<TermInfo>, float, int)

Represents the list of term offsets and boost for some text

Declaration

public WeightedPhraseInfo(IList<FieldTermStack.TermInfo> terms, float boost, int seqnum)

Parameters

Type	Name	Description
IList<FieldTermStack.TermInfo>	terms
float	boost
int	seqnum

Properties

Boost

the boost

Declaration

public virtual float Boost { get; }

Property Value

Type	Description
float

EndOffset

Represents the list of term offsets and boost for some text

Declaration

public virtual int EndOffset { get; }

Property Value

Type	Description
int

Seqnum

the seqnum

Declaration

public virtual int Seqnum { get; }

Property Value

Type	Description
int

StartOffset

Represents the list of term offsets and boost for some text

Declaration

public virtual int StartOffset { get; }

Property Value

Type	Description
int

TermsInfos

the termInfos

Declaration

public virtual IList<FieldTermStack.TermInfo> TermsInfos { get; }

Property Value

Type	Description
IList<FieldTermStack.TermInfo>

TermsOffsets

the termsOffsets

Declaration

public virtual IList<FieldPhraseList.WeightedPhraseInfo.Toffs> TermsOffsets { get; }

Property Value

Type	Description
IList<FieldPhraseList.WeightedPhraseInfo.Toffs>

Methods

CompareTo(WeightedPhraseInfo)

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

Declaration

public virtual int CompareTo(FieldPhraseList.WeightedPhraseInfo other)

Parameters

Type	Name	Description
FieldPhraseList.WeightedPhraseInfo	other	An object to compare with this instance.

Returns

Type	Description
int	A value that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less than zero This instance precedes other in the sort order. Zero This instance occurs in the same position in the sort order as other. Greater than zero This instance follows other in the sort order.

Equals(object)

Determines whether the specified object is equal to the current object.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj	The object to compare with the current object.

Returns

Type	Description
bool	true if the specified object is equal to the current object; otherwise, false.

Overrides

object.Equals(object)

GetHashCode()

Serves as the default hash function.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A hash code for the current object.

Overrides

object.GetHashCode()

GetText()

Text of the match, calculated on the fly. Use for debugging only.

Declaration

public virtual string GetText()

Returns

Type	Description
string	the text

IsOffsetOverlap(WeightedPhraseInfo)

Represents the list of term offsets and boost for some text

Declaration

public virtual bool IsOffsetOverlap(FieldPhraseList.WeightedPhraseInfo other)

Parameters

Type	Name	Description
FieldPhraseList.WeightedPhraseInfo	other

Returns

Type	Description
bool

ToString()

Returns a string that represents the current object.

Declaration

public override string ToString()

Returns

Type	Description
string	A string that represents the current object.

Overrides

object.ToString()

ToString(IFormatProvider)

Represents the list of term offsets and boost for some text

Declaration

public virtual string ToString(IFormatProvider provider)

Parameters

Type	Name	Description
IFormatProvider	provider

Returns

Type	Description
string

Implements

IComparable<T>

IFormattable