Package org.elasticsearch.search.suggest.phrase

Class DirectCandidateGenerator

java.lang.Object

org.elasticsearch.search.suggest.phrase.CandidateGenerator

org.elasticsearch.search.suggest.phrase.DirectCandidateGenerator

public final class DirectCandidateGenerator
extends CandidateGenerator

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DirectCandidateGenerator.Candidate
static class	DirectCandidateGenerator.CandidateSet
static class	DirectCandidateGenerator.TokenConsumer

Constructor Summary

Constructors

Constructor	Description
DirectCandidateGenerator(org.apache.lucene.search.spell.DirectSpellChecker spellchecker, java.lang.String field, org.apache.lucene.search.spell.SuggestMode suggestMode, org.apache.lucene.index.IndexReader reader, double nonErrorLikelihood, int numCandidates)
DirectCandidateGenerator(org.apache.lucene.search.spell.DirectSpellChecker spellchecker, java.lang.String field, org.apache.lucene.search.spell.SuggestMode suggestMode, org.apache.lucene.index.IndexReader reader, double nonErrorLikelihood, int numCandidates, org.apache.lucene.analysis.Analyzer preFilter, org.apache.lucene.analysis.Analyzer postFilter, org.apache.lucene.index.Terms terms)

Method Summary

Modifier and Type	Method	Description
static int	analyze(org.apache.lucene.analysis.Analyzer analyzer, org.apache.lucene.util.BytesRef toAnalyze, java.lang.String field, DirectCandidateGenerator.TokenConsumer consumer, org.apache.lucene.util.CharsRefBuilder spare)
static int	analyze(org.apache.lucene.analysis.TokenStream stream, DirectCandidateGenerator.TokenConsumer consumer)	NOTE: this method closes the TokenStream, even on exception, which is awkward because really the caller who called Analyzer.tokenStream(java.lang.String, java.io.Reader) should close it, but when trying that there are recursion issues when we try to use the same TokenStream twice in the same recursion...
DirectCandidateGenerator.Candidate	createCandidate(org.apache.lucene.util.BytesRef term, long frequency, double channelScore, boolean userInput)
DirectCandidateGenerator.CandidateSet	drawCandidates(DirectCandidateGenerator.CandidateSet set)
long	frequency(org.apache.lucene.util.BytesRef term)
java.lang.String	getField()
long	internalFrequency(org.apache.lucene.util.BytesRef term)
boolean	isKnownWord(org.apache.lucene.util.BytesRef term)
protected void	postFilter(DirectCandidateGenerator.Candidate candidate, org.apache.lucene.util.CharsRefBuilder spare, org.apache.lucene.util.BytesRefBuilder byteSpare, java.util.List<DirectCandidateGenerator.Candidate> candidates)
protected org.apache.lucene.util.BytesRef	preFilter(org.apache.lucene.util.BytesRef term, org.apache.lucene.util.CharsRefBuilder spare, org.apache.lucene.util.BytesRefBuilder byteSpare)
protected long	thresholdFrequency(long termFrequency, long dictionarySize)

Methods inherited from class org.elasticsearch.search.suggest.phrase.CandidateGenerator

createCandidate, createCandidate, drawCandidates

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectCandidateGenerator

public DirectCandidateGenerator(org.apache.lucene.search.spell.DirectSpellChecker spellchecker,
                                java.lang.String field,
                                org.apache.lucene.search.spell.SuggestMode suggestMode,
                                org.apache.lucene.index.IndexReader reader,
                                double nonErrorLikelihood,
                                int numCandidates)
                         throws java.io.IOException

Throws:

java.io.IOException

DirectCandidateGenerator

public DirectCandidateGenerator(org.apache.lucene.search.spell.DirectSpellChecker spellchecker,
                                java.lang.String field,
                                org.apache.lucene.search.spell.SuggestMode suggestMode,
                                org.apache.lucene.index.IndexReader reader,
                                double nonErrorLikelihood,
                                int numCandidates,
                                org.apache.lucene.analysis.Analyzer preFilter,
                                org.apache.lucene.analysis.Analyzer postFilter,
                                org.apache.lucene.index.Terms terms)
                         throws java.io.IOException

Throws:

java.io.IOException

Method Detail

isKnownWord

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

Specified by:

isKnownWord in class CandidateGenerator

Throws:

java.io.IOException

frequency

public long frequency(org.apache.lucene.util.BytesRef term)
               throws java.io.IOException

Specified by:

frequency in class CandidateGenerator

Throws:

java.io.IOException

internalFrequency

public long internalFrequency(org.apache.lucene.util.BytesRef term)
                       throws java.io.IOException

Throws:

java.io.IOException

getField

public java.lang.String getField()

drawCandidates

public DirectCandidateGenerator.CandidateSet drawCandidates(DirectCandidateGenerator.CandidateSet set)
                                                     throws java.io.IOException

Specified by:

drawCandidates in class CandidateGenerator

Throws:

java.io.IOException

preFilter

protected org.apache.lucene.util.BytesRef preFilter(org.apache.lucene.util.BytesRef term,
                                                    org.apache.lucene.util.CharsRefBuilder spare,
                                                    org.apache.lucene.util.BytesRefBuilder byteSpare)
                                             throws java.io.IOException

Throws:

java.io.IOException

postFilter

protected void postFilter(DirectCandidateGenerator.Candidate candidate,
                          org.apache.lucene.util.CharsRefBuilder spare,
                          org.apache.lucene.util.BytesRefBuilder byteSpare,
                          java.util.List<DirectCandidateGenerator.Candidate> candidates)
                   throws java.io.IOException

Throws:

java.io.IOException

thresholdFrequency

protected long thresholdFrequency(long termFrequency,
                                  long dictionarySize)

createCandidate

public DirectCandidateGenerator.Candidate createCandidate(org.apache.lucene.util.BytesRef term,
                                                          long frequency,
                                                          double channelScore,
                                                          boolean userInput)
                                                   throws java.io.IOException

Specified by:

createCandidate in class CandidateGenerator

Throws:

java.io.IOException

analyze

public static int analyze(org.apache.lucene.analysis.Analyzer analyzer,
                          org.apache.lucene.util.BytesRef toAnalyze,
                          java.lang.String field,
                          DirectCandidateGenerator.TokenConsumer consumer,
                          org.apache.lucene.util.CharsRefBuilder spare)
                   throws java.io.IOException

Throws:

java.io.IOException

analyze

public static int analyze(org.apache.lucene.analysis.TokenStream stream,
                          DirectCandidateGenerator.TokenConsumer consumer)
                   throws java.io.IOException

NOTE: this method closes the TokenStream, even on exception, which is awkward because really the caller who called Analyzer.tokenStream(java.lang.String, java.io.Reader) should close it, but when trying that there are recursion issues when we try to use the same TokenStream twice in the same recursion...

Throws:

java.io.IOException