wow-api/me.ahoo.wow.api.query.spec/GroupSpec

GroupSpec

The single specification of each aggregation group type (design §6.1): its wire name (the enum name, equal to the JSON type), the capability its field must grant and what it costs. Admission, field resolution, the entry gate and the descriptor read it, so a new group type is added here and every exhaustive when over AggregationGroup fails to compile until handled.

Entries

A calendar part (weekday, hour, …) of the field's instant; needs the same temporal capability as histograms. The part is computed per record, so no storage can serve it from an index.

Types

Companion

object Companion

Properties

baseCost

val baseCost: OperatorCost

The cost of the group type in general; cost refines it for one group.

capability

val capability: QueryCapability

entries

val entries: EnumEntries<GroupSpec>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

Functions

cost

fun cost(group: AggregationGroup): OperatorCost

The cost of group: an expression input is computed per record and a dense fill materializes every bucket of the range, so either makes a group expensive; otherwise baseCost.

valueOf

fun valueOf(value: String): GroupSpec

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<GroupSpec>

Returns an array containing the constants of this enum type, in the order they're declared.