com.exalead.suggestapi.client

Class SuggestQuery

java.lang.Object

com.exalead.searchapi.xmlv10.client.AbstractQuery<SuggestQuery,SuggestParameter>

com.exalead.suggestapi.client.SuggestQuery

public class SuggestQuery
extends AbstractQuery<SuggestQuery,SuggestParameter>

Field Summary

Fields inherited from class com.exalead.searchapi.xmlv10.client.AbstractQuery

p

Constructor Summary

Constructors

Constructor and Description
SuggestQuery()
SuggestQuery(java.lang.String query)

Method Summary

Modifier and Type	Method and Description
SuggestQuery	addParameter(java.lang.String name, java.lang.String value) Adds a search parameter which is composed by a name and a value.
SuggestQuery	addSecurityToken(java.lang.String token)
int	getCursorPos()
int	getDistance()
int	getMinStringLengthForDist1()
int	getMinStringLengthForDist2()
SuggestParameter[]	getParameters() Return the list of all parameters
java.lang.String	getQuery()
java.lang.String	getSearchLogic()
java.lang.String[]	getSecurityTokens()
boolean	isAutocomplete()
boolean	isExhaustive()
boolean	isRecursive()
SuggestQuery	removeParameter(java.lang.String name) Removes the parameter(s) with the given name If several parameters have the same name they will all be removed
SuggestQuery	setAutocomplete(boolean autocomplete)
SuggestQuery	setCursorPos(int cursorPos)
SuggestQuery	setDistance(int distance)
SuggestQuery	setExhaustive(boolean exhaustive)
SuggestQuery	setMinStringLengthForDist1(int minStringLengthForDist1)
SuggestQuery	setMinStringLengthForDist2(int minStringLengthForDist2)
SuggestQuery	setParameter(java.lang.String name, java.lang.String value) Set a search parameter on your query.
SuggestQuery	setQuery(java.lang.String query)
SuggestQuery	setRecursive(boolean recursive)
SuggestQuery	setSearchLogic(java.lang.String searchLogic)

Methods inherited from class com.exalead.searchapi.xmlv10.client.AbstractQuery

addParameter, buildRequest, getParameter, getParameters, getParametersList, getParametersList, getParameterValue, getParameterValues, removeParameter, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SuggestQuery

public SuggestQuery(java.lang.String query)

SuggestQuery

public SuggestQuery()

Method Detail

setQuery

public SuggestQuery setQuery(java.lang.String query)

getQuery

public java.lang.String getQuery()

setDistance

public SuggestQuery setDistance(int distance)

getDistance

public int getDistance()

setMinStringLengthForDist1

public SuggestQuery setMinStringLengthForDist1(int minStringLengthForDist1)

getMinStringLengthForDist1

public int getMinStringLengthForDist1()

setMinStringLengthForDist2

public SuggestQuery setMinStringLengthForDist2(int minStringLengthForDist2)

getMinStringLengthForDist2

public int getMinStringLengthForDist2()

setCursorPos

public SuggestQuery setCursorPos(int cursorPos)

getCursorPos

public int getCursorPos()

setSearchLogic

public SuggestQuery setSearchLogic(java.lang.String searchLogic)

getSearchLogic

public java.lang.String getSearchLogic()

setExhaustive

public SuggestQuery setExhaustive(boolean exhaustive)

isExhaustive

public boolean isExhaustive()

setRecursive

public SuggestQuery setRecursive(boolean recursive)

isRecursive

public boolean isRecursive()

setAutocomplete

public SuggestQuery setAutocomplete(boolean autocomplete)

isAutocomplete

public boolean isAutocomplete()

addSecurityToken

public SuggestQuery addSecurityToken(java.lang.String token)

getSecurityTokens

public java.lang.String[] getSecurityTokens()

addParameter

public SuggestQuery addParameter(java.lang.String name,
                                 java.lang.String value)

Adds a search parameter which is composed by a name and a value. Using search parameters instead of the different setters on the SearchQuery may be convenient when the query is built from HTTP parameters Standard parameter names are static fields of the class SearchParameter

Overrides:

addParameter in class AbstractQuery<SuggestQuery,SuggestParameter>

Parameters:

name - the name of the search parameter. null is not acceptable.

value - the value of the search parameter. null is not acceptable.

removeParameter

public SuggestQuery removeParameter(java.lang.String name)

Removes the parameter(s) with the given name If several parameters have the same name they will all be removed

Overrides:

removeParameter in class AbstractQuery<SuggestQuery,SuggestParameter>

setParameter

public SuggestQuery setParameter(java.lang.String name,
                                 java.lang.String value)

Set a search parameter on your query. If other parameters with the same name exist, they are removed and replaced.

Overrides:

setParameter in class AbstractQuery<SuggestQuery,SuggestParameter>

Parameters:

name - : search parameter name

Returns:

this for easy "chaining" of set calls

See Also:

addParameter

getParameters

public SuggestParameter[] getParameters()

Return the list of all parameters

Specified by:

getParameters in class AbstractQuery<SuggestQuery,SuggestParameter>