elasticmagic-query-filters/dev.evo.elasticmagic.qf

Package-level declarations

Types

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

AttrBoolFacet

data class AttrBoolFacet(val attrId: Int, val values: List<AttrBoolFacetValue>) : Iterable<AttrBoolFacetValue>

AttrBoolFacetFilter

class AttrBoolFacetFilter(val field: FieldOperations<Long>, name: String? = null) : Filter<AttrBoolFacetFilterResult>

Facet fiter for attribute values. An attribute value is a pair of 2 32-bit values attribute id and value id combined as a single 64-bit field.

AttrBoolFacetFilterResult

data class AttrBoolFacetFilterResult( val name: String, val paramName: String, val facets: Map<Int, AttrBoolFacet>) : FilterResult, Iterable<Map.Entry<Int, AttrBoolFacet>>

AttrBoolFacetValue

data class AttrBoolFacetValue(val value: Boolean, val count: Long)

AttrBoolSimpleFilter

class AttrBoolSimpleFilter(val field: FieldOperations<Long>, name: String? = null) : Filter<BaseFilterResult>

AttrFacet

data class AttrFacet(val attrId: Int, val values: List<AttrFacetValue>) : Iterable<AttrFacetValue>

AttrFacetFilter

class AttrFacetFilter(val field: FieldOperations<Long>, name: String? = null) : Filter<AttrFacetFilterResult>

Facet fiter for attribute values. An attribute value is a pair of 2 32-bit values attribute id and value id combined as a single 64-bit field.

AttrFacetFilterResult

data class AttrFacetFilterResult( val name: String, val paramName: String, val facets: Map<Int, AttrFacet>) : FilterResult, Iterable<Map.Entry<Int, AttrFacet>>

AttrFacetValue

data class AttrFacetValue(val value: Int, val count: Long, val selected: Boolean)

AttrRangeFacet

data class AttrRangeFacet(val attrId: Int, val count: Long, val min: Float?, val max: Float?)

AttrRangeFacetFilter

class AttrRangeFacetFilter(val field: FieldOperations<Long>, name: String? = null) : Filter<AttrRangeFacetFilterResult>

AttrRangeFacetFilterResult

data class AttrRangeFacetFilterResult(val name: String, val paramName: String, val facets: Map<Int, AttrRangeFacet>) : FilterResult

AttrRangeFacetType

object AttrRangeFacetType : SimpleFieldType<AttrRangeFacet>

AttrRangeSimpleFilter

class AttrRangeSimpleFilter(val field: FieldOperations<Long>, name: String? = null) : Filter<BaseFilterResult>

AttrSimpleFilter

class AttrSimpleFilter(val field: FieldOperations<Long>, name: String? = null) : Filter<BaseFilterResult>

BaseFilterResult

open class BaseFilterResult(val name: String, val paramName: String) : FilterResult

Filter that is ready for applying to a search query.

BoundFilter

class BoundFilter<R : FilterResult>(val name: String, val paramName: String, val filter: Filter<R>)

ExpressionValue

class ExpressionValue(val name: String, val expr: QueryExpression)

FacetExpressionFilterResult

class FacetExpressionFilterResult(val name: String, val paramName: String, val results: List<FacetExpressionValue>, val mode: FilterMode) : FilterResult

FacetExpressionsFilter

open class FacetExpressionsFilter( name: String? = null, allValues: List<ExpressionValue> = emptyList(), val mode: FilterMode = FilterMode.UNION) : Filter<FacetExpressionFilterResult>

FacetExpressionValue

data class FacetExpressionValue(val name: String, val selected: Boolean, val docCount: Long)

FacetFilter

class FacetFilter<T, V>( val field: FieldOperations<V>, name: String? = null, val mode: FilterMode = FilterMode.UNION, val termsAgg: TermsAgg<T>) : Filter<FacetFilterResult<T>>

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

FacetFilterResult

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

FacetFilterResult represents result of a FacetFilter.

FacetFilterValue

data class FacetFilterValue<T>(val bucket: TermBucket<T>, val selected: Boolean) : AggAwareResult

FacetFilterValue represents bucket of the corresponding terms aggregation.

FacetRangeFilter

class FacetRangeFilter<T>( val field: FieldOperations<T>, name: String? = null, val aggs: Map<String, Aggregation<*>> = emptyMap()) : Filter<FacetRangeFilterResult<T>>

FacetRangeFilter filters a search query using a dev.evo.elasticmagic.query.Range query. Also calculates number of documents that have value in the FacetRangeFilter.field.

FacetRangeFilterResult

data class FacetRangeFilterResult<T>( val name: String, val paramName: String, val from: T?, val to: T?, val count: Long, val aggs: Map<String, AggregationResult>) : AggAwareResult, FilterResult

FacetRangeFilterResult contains result of a FacetRangeFilter.

Filter

abstract class Filter<R : FilterResult>(val name: String?)

FilterMode

enum FilterMode : Enum<FilterMode>

FilterMode determines a way how values should be filtered.

FilterResult

interface FilterResult

MatchKey

sealed class MatchKey

MutableQueryFilterParams

typealias MutableQueryFilterParams = MutableMap<List<String>, MutableList<String>>

PageFilter

class PageFilter( name: String? = null, val availablePageSizes: List<Int> = DEFAULT_AVAILABLE_PAGE_SIZES, defaultPageSize: Int? = null, val maxHits: Int = DEFAULT_MAX_HITS) : Filter<PageFilterResult>

