com.exalead.search.query

Class SearchParameters

java.lang.Object

com.exalead.search.query.SearchParameters

All Implemented Interfaces:

java.lang.Cloneable

public class SearchParameters
extends java.lang.Object
implements java.lang.Cloneable

This class stores all user parameters for a query. It groups them by "parameter type" (all query expansion configs grouped together), even if they don't share the same HTTP key (for example, qec.text and qec.title)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchParameters.Entry One entry of the global search parameters map
static interface	SearchParameters.Predicate<T>
static class	SearchParameters.Type All recognized standard search parameter "classes".

Constructor Summary

Constructors

Constructor and Description
SearchParameters()

Method Summary

Modifier and Type	Method and Description
void	addParameter(SearchParameters.Entry orig) Copy a parameter
void	addParameter(SearchParameters.Type type, java.lang.String key, java.lang.String value, boolean addIfExisting) Add a precomputed parameter
void	addParameter(java.lang.String key, java.lang.String value) Compute the type of a parameter and add it
void	addParameterIfNotExisting(SearchParameters.Entry orig) Copy a parameter
void	addParameterIfNotExisting(java.lang.String key, java.lang.String value) Compute the type of a parameter and add it
void	clear() Clear all
SearchParameters	clone() Cloneable implementation
void	freeExpandV2Protobuf()
boolean	getBool(SearchParameters.Type type, boolean defaultValue)
boolean	getBool(java.lang.String key, boolean defaultValue)
com.exalead.expand.progressive.ProgressiveExpandException	getExpandParsingException()
com.exalead.index.query.expand.parser.ExpandQuery.Query.Builder	getExpandRequestParameter()
FormsMapper	getFormsMapper()
SearchParameters.Entry	getParameter(SearchParameters.Type type) Get the only entry for a parameter for a given parameter class
SearchParameters.Entry	getParameter(java.lang.String key) Get the only entry for a parameter for a given parameter key
boolean	getParameterBooleanValue(SearchParameters.Type type, boolean defaultValue) Get the only value of a parameter for a given parameter type as boolean
boolean	getParameterBooleanValue(java.lang.String key, boolean defaultValue) Get the only value of a parameter for a given parameter type as boolean
double	getParameterDoubleValue(SearchParameters.Type type, double defaultValue) Get the only value of a parameter for a given parameter type as double
double	getParameterDoubleValue(java.lang.String key, double defaultValue) Get the only value of a parameter for a given parameter type as double
int	getParameterIntValue(SearchParameters.Type type, int defaultValue) Get the only value of a parameter for a given parameter type as int
int	getParameterIntValue(java.lang.String key, int defaultValue) Get the only value of a parameter for a given parameter key as int
long	getParameterLongValue(SearchParameters.Type type, long defaultValue) Get the only value of a parameter for a given parameter type as int
long	getParameterLongValue(java.lang.String key, long defaultValue) Get the only value of a parameter for a given parameter type as int
java.util.List<SearchParameters.Entry>	getParameters() Get all parameters.
java.util.List<SearchParameters.Entry>	getParameters(SearchParameters.Type type) Get all parameters for a given parameters type.
java.util.List<SearchParameters.Entry>	getParameters(java.lang.String key) Get all parameters for a given string key You must not modify the returned list
java.lang.String	getParameterValue(SearchParameters.Type type) Get the only value of a parameter for a given parameter class
java.lang.String	getParameterValue(SearchParameters.Type type, java.lang.String defaultValue) Get the only value of a parameter for a given parameter class
java.lang.String	getParameterValue(java.lang.String key) Get the only value of a parameter for a given parameter key
java.lang.String	getParameterValue(java.lang.String key, java.lang.String defaultValue) Get the only value of a parameter for a given parameter class
java.util.List<java.lang.String>	getParameterValues(SearchParameters.Type type) Get all parameter values for a given parameters type.
java.util.List<java.lang.String>	getParameterValues(java.lang.String... keys) Get all parameter values for a given parameter keys.
java.util.List<java.lang.String>	getParameterValues(java.lang.String key) Get all parameter values for a given parameters key.
java.util.Map<java.lang.String,com.exalead.index.query.expand.parser.UqlEllqlBuilderPair>	getQueryLanguageMap()
java.lang.String	print() Print a unique string representing these parameters.
java.lang.String	print(java.util.Set<java.lang.String> forbidden) Print a unique string representing these parameters.
java.lang.String	printAsURL() Print a unique string representing these parameters.
java.lang.String	printAsURL(java.util.Set<java.lang.String> forbidden)
void	removeParameter(SearchParameters.Type type, java.lang.String key) Remove all parameters of a given type
void	removeParameters(SearchParameters.Type type) Remove all parameters of a given type
void	setExpandParsingException(com.exalead.expand.progressive.ProgressiveExpandException ex)
void	setExpandRequestParameter(com.exalead.index.query.expand.parser.ExpandQuery.Query.Builder query)
void	setFormsMapper(FormsMapper fm)
void	setQueryLanguageMap(java.util.Map<java.lang.String,com.exalead.index.query.expand.parser.UqlEllqlBuilderPair> queryLanguageMap)
static <T extends java.lang.Comparable<? super T>> void	skewedSort(java.util.List<T> list, SearchParameters.Predicate<T> topPredicate, SearchParameters.Predicate<T> bottomPredicate)

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchParameters

