Class DirectSpellChecker.ScoreTerm

Holds a spelling correction for internal usage inside DirectSpellChecker.

Inheritance
object
DirectSpellChecker.ScoreTerm
Inherited Members
Namespace: Lucene.Net.Search.Spell
Assembly: Lucene.Net.Suggest.dll
Syntax
protected class DirectSpellChecker.ScoreTerm : IComparable<DirectSpellChecker.ScoreTerm>

Constructors

ScoreTerm()

Constructor.

Declaration
public ScoreTerm()

Properties

Boost

The boost representing the similarity from the FuzzyTermsEnum (internal similarity score)

Declaration
public float Boost { get; set; }
Property Value
Type Description
float

Docfreq

The df of the spellcheck correction.

Declaration
public int Docfreq { get; set; }
Property Value
Type Description
int

Score

The similarity score.

Declaration
public float Score { get; set; }
Property Value
Type Description
float

Term

The actual spellcheck correction.

Declaration
public BytesRef Term { get; set; }
Property Value
Type Description
BytesRef

TermAsString

The spellcheck correction represented as string, can be 

null
.
Declaration
public string TermAsString { get; set; }
Property Value
Type Description
string

Methods

CompareTo(ScoreTerm)

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(DirectSpellChecker.ScoreTerm other)
Parameters
Type Name Description
DirectSpellChecker.ScoreTerm 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

GetHashCode()

Serves as the default hash function.

Declaration
public override int GetHashCode()
Returns
Type Description
int

A hash code for the current object.
Overrides

Implements