org.craftercms.search.service.impl

Class QueryParams

java.lang.Object

org.craftercms.search.service.impl.QueryParams

All Implemented Interfaces:

Query

Direct Known Subclasses:

SolrQuery

public abstract class QueryParams
extends Object
implements Query

Simple Query represented as a map of query parameters.

Author:

Alfonso Vásquez

Field Summary

Fields

Modifier and Type	Field and Description
static String	DISABLE_ADDITIONAL_FILTERS_PARAM

Constructor Summary

Constructors

Constructor and Description
QueryParams()
QueryParams(Map<String,String[]> params)

Method Summary

Modifier and Type	Method and Description
QueryParams	addParam(String name, String... values)
QueryParams	addParam(String name, String value)
String[]	getParam(String name)
Map<String,String[]>	getParams()
protected String	getSingleValue(String param)
boolean	hasParam(String name)
boolean	isDisableAdditionalFilters() Returns true if the additional Crafter Search filters should be disabled on query execution.
Query	setDisableAdditionalFilters(boolean disableAdditionalFilters) Sets if the additional Crafter Search filters should be disabled on query execution.
QueryParams	setParam(String name, String value)
String	toString()
String	toUrlQueryString() Converts this query to an URL query string.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.craftercms.search.service.Query

getFieldsToReturn, getNumResults, getOffset, getQuery, setFieldsToReturn, setNumResults, setOffset, setQuery

Field Detail

DISABLE_ADDITIONAL_FILTERS_PARAM

public static final String DISABLE_ADDITIONAL_FILTERS_PARAM

See Also:

Constant Field Values

Constructor Detail

QueryParams

public QueryParams()

QueryParams

public QueryParams(Map<String,String[]> params)

Method Detail

hasParam

public boolean hasParam(String name)

getParam

public String[] getParam(String name)

setParam

public QueryParams setParam(String name,
                            String value)

addParam

public QueryParams addParam(String name,
                            String value)

addParam

public QueryParams addParam(String name,
                            String... values)

getParams

public Map<String,String[]> getParams()

setDisableAdditionalFilters

public Query setDisableAdditionalFilters(boolean disableAdditionalFilters)

Description copied from interface: Query

Sets if the additional Crafter Search filters should be disabled on query execution.

Specified by:

setDisableAdditionalFilters in interface Query

isDisableAdditionalFilters

public boolean isDisableAdditionalFilters()

Description copied from interface: Query

Returns true if the additional Crafter Search filters should be disabled on query execution.

Specified by:

isDisableAdditionalFilters in interface Query

toUrlQueryString

public String toUrlQueryString()

Description copied from interface: Query

Converts this query to an URL query string.

Specified by:

toUrlQueryString in interface Query

toString

public String toString()

Overrides:

toString in class Object

getSingleValue

protected String getSingleValue(String param)