Package de.cxp.ocs.util

Class SearchParamsParser

java.lang.Object

de.cxp.ocs.util.SearchParamsParser

public class SearchParamsParser
extends Object

Utility class to parse search parameters

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ID_FILTER_SUFFIX
static final int	MAX_RESULT_COUNT	Max result count as defined by default Elasticsearch setting 'max_result_window'
static final String	NEGATE_FILTER_PREFIX

Constructor Summary

Constructors

Constructor	Description
SearchParamsParser()

Method Summary

Modifier and Type	Method	Description
static InternalSearchParams	extractInternalParams(SearchQuery searchQuery, Map<String,String> filters, SearchContext searchContext)
static List<InternalResultFilter>	parseFilters(Map<String,String> filterValues, FieldConfigIndex fieldConfig, Locale locale)	Checks the parameter map for valid filters and extracts them into InternalResultFilter objects.
static Optional<InternalResultFilter>	parseSingleFilter(String paramName, String paramValue, FieldConfigIndex fieldConfig, Locale locale)
static List<SortInstruction>	parseSortings(String paramValue, FieldConfigIndex fields)	Parses the sorting parameter into a list of enriched Sorting objects.
static InternalResultFilter	toInternalFilter(Field field, String[] paramValues, Locale locale, boolean isIdFilter, boolean negate)
static InternalResultFilter	toInternalFilter(Field field, String paramValue, Locale locale, boolean isIdFilter)

Methods inherited from class java.lang.Object

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

Field Details

MAX_RESULT_COUNT

public static final int MAX_RESULT_COUNT

Max result count as defined by default Elasticsearch setting 'max_result_window'

See Also:

• Constant Field Values

ID_FILTER_SUFFIX

public static final String ID_FILTER_SUFFIX

See Also:

• Constant Field Values

NEGATE_FILTER_PREFIX

public static final String NEGATE_FILTER_PREFIX

See Also:

• Constant Field Values

Constructor Details

SearchParamsParser

public SearchParamsParser()

Method Details

extractInternalParams

public static InternalSearchParams extractInternalParams(SearchQuery searchQuery,
 Map<String,String> filters,
 SearchContext searchContext)

parseFilters

public static List<InternalResultFilter> parseFilters(Map<String,String> filterValues,
 FieldConfigIndex fieldConfig,
 Locale locale)

Checks the parameter map for valid filters and extracts them into InternalResultFilter objects.

Parameters:

filterValues - parameters as sent in the request

fieldConfig - the field configuration

locale - locale for filter value normalization

Returns:

validated and enriched filter values for internal usage

parseSingleFilter

public static Optional<InternalResultFilter> parseSingleFilter(String paramName,
 String paramValue,
 FieldConfigIndex fieldConfig,
 Locale locale)

toInternalFilter

public static InternalResultFilter toInternalFilter(Field field,
 String paramValue,
 Locale locale,
 boolean isIdFilter)

toInternalFilter

public static InternalResultFilter toInternalFilter(Field field,
 String[] paramValues,
 Locale locale,
 boolean isIdFilter,
 boolean negate)

parseSortings

public static List<SortInstruction> parseSortings(String paramValue,
 FieldConfigIndex fields)

Parses the sorting parameter into a list of enriched Sorting objects.

Parameters:

paramValue - the sorting parameter value

fields - the field configuration

Returns:

list of validated sortings