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

Package-level declarations

Types

data class AfterNowFilter(val field: QueryField, val offset: String = ZERO_OFFSET, val zoneId: String? = null, val datePattern: String? = null, val dateFormatter: DateTimeFormatter? = null, val timeUnit: TimeUnit = TimeUnit.MILLISECONDS) : RelativeTimeFilter

The field is after now + offset; see BeforeNowFilter.

AggregateIdFilter

data class AggregateIdFilter(val value: String) : FilterExpression

AggregateIdsFilter

data class AggregateIdsFilter(val values: List<String>) : FilterExpression

AggregationDatePart

enum AggregationDatePart : Enum<AggregationDatePart>

A calendar part of an instant, with its fixed integer domain [min, max].

AggregationDateUnit

enum AggregationDateUnit : Enum<AggregationDateUnit>

AggregationElement

data class AggregationElement(val path: QueryField, val filter: FilterExpression = MatchAllFilter)

AggregationExpression

sealed interface AggregationExpression

One numeric contribution per current root or expanded record, for data conforming to its numeric schema. FIELD selects the sole non-null numeric value; missing, empty and multi-valued fields do not contribute. Repeated numeric values remain separate values. BINARY computes finite doubles; it does not pair arrays or preserve arbitrary native numeric precision.

AggregationExpressionOperator

enum AggregationExpressionOperator : Enum<AggregationExpressionOperator>

AggregationFunction

enum AggregationFunction : Enum<AggregationFunction>

AggregationGroup

sealed interface AggregationGroup

AggregationMetric

sealed interface AggregationMetric

AggregationQuery

