org.craftercms.search.service.impl

Class SolrQuery

java.lang.Object

org.craftercms.search.service.impl.QueryParams

org.craftercms.search.service.impl.SolrQuery

All Implemented Interfaces:

Query

public class SolrQuery
extends QueryParams

Search query for Solr.

Author:

Alfonso Vásquez

Field Summary

Fields

Modifier and Type	Field and Description
static String	FIELDS_TO_RETURN
static String	FILTER_QUERY_PARAM
static String	HIGHLIGHT_FIELDS_PARAM
static String	HIGHLIGHT_PARAM
static String	HIGHLIGHT_SNIPPET_SIZE_PARAM
static String	HIGHLIGHT_SNIPPETS_PARAM
static String	QUERY_PARAM
static String	ROWS_PARAM
static String	START_PARAM

Fields inherited from class org.craftercms.search.service.impl.QueryParams

DISABLE_ADDITIONAL_FILTERS_PARAM

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
SolrQuery	addFilterQuery(String query)
String[]	getFieldsToReturn() Returns the fields that should be returned.
String[]	getFilterQueries()
String[]	getHighlightFields()
int	getHighlightSnippets()
int	getHighlightSnippetSize()
int	getNumResults() Returns the number of results to return.
int	getOffset() Returns the offset of the results.
String	getQuery() Returns the actual query.
int	getRows()
int	getStart()
boolean	isHighlight()
SolrQuery	setFieldsToReturn(String... fields) Sets the fields that should be returned.
SolrQuery	setFilterQueries(String... queries)
SolrQuery	setHighlight(boolean highlight)
SolrQuery	setHighlightFields(String... fields)
SolrQuery	setHighlightSnippets(int snippets)
SolrQuery	setHighlightSnippetSize(int size)
Query	setNumResults(int numResults) Sets the number of results to return.
Query	setOffset(int offset) Sets the offset of the results.
SolrQuery	setQuery(String query) Sets the actual query.
SolrQuery	setRows(int rows)
SolrQuery	setStart(int start)

Methods inherited from class org.craftercms.search.service.impl.QueryParams

addParam, addParam, getParam, getParams, getSingleValue, hasParam, isDisableAdditionalFilters, setDisableAdditionalFilters, setParam, toString, toUrlQueryString

Methods inherited from class java.lang.Object

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

Field Detail

FIELDS_TO_RETURN

public static final String FIELDS_TO_RETURN

See Also:

Constant Field Values

HIGHLIGHT_PARAM

public static final String HIGHLIGHT_PARAM

See Also:

Constant Field Values

HIGHLIGHT_FIELDS_PARAM

public static final String HIGHLIGHT_FIELDS_PARAM

See Also:

Constant Field Values

HIGHLIGHT_SNIPPETS_PARAM

public static final String HIGHLIGHT_SNIPPETS_PARAM

See Also:

Constant Field Values

HIGHLIGHT_SNIPPET_SIZE_PARAM

public static final String HIGHLIGHT_SNIPPET_SIZE_PARAM

See Also:

Constant Field Values

QUERY_PARAM

public static final String QUERY_PARAM

See Also:

Constant Field Values

FILTER_QUERY_PARAM

public static final String FILTER_QUERY_PARAM

See Also:

Constant Field Values

START_PARAM

public static final String START_PARAM

See Also:

Constant Field Values

ROWS_PARAM

public static final String ROWS_PARAM

See Also:

Constant Field Values

Constructor Detail

SolrQuery

public SolrQuery()

SolrQuery

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

Method Detail

setOffset

public Query setOffset(int offset)

Description copied from interface: Query

Sets the offset of the results.

getOffset

public int getOffset()

Description copied from interface: Query

Returns the offset of the results.

setNumResults

public Query setNumResults(int numResults)

Description copied from interface: Query

Sets the number of results to return.

getNumResults

public int getNumResults()

Description copied from interface: Query

Returns the number of results to return.

setFieldsToReturn

public SolrQuery setFieldsToReturn(String... fields)

Description copied from interface: Query

Sets the fields that should be returned.

getFieldsToReturn

public String[] getFieldsToReturn()

Description copied from interface: Query

Returns the fields that should be returned.

getQuery

public String getQuery()

Description copied from interface: Query

Returns the actual query.

setQuery

public SolrQuery setQuery(String query)

Description copied from interface: Query

Sets the actual query.

isHighlight

public boolean isHighlight()

setHighlight

public SolrQuery setHighlight(boolean highlight)

getHighlightFields

public String[] getHighlightFields()

setHighlightFields

public SolrQuery setHighlightFields(String... fields)

getHighlightSnippets

public int getHighlightSnippets()

setHighlightSnippets

public SolrQuery setHighlightSnippets(int snippets)

getHighlightSnippetSize

public int getHighlightSnippetSize()

setHighlightSnippetSize

public SolrQuery setHighlightSnippetSize(int size)

getFilterQueries

public String[] getFilterQueries()

setFilterQueries

public SolrQuery setFilterQueries(String... queries)

addFilterQuery

public SolrQuery addFilterQuery(String query)

getStart

public int getStart()

setStart

public SolrQuery setStart(int start)

getRows

public int getRows()

setRows

public SolrQuery setRows(int rows)