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

Package-level declarations

Types

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> , RewritableCondition<Condition>

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

ConditionCapable

interface ConditionCapable<Q : ConditionCapable<Q>> : RewritableCondition<Q>

Interface for query objects that can have conditions applied to them.

ConditionOptions

interface ConditionOptions

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

DeletionState

enum DeletionState : Enum<DeletionState>

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

DynamicDocument

interface DynamicDocument : MutableMap<String, Any>

Interface representing a dynamic document that can store arbitrary key-value pairs.

ICondition

interface ICondition<C : ICondition<C>>

Represents a generic condition interface for building query criteria.

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.

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.

ISingleQuery

interface ISingleQuery : Queryable<ISingleQuery>

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

ListQuery

data class ListQuery(val condition: Condition, val projection: Projection = Projection.ALL, val sort: List<Sort> = emptyList(), val limit: Int = Pagination.DEFAULT.size) : IListQuery

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

MaterializedSnapshot

data class MaterializedSnapshot<S : Any>(val contextName: String, val aggregateName: String, val tenantId: String, val ownerId: String = OwnerId.DEFAULT_OWNER_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 deleted: Boolean) : IMaterializedSnapshot<MaterializedSnapshot<S>, S> , NamedAggregate, TenantId, OwnerId, Version, EventIdCapable, FirstOperatorCapable, OperatorCapable, FirstEventTimeCapable, EventTimeCapable, SnapshotTimeCapable, 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, val version: Int, val eventId: String, val firstOperator: String, val operator: String, val firstEventTime: Long, val eventTime: Long, val state: S) : IMaterializedSnapshot<MediumMaterializedSnapshot<S>, S> , TenantId, OwnerId, Version, EventIdCapable, FirstOperatorCapable, OperatorCapable, FirstEventTimeCapable, EventTimeCapable

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.

Operator

enum Operator : Enum<Operator>

Enumeration of query operators used for building database query conditions.

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 condition: Condition, 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, val size: Int)

Data class representing pagination settings for queries.

Projection

data class Projection(val include: List<String> = emptyList(), val exclude: List<String> = 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>> : ConditionCapable<Q> , ProjectionCapable<Q> , SortCapable

Interface for query objects that support comprehensive querying capabilities.

RewritableCondition

interface RewritableCondition<Q : RewritableCondition<Q>>

Interface for query objects that support condition rewriting and modification.

RewritableProjection

interface RewritableProjection<Q : RewritableProjection<Q>>

Interface for query objects that support projection rewriting and modification.

SimpleDynamicDocument

class SimpleDynamicDocument(val delegation: MutableMap<String, Any>) : DynamicDocument, MutableMap<String, Any>

A simple implementation of DynamicDocument that delegates to a MutableMap.

SingleQuery

data class SingleQuery(val condition: Condition, 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: String, val direction: Sort.Direction)

Data class representing a sorting criterion for query results.

SortCapable

interface SortCapable

Interface for query objects that support sorting capabilities.

Functions

isEmpty

fun Projection.isEmpty(): Boolean

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

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.