Package org.opensearch.search.suggest.phrase

Class CandidateGenerator

java.lang.Object

org.opensearch.search.suggest.phrase.CandidateGenerator

Direct Known Subclasses:

DirectCandidateGenerator, MultiCandidateGeneratorWrapper

public abstract class CandidateGenerator
extends Object

Base class for phrase candidates

Opensearch.internal:

Constructor Summary

Constructors

Constructor	Description
CandidateGenerator()

Method Summary

Modifier and Type	Method	Description
DirectCandidateGenerator.Candidate	createCandidate(org.apache.lucene.util.BytesRef term, boolean userInput)
DirectCandidateGenerator.Candidate	createCandidate(org.apache.lucene.util.BytesRef term, org.apache.lucene.codecs.TermStats termStats, double channelScore)
abstract DirectCandidateGenerator.Candidate	createCandidate(org.apache.lucene.util.BytesRef term, org.apache.lucene.codecs.TermStats termStats, double channelScore, boolean userInput)
DirectCandidateGenerator.CandidateSet	drawCandidates(org.apache.lucene.util.BytesRef term)
abstract DirectCandidateGenerator.CandidateSet	drawCandidates(DirectCandidateGenerator.CandidateSet set)
abstract boolean	isKnownWord(org.apache.lucene.util.BytesRef term)
abstract org.apache.lucene.codecs.TermStats	termStats(org.apache.lucene.util.BytesRef term)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CandidateGenerator

public CandidateGenerator()

Method Details

isKnownWord

public abstract boolean isKnownWord(org.apache.lucene.util.BytesRef term)
                             throws IOException

Throws:

IOException

termStats

public abstract org.apache.lucene.codecs.TermStats termStats(org.apache.lucene.util.BytesRef term)
                                                      throws IOException

Throws:

IOException

drawCandidates

public DirectCandidateGenerator.CandidateSet drawCandidates(org.apache.lucene.util.BytesRef term)
                                                     throws IOException

Throws:

IOException

createCandidate

public DirectCandidateGenerator.Candidate createCandidate(org.apache.lucene.util.BytesRef term,
 boolean userInput)
                                                   throws IOException

Throws:

IOException

createCandidate

public DirectCandidateGenerator.Candidate createCandidate(org.apache.lucene.util.BytesRef term,
 org.apache.lucene.codecs.TermStats termStats,
 double channelScore)
                                                   throws IOException

Throws:

IOException

createCandidate

public abstract DirectCandidateGenerator.Candidate createCandidate(org.apache.lucene.util.BytesRef term,
 org.apache.lucene.codecs.TermStats termStats,
 double channelScore,
 boolean userInput)
                                                            throws IOException

Throws:

IOException

drawCandidates

public abstract DirectCandidateGenerator.CandidateSet drawCandidates(DirectCandidateGenerator.CandidateSet set)
                                                              throws IOException

Throws:

IOException