org.compass.core.engine.spellcheck
Interface SearchEngineSpellCheckSuggestBuilder

All Known Implementing Classes:
DefaultLuceneSearchEngineSpellCheckSuggestBuilder

public interface SearchEngineSpellCheckSuggestBuilder

A builder allowing to create suggestions for a given word.

Author:
kimchy

Method Summary
 SearchEngineSpellCheckSuggestBuilder accuracy(float accuracy)
          Sets the accuracy.
 SearchEngineSpellCheckSuggestBuilder aliases(String... aliases)
          Narrows down the spell check suggestions to the given sub aliases.
 SearchEngineSpellCheckSuggestBuilder morePopular(boolean morePopular)
          Return only the suggest words that are more frequent than the searched word.
 SearchEngineSpellCheckSuggestBuilder numberOfSuggestions(int numberOfSuggestions)
          Restricts the number of suggestions.
 SearchEngineSpellCheckSuggestBuilder restrictToProperty(String restrictToProperty)
          Restricts the suggested words to the words present in this property.
 SearchEngineSpellCheckSuggestBuilder subIndexes(String... subIndexes)
          Narrows down the spell check suggestions to the given sub indexes.
 SearchEngineSpellSuggestions suggest()
          Returns the given suggestions for the word.
 SearchEngineSpellCheckSuggestBuilder types(Class... types)
          Narrows down the spell check suggestions to the given types.
 

Method Detail

subIndexes

SearchEngineSpellCheckSuggestBuilder subIndexes(String... subIndexes)
Narrows down the spell check suggestions to the given sub indexes.


aliases

SearchEngineSpellCheckSuggestBuilder aliases(String... aliases)
Narrows down the spell check suggestions to the given sub aliases.


types

SearchEngineSpellCheckSuggestBuilder types(Class... types)
Narrows down the spell check suggestions to the given types.


numberOfSuggestions

SearchEngineSpellCheckSuggestBuilder numberOfSuggestions(int numberOfSuggestions)
Restricts the number of suggestions. Defaults to 1.


restrictToProperty

SearchEngineSpellCheckSuggestBuilder restrictToProperty(String restrictToProperty)
Restricts the suggested words to the words present in this property.


morePopular

SearchEngineSpellCheckSuggestBuilder morePopular(boolean morePopular)
Return only the suggest words that are more frequent than the searched word.


accuracy

SearchEngineSpellCheckSuggestBuilder accuracy(float accuracy)
Sets the accuracy. Defauts to the value of LuceneEnvironment.SpellCheck.ACCURACY which, in turn, defaults to 0.5f.


suggest

SearchEngineSpellSuggestions suggest()
Returns the given suggestions for the word.



Copyright (c) 2004-2009 The Compass Project.