wow-core/me.ahoo.wow.eventsourcing.state/StateEvent

StateEvent

interface StateEvent<S : Any> : DomainEventStream, ReadOnlyStateAggregate<S>

Represents a state event that combines domain event stream data with aggregate state. State events are used in event sourcing to capture both the event and the resulting state.

Parameters

the type of the state

Inheritors

StateEventData

Types

Companion

object Companion

Properties

aggregateId

abstract override val aggregateId: AggregateId

The aggregate ID this event stream belongs to

aggregateName

abstract val aggregateName: String

body

abstract val body: List<DomainEvent<*>>

commandId

abstract val commandId: String

contextName

abstract val contextName: String

createTime

abstract override val createTime: Long

deleted

abstract val deleted: Boolean

eventId

open override val eventId: String

The event ID, delegated to the id property.

eventTime

open override val eventTime: Long

The time when the event occurred, delegated to createTime.

expectedNextVersion

open val expectedNextVersion: Int

firstEventTime

abstract val firstEventTime: Long

firstOperator

abstract val firstOperator: String

header

abstract val header: Header

abstract val id: String

initialized

open val initialized: Boolean

isInitialVersion

open val isInitialVersion: Boolean

isReadOnly

open val isReadOnly: Boolean

operator

open override val operator: String

The operator who triggered the event, from the header.

ownerId

abstract val ownerId: String

requestId

abstract val requestId: String

size

abstract val size: Int

The number of events in this stream

state

abstract val state: S

version

abstract val version: Int

用于生成领域事件版本号.

Functions

aggregateId

fun NamedAggregate.aggregateId(id: String = generateId(), tenantId: String = TenantId.DEFAULT_TENANT_ID): DefaultAggregateId

Creates an AggregateId for this NamedAggregate with the specified parameters.

aggregateType

fun <T> NamedAggregate.aggregateType(): Class<T>?

Finds the aggregate type class associated with this named aggregate.

asAggregateMetadata

fun <C : Any, S : Any> NamedAggregate.asAggregateMetadata(): AggregateMetadata<C, S>

Converts this NamedAggregate to its corresponding AggregateMetadata.

copy

abstract override fun copy(): StateEvent<S>

Creates a copy of this state event.

generateId

fun NamedAggregate.generateId(): String

Generates a unique ID string for this NamedAggregate.

getContextAlias

fun NamedBoundedContext.getContextAlias(boundedContext: BoundedContext? = MetadataSearcher.metadata.contexts[contextName]): String

getContextAliasPrefix

fun NamedBoundedContext.getContextAliasPrefix(): String

Gets the context alias prefix for this bounded context.

ignoreSourcing

fun DomainEventStream.ignoreSourcing(): Boolean

Determines if this event stream should be ignored during event sourcing.

isLocal

fun NamedAggregate.isLocal(): Boolean

Checks if the named aggregate is available locally at runtime.

isSameAggregateName

open fun isSameAggregateName(other: NamedAggregate): Boolean

isSameBoundedContext

open fun isSameBoundedContext(other: NamedBoundedContext): Boolean

iterator

abstract operator fun iterator(): Iterator<DomainEvent<*>>

match

fun Message<*, *>.match(function: FunctionInfo): Boolean

Checks if this message matches the given function for compensation purposes.

materialize

fun NamedAggregate.materialize(): MaterializedNamedAggregate

Materializes this NamedAggregate into a MaterializedNamedAggregate.

requiredAggregateType

fun <T> NamedAggregate.requiredAggregateType(): Class<T>

Finds the aggregate type class associated with this named aggregate, throwing an exception if not found.

sortedByOrder

fun <T : Any> Iterable<T>.sortedByOrder(): List<T>

Sorts an iterable collection based on Order annotations and dependencies.

toEventNamedAggregate

fun NamedAggregate.toEventNamedAggregate(eventName: String): EventNamedAggregate

Extension function to convert a NamedAggregate to an EventNamedAggregate.

toGroupKey

fun AggregateIdCapable.toGroupKey(parallelism: Int = DEFAULT_PARALLELISM): Int

Computes a grouping key for parallel processing based on the aggregate ID.

toMedium

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

toNamedAggregateString

fun NamedAggregate.toNamedAggregateString(): String

Converts this NamedAggregate to its string representation.

toSmall

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

toStateAggregate

@JvmStatic

fun <S : Any> ReadOnlyStateAggregate<S>.toStateAggregate(): StateAggregate<S>

toStateEvent

fun <S : Any> DomainEventStream.toStateEvent(stateAggregate: ReadOnlyStateAggregate<S>): StateEvent<S>

Converts a DomainEventStream to a StateEvent using the state from a ReadOnlyStateAggregate.

fun <S : Any> DomainEventStream.toStateEvent(state: S, firstOperator: String = header.operator.orEmpty(), firstEventTime: Long = createTime, deleted: Boolean = false): StateEvent<S>

Converts a DomainEventStream to a StateEvent with the given state.

toStringWithAlias

fun NamedAggregate.toStringWithAlias(): String

Converts this NamedAggregate to a string representation using the context alias.

withHeader

open fun withHeader(additionalSource: Map<String, String>): DomainEventStream

open fun withHeader(key: String, value: String): DomainEventStream

withReadOnly

open fun withReadOnly(): DomainEventStream