Package de.cxp.ocs.model.params

Class SearchQuery

java.lang.Object

de.cxp.ocs.model.params.SearchQuery

Direct Known Subclasses:

FilteredSearchQuery

public class SearchQuery
extends Object

SearchQuery model that contains all "explicit" parameters for a search requests, so not the filters. The main reason for this is how query-expansion works with spring boot.

For a full search query, the extended class FilteredSearchQuery can be used.

Field Summary

Fields

Modifier and Type	Field	Description
int	limit
int	offset
String	q	the user query.
String	sort	Full sorting parameter value.
boolean	withFacets	flag to specify if facets should be returned with the requested response.

Constructor Summary

Constructors

Constructor	Description
SearchQuery()

Method Summary

Modifier and Type	Method	Description
String	asUri()

Methods inherited from class java.lang.Object

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

Field Details

q

public String q

the user query.

sort

public String sort

Full sorting parameter value. This is the name of the sorting and optionally a dash as prefix, thats means the sorting should be descending. Several sorting criterion can be defined by separating the values using comma.

examples:

• sort=price (ascending by price)
• sort=-price (descendending by price)
• sort=price,-name (price asc and name descending)

limit

public int limit

offset

public int offset

withFacets

public boolean withFacets

flag to specify if facets should be returned with the requested response. Should be set to false in case only the next batch of hits is requested (e.g. for endless scrolling).

Constructor Details

SearchQuery

public SearchQuery()

Method Details

asUri

public String asUri()