Package org.opensearch.search.suggest.phrase

Class DirectCandidateGenerator.Candidate

java.lang.Object

org.opensearch.search.suggest.phrase.DirectCandidateGenerator.Candidate

All Implemented Interfaces:

Comparable<DirectCandidateGenerator.Candidate>

Enclosing class:

DirectCandidateGenerator

public static class DirectCandidateGenerator.Candidate
extends Object
implements Comparable<DirectCandidateGenerator.Candidate>

Candidate term

Opensearch.internal:

Field Summary

Fields

Modifier and Type	Field	Description
static final DirectCandidateGenerator.Candidate[]	EMPTY
final double	score
final double	stringDistance
final org.apache.lucene.util.BytesRef	term
final org.apache.lucene.codecs.TermStats	termStats
final boolean	userInput

Constructor Summary

Constructors

Constructor	Description
Candidate(org.apache.lucene.util.BytesRef term, org.apache.lucene.codecs.TermStats termStats, double stringDistance, double score, boolean userInput)

Method Summary

Modifier and Type	Method	Description
int	compareTo(DirectCandidateGenerator.Candidate other)	Lower scores sort first; if scores are equal, then later (zzz) terms sort first
boolean	equals(Object obj)
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

EMPTY

public static final DirectCandidateGenerator.Candidate[] EMPTY

term

public final org.apache.lucene.util.BytesRef term

stringDistance

public final double stringDistance

termStats

public final org.apache.lucene.codecs.TermStats termStats

score

public final double score

userInput

public final boolean userInput

Constructor Details

Candidate

public Candidate(org.apache.lucene.util.BytesRef term,
 org.apache.lucene.codecs.TermStats termStats,
 double stringDistance,
 double score,
 boolean userInput)

Method Details

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public int compareTo(DirectCandidateGenerator.Candidate other)

Lower scores sort first; if scores are equal, then later (zzz) terms sort first

Specified by:

compareTo in interface Comparable<DirectCandidateGenerator.Candidate>