org.eaglei.lexical
Interface SuggestionProvider

public interface SuggestionProvider

Interface for classes the implement auto-suggest functionality. Implementations should assume that input text can represent a partially completed word or phrase (e.g. "D" vs "DNA" or "mi" vs "microscope").

Author:

rfrost

Method Summary

java.util.List<EntityMatch>

suggest(EntityMatchRequest request) Retrieves suggestions for the specified request.

Method Detail

suggest

java.util.List<EntityMatch> suggest(EntityMatchRequest request)
                                    throws java.io.IOException

Retrieves suggestions for the specified request.

Parameters:

request - The suggestion request.

Returns:

List of generated suggestions in relevance ranked order.

Throws:

java.io.IOException - Thrown if an error is encountered generating the suggestions.