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.

Parameters

field
  • field to filter a search query with

name
  • optional filter name. If omitted, name of a property will be used

aggs
  • mapping with aggregations. Can be used to calculate aggregation for a FacetRangeFilter.field. For example, minimum and maximum values or a histogram can be calculated.

Constructors

Link copied to clipboard
fun <T> FacetRangeFilter(field: FieldOperations<T>, name: String? = null, aggs: Map<String, Aggregation<*>> = emptyMap())

Functions

Link copied to clipboard

open override fun prepare(name: String, paramName: String, params: QueryFilterParams): PreparedFacetRangeFilter<T>

Parses params and prepares the FacetRangeFilter for applying.

Link copied to clipboard

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val name: String?