Package dev.evo.elasticmagic.qf

Types

AppliedQueryFilters

class AppliedQueryFilters(queryFilters: <ERROR CLASS><String, BoundFilter<*, *>>, preparedFilters: Map<String, PreparedFilter<*>>)

BoundFilter

class BoundFilter<C : PreparedFilter<R>, R : FilterResult>(name: String, filter: Filter<C, R>)

FacetFilter

class FacetFilter<T, V>(field: <ERROR CLASS><V>, name: String?, mode: FacetFilterMode, termsAgg: <ERROR CLASS><T>) : Filter<PreparedFacetFilter<T>, FacetFilterResult<T>>

FacetFilter calculates counts for a field values and allows a search query to be filtered by those values.

FacetFilterMode

enum FacetFilterMode : Enum<FacetFilterMode>

FacetFilterMode determines a way how values should be filtered:

UNION - 2 or more selected values are combined with OR operator. Most of the facet filters should use this mode. For example, you are buying car wheels of one of the sizes: R16 or R17. So after you choose corresponding values, a search query will be filtered with in following way: wheel_size == R16 || wheel_size == R17
INTERSECT - 2 or more selected values are combined using AND operator. Especially useful with multi-valued fields. For example, you want to buy a charger that supports AA, AAA and 18650 battery types. So when you choose all the required values, a generated search query should be filtered with battery_type == AA && battery_type == AAA && battery_type == 18650

FacetFilterResult

data class FacetFilterResult<T>(name: String, mode: FacetFilterMode, values: List<FacetFilterValue<T>>, selected: Boolean) : FilterResult, Iterable<FacetFilterValue<T>>

FacetFilterResult represents result of a FacetFilter.

FacetFilterValue

data class FacetFilterValue<T>(bucket: <ERROR CLASS><T>, selected: Boolean)

FacetFilterValue represents bucket of the corresponding terms aggregation.

FacetRangeFilter

class FacetRangeFilter<T>(field: <ERROR CLASS><T>, name: String?, aggs: Map<String, <ERROR CLASS><out <ERROR CLASS>>>) : Filter<PreparedFacetRangeFilter<T>, FacetRangeFilterResult<T>>

FacetRangeFilter filters a search query using a dev.evo.elasticmagic.query.

FacetRangeFilterResult

data class FacetRangeFilterResult<T>(name: String, from: T?, to: T?, count: Long, aggs: Map<String, <ERROR CLASS>>) : FilterResult

FacetRangeFilterResult contains result of a FacetRangeFilter.

Filter

abstract class Filter<C : PreparedFilter<R>, R : FilterResult>(name: String?)

FilterResult

interface FilterResult

MutableQueryFilterParams

typealias MutableQueryFilterParams = MutableMap<<ERROR CLASS><String, String>, MutableList<String>>

PageFilter

class PageFilter(name: String?, availablePageSizes: List<Int>, defaultPageSize: Int?, maxHits: Int) : Filter<PageFilterContext, PageFilterResult>

PageFilter allows to paginate search query results.

PageFilterContext

class PageFilterContext(filter: PageFilter, name: String, page: Int, perPage: Int, from: Int, size: Int) : PreparedFilter<PageFilterResult>

Filter that is ready for applying to a search query.

PageFilterResult

data class PageFilterResult(name: String, hits: List<<ERROR CLASS><out <ERROR CLASS>>>, totalHits: Long, page: Int, perPage: Int, totalPages: Int, from: Int, size: Int) : FilterResult, Iterable<<ERROR CLASS><out <ERROR CLASS>>>

PageFilterResult holds result of a PageFilter.

PreparedFacetFilter

class PreparedFacetFilter<T>(filter: FacetFilter<T, *>, name: String, facetFilterExpr: <ERROR CLASS>?, selectedValues: List<Any?>) : PreparedFilter<FacetFilterResult<T>>

Filter that is ready for applying to a search query.

PreparedFacetRangeFilter

class PreparedFacetRangeFilter<T>(filter: FacetRangeFilter<T>, name: String, facetFilterExpr: <ERROR CLASS>?, from: Any?, to: Any?) : PreparedFilter<FacetRangeFilterResult<T>>

Filter that is ready for applying to a search query.

PreparedFilter

abstract class PreparedFilter<R : FilterResult>(name: String, facetFilterExpr: <ERROR CLASS>?)

PreparedSortFilter

class PreparedSortFilter(filter: SortFilter, name: String, selectedValue: SortFilterValue) : PreparedFilter<SortFilterResult>

Filter that is ready for applying to a search query.

QueryFilterParams

typealias QueryFilterParams = Map<<ERROR CLASS><String, String>, List<String>>

QueryFilters

open class QueryFilters : Iterable<BoundFilter<*, *>>

QueryFiltersResult

class QueryFiltersResult(results: <ERROR CLASS><String, FilterResult>) : Iterable<FilterResult>

SortFilter

class SortFilter(sortValues: SortFilterValue, name: String?) : Filter<PreparedSortFilter, SortFilterResult>

SortFilter applies a sorting to a search query.

SortFilterResult

data class SortFilterResult(name: String, values: List<SortFilterValueResult>) : FilterResult

Result of the SortFilter.

SortFilterValue

class SortFilterValue(value: String, sorts: List<<ERROR CLASS>>)

SortFilterValue holds a value of a sort and a list of Sort that should be applied when the value is selected.

SortFilterValueResult

data class SortFilterValueResult(value: String, selected: Boolean)

Represents result of the SortFilterValue.

Functions

decodeLastValue

fun <T> QueryFilterParams.decodeLastValue(key: <ERROR CLASS><String, String>, fieldType: <ERROR CLASS><out <ERROR CLASS>, T>): T?

decodeValues

fun <T> QueryFilterParams.decodeValues(key: <ERROR CLASS><String, String>, fieldType: <ERROR CLASS><out <ERROR CLASS>, T>): List<T>