data class AggregationQuery(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

AndFilter

data class AndFilter(val operands: List<FilterExpression>) : FilterExpression

BeforeNowFilter

data class BeforeNowFilter(val field: QueryField, val offset: String = ZERO_OFFSET, val zoneId: String? = null, val datePattern: String? = null, val dateFormatter: DateTimeFormatter? = null, val timeUnit: TimeUnit = TimeUnit.MILLISECONDS) : RelativeTimeFilter

A moment relative to the server's clock: the field is before now + offset. The server resolves now once per query, so every condition of one query sees the same moment and the client's clock does not matter.

BeforeTodayFilter

data class BeforeTodayFilter(val field: QueryField, val time: String, val zoneId: String? = null, val datePattern: String? = null, val dateFormatter: DateTimeFormatter? = null, val timeUnit: TimeUnit = TimeUnit.MILLISECONDS) : RelativeTimeFilter

BetweenFilter

data class BetweenFilter(val field: QueryField, val lowerBound: JsonNode, val upperBound: JsonNode) : FieldPredicate

ComparisonOperator

enum ComparisonOperator : Enum<ComparisonOperator>

Condition

data class ~~Condition~~(val field: String = EMPTY_VALUE, val operator: Operator = Operator.ALL, val value: Any = EMPTY_VALUE, val children: List<Condition> = emptyList(), val options: Map<String, Any> = emptyMap()) : ICondition<Condition>

Represents a concrete query condition with support for various comparison operators and logical combinations.

ConditionOptions

interface ~~ConditionOptions~~

Marker interface for condition options. Implementations can define additional configuration options for query conditions.

ContainsAllFilter

data class ContainsAllFilter(val field: QueryField, val values: List<JsonNode>) : FieldPredicate

ContainsFilter

data class ContainsFilter(val field: QueryField, val value: String, val stringComparison: StringComparison = StringComparison.CASE_SENSITIVE) : FieldPredicate

CursorPage

data class CursorPage<out T>(val list: List<T>, val nextCursor: String?)

CursorQuery

data class CursorQuery(val filter: FilterExpression, val projection: Projection = Projection.ALL, val sort: List<Sort> = emptyList(), val size: Int = DEFAULT_SIZE, val cursor: String? = null) : ICursorQuery

DateDiffUnit

enum DateDiffUnit : Enum<DateDiffUnit>

A fixed-length unit of elapsed time. Calendar units (months, years) have no fixed length and depend on a time zone, so they are not offered; a DAY is exactly 24 hours.

DeletionFilter

data class DeletionFilter(val deletionState: DeletionState) : FilterExpression

DeletionState

enum DeletionState : Enum<DeletionState>

Enumeration representing the possible states of deletion for entities in the system.

DerivedExpression

sealed interface DerivedExpression

EarlierDaysFilter

data class EarlierDaysFilter(val field: QueryField, val days: Int, val zoneId: String? = null, val datePattern: String? = null, val dateFormatter: DateTimeFormatter? = null, val timeUnit: TimeUnit = TimeUnit.MILLISECONDS) : RelativeTimeFilter

ElementMatchFilter

data class ElementMatchFilter(val field: QueryField, val predicate: FilterExpression) : FieldPredicate

EndsWithFilter

data class EndsWithFilter(val field: QueryField, val value: String, val stringComparison: StringComparison = StringComparison.CASE_SENSITIVE) : FieldPredicate

EqualFilter

data class EqualFilter(val field: QueryField, val value: JsonNode) : FieldPredicate

ExistsFilter

data class ExistsFilter(val field: QueryField) : FieldPredicate

ExpressionFilter

data class ExpressionFilter(val expression: AggregationExpression, val comparison: ComparisonOperator, val value: Double) : FilterExpression

Compares a computed expression, for example the hours from paidAt to shippedAt, with value. A record whose expression has no value (an operand is absent, or a division by zero) does not match, whatever the comparison. The expression is evaluated per record and cannot use an index, so the operator is expensive.

FieldPredicate

sealed interface FieldPredicate : FilterExpression

A filter on one field the request names: the comparison, string, membership, presence and relative-time predicates, and ELEMENT_MATCH, whose field is the collection its predicate applies to. System-field, logical, search and expression filters name no single field and are not field predicates.

FilterCapable

interface FilterCapable<Q : FilterCapable<Q>> : RewritableFilter<Q>

FilterExpression

sealed interface FilterExpression : RewritableFilter<FilterExpression>

Numeric predicates compare the selected backend's stored or indexed representation, including its precision and quantization. Exact-match capability does not promise arbitrary-precision equality with a source value. Explicit string-comparison contracts remain independent of numeric representation.

FilterOperator

enum FilterOperator : Enum<FilterOperator>

GreaterThanFilter

data class GreaterThanFilter(val field: QueryField, val value: JsonNode) : FieldPredicate

GreaterThanOrEqualFilter

data class GreaterThanOrEqualFilter(val field: QueryField, val value: JsonNode) : FieldPredicate

HavingExpression

sealed interface HavingExpression

ICondition

interface ~~ICondition~~<C : ICondition<C>>

Represents a generic condition interface for building query criteria.

ICursorQuery

interface ICursorQuery : Queryable<ICursorQuery>

IdFilter

data class IdFilter(val value: String) : FilterExpression

IdsFilter

data class IdsFilter(val values: List<String>) : FilterExpression

IListQuery

interface IListQuery : Queryable<IListQuery>

Interface for list queries that retrieve multiple items with a limit.

IMaterializedSnapshot

interface IMaterializedSnapshot<SOURCE : IMaterializedSnapshot<SOURCE, S>, S : Any> : Materialized, StateCapable<S>

Interface for materialized snapshots that contain state data and metadata.

InFilter

data class InFilter(val field: QueryField, val values: List<JsonNode>) : FieldPredicate

IPagedList

interface IPagedList<out T>

Interface representing a paginated list of items with total count information.

IPagedQuery

interface IPagedQuery : Queryable<IPagedQuery>

Interface for paginated queries that retrieve items in pages.

IsEmptyFilter

data class IsEmptyFilter(val field: QueryField) : FieldPredicate

IsEmptyStringFilter

data class IsEmptyStringFilter(val field: QueryField) : FieldPredicate

ISingleQuery

interface ISingleQuery : Queryable<ISingleQuery>

Interface for single-item queries that retrieve at most one result.

IsNotEmptyStringFilter

data class IsNotEmptyStringFilter(val field: QueryField) : FieldPredicate

IsNotNullFilter

data class IsNotNullFilter(val field: QueryField) : FieldPredicate

IsNullFilter

data class IsNullFilter(val field: QueryField) : FieldPredicate

LastMonthFilter

data class LastMonthFilter(val field: QueryField, val zoneId: String? = null, val datePattern: String? = null, val dateFormatter: DateTimeFormatter? = null, val timeUnit: TimeUnit = TimeUnit.MILLISECONDS) : RelativeTimeFilter

LastWeekFilter

data class LastWeekFilter(val field: QueryField, val zoneId: String? = null, val datePattern: String? = null, val dateFormatter: DateTimeFormatter? = null, val timeUnit: TimeUnit = TimeUnit.MILLISECONDS) : RelativeTimeFilter

LastYearFilter

data class LastYearFilter(val field: QueryField, val zoneId: String? = null, val datePattern: String? = null, val dateFormatter: DateTimeFormatter? = null, val timeUnit: TimeUnit = TimeUnit.MILLISECONDS) : RelativeTimeFilter

LessThanFilter

data class LessThanFilter(val field: QueryField, val value: JsonNode) : FieldPredicate

LessThanOrEqualFilter

data class LessThanOrEqualFilter(val field: QueryField, val value: JsonNode) : FieldPredicate

ListQuery

data class ListQuery(val filter: FilterExpression, val projection: Projection = Projection.ALL, val sort: List<Sort> = emptyList(), val limit: Int = 0) : IListQuery

Data class representing a query for retrieving a list of items with optional filtering, projection, sorting, and limiting.

MatchAllFilter

data object MatchAllFilter : FilterExpression

MatchNoneFilter

data object MatchNoneFilter : FilterExpression

MaterializedSnapshot

data class MaterializedSnapshot<S : Any>(val contextName: String, val aggregateName: String, val tenantId: String, val ownerId: String = OwnerId.DEFAULT_OWNER_ID, val spaceId: SpaceId = SpaceIdCapable.DEFAULT_SPACE_ID, val aggregateId: String, val version: Int, val eventId: String, val firstOperator: String, val operator: String, val firstEventTime: Long, val eventTime: Long, val state: S, val snapshotTime: Long, val tags: AbacTags = EMPTY_ABAC_TAGS, val deleted: Boolean) : IMaterializedSnapshot<MaterializedSnapshot<S>, S> , NamedAggregate, TenantId, OwnerId, SpaceIdCapable, Version, EventIdCapable, FirstOperatorCapable, OperatorCapable, FirstEventTimeCapable, EventTimeCapable, SnapshotTimeCapable, AbacTaggable, DeletedCapable

Data class representing a complete materialized snapshot of an aggregate's state.

MediumMaterializedSnapshot

data class MediumMaterializedSnapshot<S : Any>(val tenantId: String, val ownerId: String = OwnerId.DEFAULT_OWNER_ID, val spaceId: SpaceId = SpaceIdCapable.DEFAULT_SPACE_ID, val version: Int, val eventId: String, val firstOperator: String, val operator: String, val firstEventTime: Long, val eventTime: Long, val state: S, val tags: AbacTags = EMPTY_ABAC_TAGS) : IMaterializedSnapshot<MediumMaterializedSnapshot<S>, S> , TenantId, OwnerId, SpaceIdCapable, Version, EventIdCapable, FirstOperatorCapable, OperatorCapable, FirstEventTimeCapable, EventTimeCapable, AbacTaggable

Represents a materialized snapshot for medium data, implementing multiple capabilities through inheritance. This class is designed to be generic, capable of holding state data of any type. Each snapshot corresponds to a specific version of the state within a tenant and owner context, and records information such as event IDs and operation times to support tracing and auditing.

NextMonthFilter

data class NextMonthFilter(val field: QueryField, val zoneId: String? = null, val datePattern: String? = null, val dateFormatter: DateTimeFormatter? = null, val timeUnit: TimeUnit = TimeUnit.MILLISECONDS) : RelativeTimeFilter

NextWeekFilter

data class NextWeekFilter(val field: QueryField, val zoneId: String? = null, val datePattern: String? = null, val dateFormatter: DateTimeFormatter? = null, val timeUnit: TimeUnit = TimeUnit.MILLISECONDS) : RelativeTimeFilter

NextYearFilter

data class NextYearFilter(val field: QueryField, val zoneId: String? = null, val datePattern: String? = null, val dateFormatter: DateTimeFormatter? = null, val timeUnit: TimeUnit = TimeUnit.MILLISECONDS) : RelativeTimeFilter

NorFilter

data class NorFilter(val operands: List<FilterExpression>) : FilterExpression

NotEqualFilter

data class NotEqualFilter(val field: QueryField, val value: JsonNode) : FieldPredicate

NotExistsFilter

data class NotExistsFilter(val field: QueryField) : FieldPredicate

NotInFilter

data class NotInFilter(val field: QueryField, val values: List<JsonNode>) : FieldPredicate

Operator

enum ~~Operator~~ : Enum<Operator>

Enumeration of query operators used for building database query conditions.

OrFilter

data class OrFilter(val operands: List<FilterExpression>) : FilterExpression

OwnerIdFilter

data class OwnerIdFilter(val value: String) : FilterExpression

PagedList

data class PagedList<out T>(val total: Long, val list: List<T>) : IPagedList<T>

Data class implementing a paginated list of items.

PagedQuery

data class PagedQuery(val filter: FilterExpression, val projection: Projection = Projection.ALL, val sort: List<Sort> = emptyList(), val pagination: Pagination = Pagination.DEFAULT) : IPagedQuery

Data class representing a paginated query with filtering, projection, sorting, and pagination.

Pagination

data class Pagination(val index: Int = 1, val size: Int = 10)

Data class representing pagination settings for queries.

Projection

data class Projection(val include: List<QueryField> = emptyList(), val exclude: List<QueryField> = emptyList())

Data class representing field projection settings for queries.

ProjectionCapable

interface ProjectionCapable<Q : RewritableProjection<Q>> : RewritableProjection<Q>

Interface for query objects that support field projection.

Queryable

interface Queryable<Q : Queryable<Q>> : FilterCapable<Q> , ProjectionCapable<Q> , SortCapable

Interface for query objects that support comprehensive querying capabilities.

QueryErrorCodes

object QueryErrorCodes

Stable, machine-readable codes of rejected query requests, carried as BindingError.code. A contract: codes are added, never renamed or reused. Clients switch on them instead of on the human text.

QueryField

data class QueryField(val path: String)

RecentDaysFilter

data class RecentDaysFilter(val field: QueryField, val days: Int, val zoneId: String? = null, val datePattern: String? = null, val dateFormatter: DateTimeFormatter? = null, val timeUnit: TimeUnit = TimeUnit.MILLISECONDS) : RelativeTimeFilter

RelativeTimeFilter

sealed interface RelativeTimeFilter : FieldPredicate

RewritableFilter

interface RewritableFilter<Q : RewritableFilter<Q>>

RewritableProjection

interface RewritableProjection<Q : RewritableProjection<Q>>

Interface for query objects that support projection rewriting and modification.

SearchFilter

data class SearchFilter(val query: String, val fields: Set<QueryField> = emptySet(), val mode: SearchMode = SearchMode.TERMS) : FilterExpression

SearchMode

enum SearchMode : Enum<SearchMode>

SingleQuery

data class SingleQuery(val filter: FilterExpression, val projection: Projection = Projection.ALL, val sort: List<Sort> = emptyList()) : ISingleQuery

Data class representing a query for retrieving a single item with optional filtering, projection, and sorting.

SmallMaterializedSnapshot

data class SmallMaterializedSnapshot<S : Any>(val version: Int, val firstEventTime: Long, val state: S) : Version, FirstEventTimeCapable, IMaterializedSnapshot<SmallMaterializedSnapshot<S>, S>

Represents a simplified materialized snapshot with generic state. This data class implements multiple interfaces to provide version, materialization, first event time, and state information.

Sort

data class Sort(val field: QueryField, val direction: Sort.Direction)

Data class representing a sorting criterion for query results.

SortCapable

interface SortCapable

Interface for query objects that support sorting capabilities.

SpaceIdFilter

data class SpaceIdFilter(val value: String) : FilterExpression

StartsWithFilter

data class StartsWithFilter(val field: QueryField, val value: String, val stringComparison: StringComparison = StringComparison.CASE_SENSITIVE) : FieldPredicate

StringComparison

enum StringComparison : Enum<StringComparison>

TenantIdFilter

data class TenantIdFilter(val value: String) : FilterExpression

ThisMonthFilter

data class ThisMonthFilter(val field: QueryField, val zoneId: String? = null, val datePattern: String? = null, val dateFormatter: DateTimeFormatter? = null, val timeUnit: TimeUnit = TimeUnit.MILLISECONDS) : RelativeTimeFilter

ThisWeekFilter

data class ThisWeekFilter(val field: QueryField, val zoneId: String? = null, val datePattern: String? = null, val dateFormatter: DateTimeFormatter? = null, val timeUnit: TimeUnit = TimeUnit.MILLISECONDS) : RelativeTimeFilter

ThisYearFilter

data class ThisYearFilter(val field: QueryField, val zoneId: String? = null, val datePattern: String? = null, val dateFormatter: DateTimeFormatter? = null, val timeUnit: TimeUnit = TimeUnit.MILLISECONDS) : RelativeTimeFilter

TodayFilter

data class TodayFilter(val field: QueryField, val zoneId: String? = null, val datePattern: String? = null, val dateFormatter: DateTimeFormatter? = null, val timeUnit: TimeUnit = TimeUnit.MILLISECONDS) : RelativeTimeFilter

TomorrowFilter

data class TomorrowFilter(val field: QueryField, val zoneId: String? = null, val datePattern: String? = null, val dateFormatter: DateTimeFormatter? = null, val timeUnit: TimeUnit = TimeUnit.MILLISECONDS) : RelativeTimeFilter

YesterdayFilter

data class YesterdayFilter(val field: QueryField, val zoneId: String? = null, val datePattern: String? = null, val dateFormatter: DateTimeFormatter? = null, val timeUnit: TimeUnit = TimeUnit.MILLISECONDS) : RelativeTimeFilter

Properties

fields

val AggregationExpression.fields: List<QueryField>

The fields an expression reads, in tree order.

inputExpression

val AggregationGroup.inputExpression: AggregationExpression?

The computed input of a TERMS or HISTOGRAM group in place of its field, or null.

Functions

childFilters

fun FilterExpression.childFilters(): List<FilterExpression>

The direct child filters of this node: the operands of AND / OR / NOR and the predicate of ELEMENT_MATCH. Every other node is a leaf and returns an empty list. The one walker of a filter tree: consumers that visit the tree read the children from here instead of matching the logical nodes themselves.

isEmpty

fun Projection.isEmpty(): Boolean

Checks if this projection has no field filtering (includes all fields).

toFilterExpression

fun Condition.~~toFilterExpression~~(): FilterExpression

toMedium

fun <S : Any, D : Any> MaterializedSnapshot<S>.toMedium(materialize: (S) -> D): MediumMaterializedSnapshot<D>

toSmall

fun <S : Any, D : Any> MaterializedSnapshot<S>.toSmall(materialize: (S) -> D): SmallMaterializedSnapshot<D>

Converts a materialized snapshot into a simplified snapshot form. This function is used to transform a full snapshot into a simplified snapshot with transformed state.