Package de.cxp.ocs.util

Class InternalSearchParams

java.lang.Object

de.cxp.ocs.util.InternalSearchParams

public class InternalSearchParams
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
int	aggSampling	If set to a value > 0, the facets are build only on the top N hits (samples) of the result.
Map<String,String>	customParams
Set<String>	excludedIds
List<InternalResultFilter>	filters
StaticProductSet[]	heroProductSets
boolean	includeMainResult	See ArrangedSearchQuery::includeMainResult
List<InternalResultFilter>	inducedFilters	Optional filters added by the analyzer that should only be applied internally but not exposed in the result.
int	limit
int	offset
List<SortInstruction>	sortings
TraceOptions	trace
String	userQuery
boolean	withFacets	flag to specify if facets are necessary.
boolean	withResultData	Flag to specify if the full documents should be returned or not.

Constructor Summary

Constructors

Constructor	Description
InternalSearchParams()

Method Summary

Modifier and Type	Method	Description
String	getValueOf(String name)
InternalSearchParams	withFilter(InternalResultFilter filter)
InternalSearchParams	withSorting(SortInstruction sorting)

Methods inherited from class java.lang.Object

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

Field Details

limit

public int limit

aggSampling

public int aggSampling

If set to a value > 0, the facets are build only on the top N hits (samples) of the result.

offset

public int offset

userQuery

public String userQuery

withFacets

public boolean withFacets

flag to specify if facets are necessary. Should be set to false in case only the next batch of hits is requests (e.g. for endless scrolling).

withResultData

public boolean withResultData

Flag to specify if the full documents should be returned or not. Default: true. If set to "false", the documents are just returned with their IDs.

includeMainResult

public boolean includeMainResult

See ArrangedSearchQuery::includeMainResult

sortings

public List<SortInstruction> sortings

filters

public List<InternalResultFilter> filters

inducedFilters

public List<InternalResultFilter> inducedFilters

Optional filters added by the analyzer that should only be applied internally but not exposed in the result.

customParams

public Map<String,String> customParams

heroProductSets

public StaticProductSet[] heroProductSets

excludedIds

public Set<String> excludedIds

trace

public TraceOptions trace

Constructor Details

InternalSearchParams

public InternalSearchParams()

Method Details

withSorting

public InternalSearchParams withSorting(SortInstruction sorting)

withFilter

public InternalSearchParams withFilter(InternalResultFilter filter)

getValueOf

public String getValueOf(String name)