com.exalead.searchapi.xmlv10.client

Class AbstractQuery<T extends AbstractQuery,P extends AbstractParameter>

java.lang.Object

com.exalead.searchapi.xmlv10.client.AbstractQuery<T,P>

Direct Known Subclasses:

SearchQuery, SuggestQuery

public abstract class AbstractQuery<T extends AbstractQuery,P extends AbstractParameter>
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected AbstractParametersContainer<P>	p

Constructor Summary

Constructors

Constructor and Description
AbstractQuery(AbstractParametersContainer<P> p)

Method Summary

Modifier and Type	Method and Description
void	addParameter(SearchParameter param) Deprecated. "SearchParameter" is simply a key/value holder. addParameter(String name, String value) should be preferred
T	addParameter(java.lang.String name, java.lang.String value) Adds a search parameter which is composed by a name and a value.
java.lang.String	buildRequest()
SearchParameter	getParameter(java.lang.String name) Return the parameter with this name.
abstract P[]	getParameters() Return the list of all parameters
java.lang.String[]	getParameters(java.lang.String name) Return the list of parameters with this name.
java.util.List<P>	getParametersList() Return the list of all parameters
java.util.List<P>	getParametersList(java.lang.String name) Return the list of parameters with this name.
java.lang.String	getParameterValue(java.lang.String name) Return the parameter value with this name.
java.util.List<java.lang.String>	getParameterValues(java.lang.String name) Return the list of parameters values with this name.
void	removeParameter(SearchParameter param) Deprecated.
T	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
T	setParameter(java.lang.String name, java.lang.String value) Set a search parameter on your query.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

p

protected AbstractParametersContainer<P extends AbstractParameter> p

Constructor Detail

AbstractQuery

public AbstractQuery(AbstractParametersContainer<P> p)

Method Detail

addParameter

public T 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

Parameters:

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

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

addParameter

@Deprecated
public void addParameter(SearchParameter param)

Deprecated. "SearchParameter" is simply a key/value holder. addParameter(String name, String value) should be preferred

Adds a search parameter to your query. Using search parameters instead of the different setters on the SearchQuery may be convenient when the query is built form http parameters Standard parameter names are static fields of the class SearchParameter (ex: @link{SearchParameter#LANG}). (Note that these names are then translated to the corresponding parameters in the selected api version (4.6 or 5.0)

Parameters:

name - the name of search parameter

value - a value

See Also:

SearchParameter

removeParameter

public T 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

removeParameter

@Deprecated
public void removeParameter(SearchParameter param)

Deprecated.

setParameter

public T 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.

Parameters:

name - : search parameter name

value: - parameter value to set.

Returns:

this for easy "chaining" of set calls

See Also:

addParameter

getParametersList

public java.util.List<P> getParametersList()

Return the list of all parameters

getParameters

public abstract P[] getParameters()

Return the list of all parameters

getParametersList

public java.util.List<P> getParametersList(java.lang.String name)

Return the list of parameters with this name. If no parameters with this name exist in the query, an empty list is returned.

getParameters

public java.lang.String[] getParameters(java.lang.String name)

Return the list of parameters with this name. If no parameters with this name exist in the query, an empty list is returned.

getParameterValues

public java.util.List<java.lang.String> getParameterValues(java.lang.String name)

Return the list of parameters values with this name. If no parameters with this name exist in the query, an empty list is returned.

getParameterValue

public java.lang.String getParameterValue(java.lang.String name)
                                   throws java.lang.IllegalArgumentException

Return the parameter value with this name.

Returns:

The parameter value if it exists, null if no parameters with this name exist in the query

Throws:

java.lang.IllegalArgumentException - if several parameters with this name exist

getParameter

public SearchParameter getParameter(java.lang.String name)
                             throws java.lang.IllegalArgumentException

Return the parameter with this name.

Returns:

The parameter value if it exists, null if no parameters with this name exist in the query

Throws:

java.lang.IllegalArgumentException - if several parameters with this name exist

buildRequest

public java.lang.String buildRequest()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object