Class FieldPhraseList.WeightedPhraseInfo

Represents the list of term offsets and boost for some text

Inheritance
System.Object
FieldPhraseList.WeightedPhraseInfo
Implements
System.IFormattable
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Lucene.Net.Search.VectorHighlight
Assembly: Lucene.Net.Highlighter.dll
Syntax
public class WeightedPhraseInfo : IComparable<FieldPhraseList.WeightedPhraseInfo>, IFormattable

Constructors

| Improve this Doc View Source

WeightedPhraseInfo(ICollection<FieldPhraseList.WeightedPhraseInfo>)

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

Declaration
public WeightedPhraseInfo(ICollection<FieldPhraseList.WeightedPhraseInfo> toMerge)
Parameters
Type Name Description
System.Collections.Generic.ICollection<FieldPhraseList.WeightedPhraseInfo> toMerge
| Improve this Doc View Source

WeightedPhraseInfo(IList<FieldTermStack.TermInfo>, Single)

Declaration
public WeightedPhraseInfo(IList<FieldTermStack.TermInfo> terms, float boost)
Parameters
Type Name Description
System.Collections.Generic.IList<FieldTermStack.TermInfo> terms
System.Single boost
| Improve this Doc View Source

WeightedPhraseInfo(IList<FieldTermStack.TermInfo>, Single, Int32)

Declaration
public WeightedPhraseInfo(IList<FieldTermStack.TermInfo> terms, float boost, int seqnum)
Parameters
Type Name Description
System.Collections.Generic.IList<FieldTermStack.TermInfo> terms
System.Single boost
System.Int32 seqnum

Properties

| Improve this Doc View Source

Boost

the boost

Declaration
public virtual float Boost { get; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

EndOffset

Declaration
public virtual int EndOffset { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

Seqnum

the seqnum

Declaration
public virtual int Seqnum { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

StartOffset

Declaration
public virtual int StartOffset { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

TermsInfos

the termInfos

Declaration
public virtual IList<FieldTermStack.TermInfo> TermsInfos { get; }
Property Value
Type Description
System.Collections.Generic.IList<FieldTermStack.TermInfo>
| Improve this Doc View Source

TermsOffsets

the termsOffsets

Declaration
public virtual IList<FieldPhraseList.WeightedPhraseInfo.Toffs> TermsOffsets { get; }
Property Value
Type Description
System.Collections.Generic.IList<FieldPhraseList.WeightedPhraseInfo.Toffs>

Methods

| Improve this Doc View Source

CompareTo(FieldPhraseList.WeightedPhraseInfo)

Declaration
public virtual int CompareTo(FieldPhraseList.WeightedPhraseInfo other)
Parameters
Type Name Description
FieldPhraseList.WeightedPhraseInfo other
Returns
Type Description
System.Int32
| Improve this Doc View Source

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj
Returns
Type Description
System.Boolean
Overrides
System.Object.Equals(System.Object)
| Improve this Doc View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32
Overrides
System.Object.GetHashCode()
| Improve this Doc View Source

GetText()

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

Declaration
public virtual string GetText()
Returns
Type Description
System.String

the text
| Improve this Doc View Source

IsOffsetOverlap(FieldPhraseList.WeightedPhraseInfo)

Declaration
public virtual bool IsOffsetOverlap(FieldPhraseList.WeightedPhraseInfo other)
Parameters
Type Name Description
FieldPhraseList.WeightedPhraseInfo other
Returns
Type Description
System.Boolean
| Improve this Doc View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides
System.Object.ToString()
| Improve this Doc View Source

ToString(IFormatProvider)

Declaration
public virtual string ToString(IFormatProvider provider)
Parameters
Type Name Description
System.IFormatProvider provider
Returns
Type Description
System.String

Explicit Interface Implementations

| Improve this Doc View Source

IFormattable.ToString(String, IFormatProvider)

Declaration
string IFormattable.ToString(string format, IFormatProvider provider)
Parameters
Type Name Description
System.String format
System.IFormatProvider provider
Returns
Type Description
System.String

Implements

System.IComparable<T>
System.IFormattable