wow-core/me.ahoo.wow.modeling.matedata/AggregateMetadata

AggregateMetadata

data class AggregateMetadata<C : Any, S : Any>(val namedAggregate: NamedAggregate, val staticTenantId: String?, val state: StateAggregateMetadata<S>, val command: CommandAggregateMetadata<C>) : NamedAggregateDecorator, Metadata

Represents the metadata for an aggregate, combining state and command aggregate metadata.

This data class encapsulates all the metadata required to work with an aggregate, including its named aggregate information, static tenant ID, state aggregate metadata, and command aggregate metadata. It provides utilities for extracting aggregate IDs and determining if the aggregate follows an aggregation pattern.

Parameters

The type of the command aggregate.

The type of the state aggregate.

Constructors

AggregateMetadata

constructor(namedAggregate: NamedAggregate, staticTenantId: String?, state: StateAggregateMetadata<S>, command: CommandAggregateMetadata<C>)

Creates a new AggregateMetadata with the specified named aggregate, tenant ID, and metadata.

Properties

aggregateName

open override val aggregateName: String

command

val command: CommandAggregateMetadata<C>

The metadata for the command aggregate.

contextName

open override val contextName: String

isAggregationPattern

val isAggregationPattern: Boolean

Determines if this aggregate follows an aggregation pattern where state and command aggregates are different types.

namedAggregate

open override val namedAggregate: NamedAggregate

The named aggregate that this metadata belongs to.

state

val state: StateAggregateMetadata<S>

The metadata for the state aggregate.

staticTenantId

val staticTenantId: String?

The static tenant ID configured for this aggregate, or null if not configured.

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.

fun AggregateMetadata<*, *>.aggregateId(id: String = generateId(), tenantId: String = staticTenantId ?: TenantId.DEFAULT_TENANT_ID): DefaultAggregateId

Creates an AggregateId for this AggregateMetadata 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.

equals

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

extractAggregateId

fun extractAggregateId(state: S, aggregateId: String, tenantId: String = TenantId.DEFAULT_TENANT_ID): AggregateId

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.

hashCode

open override fun hashCode(): Int

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

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.

toEventNamedAggregate

fun NamedAggregate.toEventNamedAggregate(eventName: String): EventNamedAggregate

Extension function to convert a NamedAggregate to an EventNamedAggregate.

toNamedAggregateString

fun NamedAggregate.toNamedAggregateString(): String

Converts this NamedAggregate to its string representation.

toStateAggregate

@JvmStatic

fun <S : Any> AggregateMetadata<*, S>.toStateAggregate(state: S, version: Int, ownerId: String = OwnerId.DEFAULT_OWNER_ID, eventId: String = "", firstOperator: String = "", operator: String = "", firstEventTime: Long = 0, eventTime: Long = 0, deleted: Boolean = false, aggregateId: String = "", tenantId: String = TenantId.DEFAULT_TENANT_ID): StateAggregate<S>

toString

open override fun toString(): String

toStringWithAlias

fun NamedAggregate.toStringWithAlias(): String

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