query-api/me.ahoo.wow.api.query/AggregationQuery

AggregationQuery

class AggregationQuery @InternalWowApi constructor(val filter: FilterExpression = MatchAllFilter, val elements: List<AggregationElement> = emptyList(), val groupBy: List<AggregationGroup> = emptyList(), val metrics: List<AggregationMetric>, val sort: List<Sort> = emptyList(), val limit: Int = DEFAULT_LIMIT, val having: HavingExpression? = null) : FilterCapable<AggregationQuery> , SortCapable

Constructors

AggregationQuery

@InternalWowApi

constructor(filter: FilterExpression = MatchAllFilter, elements: List<AggregationElement> = emptyList(), groupBy: List<AggregationGroup> = emptyList(), metrics: List<AggregationMetric>, sort: List<Sort> = emptyList(), limit: Int = DEFAULT_LIMIT, having: HavingExpression? = null)

Types

Companion

object Companion

Properties

elements

val elements: List<AggregationElement>

filter

open override val filter: FilterExpression

groupBy

val groupBy: List<AggregationGroup>

having

val having: HavingExpression?

limit

val limit: Int

metrics

val metrics: List<AggregationMetric>

sort

open override val sort: List<Sort>

The list of sort criteria to apply to the query results. Each sort criterion specifies a field and direction (ascending/descending). Sorts are applied in the order they appear in the list, at most Sort.MAX_FIELDS of them.

Functions

copy

@InternalWowApi

fun copy(filter: FilterExpression = this.filter, elements: List<AggregationElement> = this.elements, groupBy: List<AggregationGroup> = this.groupBy, metrics: List<AggregationMetric> = this.metrics, sort: List<Sort> = this.sort, limit: Int = this.limit, having: HavingExpression? = this.having): AggregationQuery

This AggregationQuery with the given values replaced; for Wow's own query rewriting.

effectiveSort

fun effectiveSort(): List<Sort>

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String

withFilter

open override fun withFilter(newFilter: FilterExpression): AggregationQuery