PageFilter allows to paginate search query results.

PageFilterResult

data class PageFilterResult( val name: String, val paramName: String, val hits: List<SearchHit<*>>, val totalHits: Long, val page: Int, val perPage: Int, val totalPages: Int, val from: Int, val size: Int) : FilterResult, Iterable<SearchHit<*>>

PageFilterResult holds result of a PageFilter.

PreparedAttrBoolExpressionFilter

class PreparedAttrBoolExpressionFilter( val filter: AttrBoolSimpleFilter, name: String, paramName: String, filterExpression: QueryExpression?) : PreparedFilter<BaseFilterResult>

PreparedAttrBoolFacetFilter

class PreparedAttrBoolFacetFilter( val filter: AttrBoolFacetFilter, name: String, paramName: String, facetFilterExpr: QueryExpression?, val selectedValues: Map<Int, AttrBoolFacetFilter.SelectedValues>) : PreparedFilter<AttrBoolFacetFilterResult>

PreparedAttrExpressionFilter

class PreparedAttrExpressionFilter( val filter: AttrSimpleFilter, name: String, paramName: String, filterExpression: QueryExpression?) : PreparedFilter<BaseFilterResult>

PreparedAttrFacetFilter

class PreparedAttrFacetFilter( val filter: AttrFacetFilter, name: String, paramName: String, facetFilterExpr: QueryExpression?, val selectedValues: Map<Int, AttrFacetFilter.SelectedValues>) : PreparedFilter<AttrFacetFilterResult>

PreparedAttrRangeExpressionFilter

class PreparedAttrRangeExpressionFilter( val filter: AttrRangeSimpleFilter, name: String, paramName: String, filterExpression: QueryExpression?) : PreparedFilter<BaseFilterResult>

PreparedAttrRangeFacetFilter

class PreparedAttrRangeFacetFilter( val filter: AttrRangeFacetFilter, name: String, paramName: String, facetFilterExpr: QueryExpression?, val selectedValues: Map<Int, AttrRangeFacetFilter.SelectedValue>) : PreparedFilter<AttrRangeFacetFilterResult>

PreparedFacetExpressionFilter

class PreparedFacetExpressionFilter( name: String, paramName: String, selectedFilterExprs: List<ExpressionValue>, facetFilterExprs: List<ExpressionValue>, val mode: FilterMode) : PreparedFilter<FacetExpressionFilterResult>

PreparedFacetFilter

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

Filter that is ready for applying to a search query.

PreparedFacetRangeFilter

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

Filter that is ready for applying to a search query.

PreparedFilter

abstract class PreparedFilter<T : FilterResult>(val name: String, val paramName: String, val facetFilterExpr: QueryExpression?)

PreparedPageFilter

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

Filter that is ready for applying to a search query.

PreparedSimpleFilter

class PreparedSimpleFilter(name: String, paramName: String, filterExpression: QueryExpression?) : PreparedFilter<BaseFilterResult>

PreparedSortFilter

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

Filter that is ready for applying to a search query.

QueryFilterParams

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

QueryFilters

open class QueryFilters : Iterable<BoundFilter<*>>

QueryFiltersResult

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

SimpleExpressionsFilter

open class SimpleExpressionsFilter( name: String? = null, val values: List<ExpressionValue> = emptyList(), mode: FilterMode = FilterMode.UNION) : Filter<BaseFilterResult>

SimpleFilter

open class SimpleFilter<T>(val field: FieldOperations<T>, name: String? = null, val mode: FilterMode = FilterMode.UNION) : Filter<BaseFilterResult>

SortFilter

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

SortFilter applies a sorting to a search query.

SortFilterResult

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

Result of the SortFilter.

SortFilterValue

class SortFilterValue(val value: String, val sorts: List<Sort>)

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(val value: String, val selected: Boolean)

Represents result of the SortFilterValue.

Functions

decodeAttrAndValue

fun decodeAttrAndValue(attrValue: Long): Pair<Int, Int>

decodeBoolAttrAndValue

fun decodeBoolAttrAndValue(attrValue: Long): Pair<Int, Boolean>

decodeLastValue

fun <T> QueryFilterParams.decodeLastValue(key: String, fieldType: FieldType<*, T>): T?

fun <T> QueryFilterParams.decodeLastValue(key: List<String>, fieldType: FieldType<*, T>): T?

decodeValues

fun <T> QueryFilterParams.decodeValues(key: String, fieldType: FieldType<*, T>): List<T & Any>

fun <T> QueryFilterParams.decodeValues(key: List<String>, fieldType: FieldType<*, T>): List<T & Any>

deserializeTermOrNull

fun <T> FieldType<*, T>.deserializeTermOrNull(term: Any): T?

encodeAttrWithValue

fun encodeAttrWithValue(attrId: Int, valueId: Int): Long

encodeBoolAttrWithValue

fun encodeBoolAttrWithValue(attrId: Int, value: Boolean): Long

encodeRangeAttrWithValue

fun encodeRangeAttrWithValue(attrId: Int, value: Float): Long

facetAgg

inline fun <T : AggregationResult> AggAwareResult.facetAgg(aggName: String): T

getFacetFilterExpr

fun getFacetFilterExpr(expression: List<QueryExpression>, mode: FilterMode): QueryExpression?

MutableQueryFilterParams

fun MutableQueryFilterParams(): MutableQueryFilterParams

unwrapFilterAgg

fun AggAwareResult.unwrapFilterAgg(filterAggName: String): AggAwareResult