public SearchParameters()

Method Detail

clone

public SearchParameters clone()

Cloneable implementation

Overrides:

clone in class java.lang.Object

clear

public void clear()

Clear all

getParameters

public java.util.List<SearchParameters.Entry> getParameters()

Get all parameters. You must not modify the returned list

getParameters

public java.util.List<SearchParameters.Entry> getParameters(SearchParameters.Type type)

Get all parameters for a given parameters type. You must not modify the returned list

getParameters

public java.util.List<SearchParameters.Entry> getParameters(java.lang.String key)

Get all parameters for a given string key You must not modify the returned list

getParameterValues

public java.util.List<java.lang.String> getParameterValues(SearchParameters.Type type)

Get all parameter values for a given parameters type.

getParameterValues

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

Get all parameter values for a given parameters key.

getParameterValues

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

Get all parameter values for a given parameter keys.

getParameter

public SearchParameters.Entry getParameter(SearchParameters.Type type)
                                    throws java.lang.IllegalArgumentException

Get the only entry for a parameter for a given parameter class

Returns:

null if no parameter matches.

Throws:

java.lang.IllegalArgumentException - if several values match

getParameter

public SearchParameters.Entry getParameter(java.lang.String key)
                                    throws java.lang.IllegalArgumentException

Get the only entry for a parameter for a given parameter key

Returns:

null if no parameter matches.

Throws:

java.lang.IllegalArgumentException - if several values match

getParameterValue

public java.lang.String getParameterValue(SearchParameters.Type type)
                                   throws java.lang.IllegalArgumentException

Get the only value of a parameter for a given parameter class

Returns:

null if no parameter matches.

Throws:

java.lang.IllegalArgumentException - if several values match

getParameterValue

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

Get the only value of a parameter for a given parameter key

Returns:

null if no parameter matches.

Throws:

java.lang.IllegalArgumentException - if several values match

getParameterValue

public java.lang.String getParameterValue(SearchParameters.Type type,
                                          java.lang.String defaultValue)
                                   throws java.lang.IllegalArgumentException

Get the only value of a parameter for a given parameter class

Returns:

defaultValue if no parameter matches.

Throws:

java.lang.IllegalArgumentException - if several values match

getParameterValue

public java.lang.String getParameterValue(java.lang.String key,
                                          java.lang.String defaultValue)
                                   throws java.lang.IllegalArgumentException

Get the only value of a parameter for a given parameter class

Returns:

defaultValue if no parameter matches.

Throws:

java.lang.IllegalArgumentException - if several values match

getParameterIntValue

public int getParameterIntValue(SearchParameters.Type type,
                                int defaultValue)
                         throws java.lang.IllegalArgumentException

Get the only value of a parameter for a given parameter type as int

Returns:

defaultValue if no parameter matches.

Throws:

java.lang.IllegalArgumentException - if several values match

getParameterIntValue

public int getParameterIntValue(java.lang.String key,
                                int defaultValue)
                         throws java.lang.IllegalArgumentException

Get the only value of a parameter for a given parameter key as int

Returns:

defaultValue if no parameter matches.

Throws:

java.lang.IllegalArgumentException - if several values match

getParameterLongValue

public long getParameterLongValue(SearchParameters.Type type,
                                  long defaultValue)
                           throws java.lang.IllegalArgumentException

Get the only value of a parameter for a given parameter type as int

Returns:

defaultValue if no parameter matches.

Throws:

java.lang.IllegalArgumentException - if several values match

getParameterLongValue

public long getParameterLongValue(java.lang.String key,
                                  long defaultValue)
                           throws java.lang.IllegalArgumentException

Get the only value of a parameter for a given parameter type as int

Returns:

defaultValue if no parameter matches.

Throws:

java.lang.IllegalArgumentException - if several values match

getParameterBooleanValue

public boolean getParameterBooleanValue(SearchParameters.Type type,
                                        boolean defaultValue)
                                 throws java.lang.IllegalArgumentException

Get the only value of a parameter for a given parameter type as boolean

Returns:

defaultValue if no parameter matches.

Throws:

