com.exalead.searchapi.client

Interface SearchAPIClient

public interface SearchAPIClient

Method Summary

Modifier and Type	Method and Description
DictionaryClient	dictionaryClient() Obtain a dictionary client pointing to the default command
DictionaryClient	dictionaryClient(java.lang.String command) Obtain a dictionary client pointing to this command
FetchClient	fetchClient() Obtain a fetch client pointing to the default command
FetchClient	fetchClient(java.lang.String docFetchCommand, java.lang.String previewCommand, java.lang.String thumbnailsCommand) Obtain a fetch client pointing to these commands
IntrospectionClient	introspectionClient(java.lang.String command)
SearchClient	searchClient() Obtain a search client pointing to the default command
SearchClient	searchClient(java.lang.String command) Obtain a search client pointing to this command
SecurityClient	securityClient() Obtain a security client pointing to the default command
SecurityClient	securityClient(java.lang.String command) Obtain a security client pointing to this command
void	setDefaultDictionaryCommand(java.lang.String command) Sets the dictionary command to use when none is specified
void	setDefaultDocumentFetchCommand(java.lang.String command) Sets the fetch command to use when none is specified
void	setDefaultPreviewCommand(java.lang.String command) Sets the preview command to use when none is specified
void	setDefaultSearchCommand(java.lang.String command) Sets the search command to use when none is specified
void	setDefaultSecurityCommand(java.lang.String command) Sets the security command to use when none is specified
void	setDefaultSpellCheckCommand(java.lang.String command) Sets the spellcheck command to use when none is specified
void	setDefaultSuggestCommand(java.lang.String command) Sets the suggest command to use when none is specified
void	setDefaultThumbnailsCommand(java.lang.String command) Sets the thumbnail command to use when none is specified
void	setSearchAPIVersion(SearchAPIVersion version)
SpellCheckClient	spellCheckClient() Obtain a spellcheck client pointing to the default command
SpellCheckClient	spellCheckClient(java.lang.String command) Obtain a spellcheck client pointing to this command
SuggestClient	suggestClient() Obtain a suggest client pointing to the default command
SuggestClient	suggestClient(java.lang.String command) Obtain a suggest client pointing to this command

Method Detail

setDefaultSearchCommand

void setDefaultSearchCommand(java.lang.String command)

Sets the search command to use when none is specified

setSearchAPIVersion

void setSearchAPIVersion(SearchAPIVersion version)

searchClient

SearchClient searchClient(java.lang.String command)

Obtain a search client pointing to this command

searchClient

SearchClient searchClient()
                   throws java.lang.IllegalArgumentException

Obtain a search client pointing to the default command

Throws:

java.lang.IllegalArgumentException

setDefaultSecurityCommand

void setDefaultSecurityCommand(java.lang.String command)

Sets the security command to use when none is specified

securityClient

SecurityClient securityClient(java.lang.String command)

Obtain a security client pointing to this command

securityClient

SecurityClient securityClient()
                       throws java.lang.IllegalArgumentException

Obtain a security client pointing to the default command

Throws:

java.lang.IllegalArgumentException

setDefaultSpellCheckCommand

void setDefaultSpellCheckCommand(java.lang.String command)

Sets the spellcheck command to use when none is specified

spellCheckClient

SpellCheckClient spellCheckClient(java.lang.String command)

Obtain a spellcheck client pointing to this command

spellCheckClient

SpellCheckClient spellCheckClient()
                           throws java.lang.IllegalArgumentException

Obtain a spellcheck client pointing to the default command

Throws:

java.lang.IllegalArgumentException

setDefaultSuggestCommand

void setDefaultSuggestCommand(java.lang.String command)

Sets the suggest command to use when none is specified

suggestClient

SuggestClient suggestClient(java.lang.String command)

Obtain a suggest client pointing to this command

suggestClient

SuggestClient suggestClient()
                     throws java.lang.IllegalArgumentException

Obtain a suggest client pointing to the default command

Throws:

java.lang.IllegalArgumentException

setDefaultDictionaryCommand

void setDefaultDictionaryCommand(java.lang.String command)

Sets the dictionary command to use when none is specified

dictionaryClient

DictionaryClient dictionaryClient(java.lang.String command)

Obtain a dictionary client pointing to this command

dictionaryClient

DictionaryClient dictionaryClient()
                           throws java.lang.IllegalArgumentException

Obtain a dictionary client pointing to the default command

Throws:

java.lang.IllegalArgumentException

setDefaultDocumentFetchCommand

void setDefaultDocumentFetchCommand(java.lang.String command)

Sets the fetch command to use when none is specified

setDefaultPreviewCommand

void setDefaultPreviewCommand(java.lang.String command)

Sets the preview command to use when none is specified

setDefaultThumbnailsCommand

void setDefaultThumbnailsCommand(java.lang.String command)

Sets the thumbnail command to use when none is specified

fetchClient

FetchClient fetchClient()
                 throws java.lang.IllegalArgumentException

Obtain a fetch client pointing to the default command

Throws:

java.lang.IllegalArgumentException

fetchClient

FetchClient fetchClient(java.lang.String docFetchCommand,
                        java.lang.String previewCommand,
                        java.lang.String thumbnailsCommand)

Obtain a fetch client pointing to these commands

introspectionClient

IntrospectionClient introspectionClient(java.lang.String command)