com.elasticpath.persistence
Interface SpellIndexSearcher

All Known Implementing Classes:

SpellIndexSearcherImpl

public interface SpellIndexSearcher

An interface that describes a way to access a spelling index to determine if a word exists, or suggest words similar to a provided word.

Method Summary

java.lang.String[]

suggest(java.lang.String spellIndexDir, java.lang.String sourceIndexDir, java.lang.String field, java.lang.String query, java.util.Locale locale) Generates a list of alternate queries that are similar to the supplied query.

Method Detail

suggest

java.lang.String[] suggest(java.lang.String spellIndexDir,
                           java.lang.String sourceIndexDir,
                           java.lang.String field,
                           java.lang.String query,
                           java.util.Locale locale)

Generates a list of alternate queries that are similar to the supplied query.

Parameters:

spellIndexDir - the directory of the spelling index

sourceIndexDir - the directory of the source index

field - the field of the source index

query - the original query

locale - the locale to use to search

Returns:

the list of alternate queries