java.lang.IllegalArgumentException - if several values match

getParameterBooleanValue

public boolean getParameterBooleanValue(java.lang.String key,
                                        boolean defaultValue)
                                 throws java.lang.IllegalArgumentException

Get the only value of a parameter for a given parameter type as boolean

Returns:

defaultValue if no parameter matches.

Throws:

java.lang.IllegalArgumentException - if several values match

getBool

public boolean getBool(SearchParameters.Type type,
                       boolean defaultValue)
                throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

See Also:

getParameterBooleanValue

getBool

public boolean getBool(java.lang.String key,
                       boolean defaultValue)
                throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

See Also:

getParameterBooleanValue

getParameterDoubleValue

public double getParameterDoubleValue(SearchParameters.Type type,
                                      double defaultValue)
                               throws java.lang.IllegalArgumentException

Get the only value of a parameter for a given parameter type as double

Returns:

defaultValue if no parameter matches.

Throws:

java.lang.IllegalArgumentException - if several values match

getParameterDoubleValue

public double getParameterDoubleValue(java.lang.String key,
                                      double defaultValue)
                               throws java.lang.IllegalArgumentException

Get the only value of a parameter for a given parameter type as double

Returns:

defaultValue if no parameter matches.

Throws:

java.lang.IllegalArgumentException - if several values match

print

public java.lang.String print()

Print a unique string representing these parameters. This string can be used as a query cache key

print

public java.lang.String print(java.util.Set<java.lang.String> forbidden)

Print a unique string representing these parameters. This string can be used as a query cache key

skewedSort

public static <T extends java.lang.Comparable<? super T>> void skewedSort(java.util.List<T> list,
                                                                          SearchParameters.Predicate<T> topPredicate,
                                                                          SearchParameters.Predicate<T> bottomPredicate)

printAsURL

public java.lang.String printAsURL(java.util.Set<java.lang.String> forbidden)

printAsURL

public java.lang.String printAsURL()

Print a unique string representing these parameters. This string can be used as a query cache key

addParameter

public void addParameter(SearchParameters.Type type,
                         java.lang.String key,
                         java.lang.String value,
                         boolean addIfExisting)
                  throws java.lang.IllegalArgumentException

Add a precomputed parameter

Throws:

java.lang.IllegalArgumentException - if trying to add several times a mono-valued parameter

addParameter

public void addParameter(SearchParameters.Entry orig)
                  throws java.lang.IllegalArgumentException

Copy a parameter

Throws:

java.lang.IllegalArgumentException - if trying to add several times a mono-valued parameter

addParameter

public void addParameter(java.lang.String key,
                         java.lang.String value)
                  throws java.lang.IllegalArgumentException

Compute the type of a parameter and add it

Throws:

java.lang.IllegalArgumentException - if the parameter type is unrecognized or if trying to add several times a mono-valued parameter

addParameterIfNotExisting

public void addParameterIfNotExisting(SearchParameters.Entry orig)
                               throws java.lang.IllegalArgumentException

Copy a parameter

Throws:

java.lang.IllegalArgumentException - if trying to add several times a mono-valued parameter

addParameterIfNotExisting

public void addParameterIfNotExisting(java.lang.String key,
                                      java.lang.String value)
                               throws java.lang.IllegalArgumentException

Compute the type of a parameter and add it

Throws:

java.lang.IllegalArgumentException - if the parameter type is unrecognized or if trying to add several times a mono-valued parameter

removeParameters

public void removeParameters(SearchParameters.Type type)

Remove all parameters of a given type

removeParameter

public void removeParameter(SearchParameters.Type type,
                            java.lang.String key)

Remove all parameters of a given type

setExpandRequestParameter

public void setExpandRequestParameter(com.exalead.index.query.expand.parser.ExpandQuery.Query.Builder query)

setQueryLanguageMap

public void setQueryLanguageMap(java.util.Map<java.lang.String,com.exalead.index.query.expand.parser.UqlEllqlBuilderPair> queryLanguageMap)

getExpandRequestParameter

public com.exalead.index.query.expand.parser.ExpandQuery.Query.Builder getExpandRequestParameter()

getQueryLanguageMap

public java.util.Map<java.lang.String,com.exalead.index.query.expand.parser.UqlEllqlBuilderPair> getQueryLanguageMap()

setExpandParsingException

public void setExpandParsingException(com.exalead.expand.progressive.ProgressiveExpandException ex)

getExpandParsingException

public com.exalead.expand.progressive.ProgressiveExpandException getExpandParsingException()

setFormsMapper

public void setFormsMapper(FormsMapper fm)

getFormsMapper

public FormsMapper getFormsMapper()

freeExpandV2Protobuf

public void freeExpandV2Protobuf()