Interface IReadModelPropertiesBuilder<TReadModel, TEvent, TBuilder>

Namespace: Cratis.Chronicle.Projections

Assembly: Cratis.Chronicle.dll

Defines the builder for building properties on a read model.

public interface IReadModelPropertiesBuilder<TReadModel, TEvent, TBuilder> where TBuilder : class, IReadModelPropertiesBuilder<TReadModel, TEvent, TBuilder>

Type Parameters

TReadModel: Read model to build for.
TEvent: Event to build for.
TBuilder: Type of actual builder.

Extension Methods: MethodCalls.CallGenericMethod<TOut, T>(T, Expression<Func<T, Func<TOut>>>, params Type[])

MethodCalls.CallGenericMethod<TOut, T, T1>(T, Expression<Func<T, Func<T1, TOut>>>, T1, params Type[])

MethodCalls.CallGenericMethod<TOut, T, T1, T2>(T, Expression<Func<T, Func<T1, T2, TOut>>>, T1, T2, params Type[])

MethodCalls.CallGenericMethod<TOut, T, T1, T2, T3>(T, Expression<Func<T, Func<T1, T2, T3, TOut>>>, T1, T2, T3, params Type[])

ConverterExtensions.ConvertTo(object, Type)

ConceptExtensions.GetConceptValue(object)

ConceptExtensions.IsConcept(object)

JsonValueExtensions.ToJsonValue(object?)

ObservableExtensions.InvokeAndWrapWithSubject<TResult>(object, Func<CancellationToken, IObservable<TResult>>)

ObservableExtensions.InvokeAndWrapWithTransformSubject<TResult, TSource>(object, Func<CancellationToken, IObservable<TSource>>, Func<TSource, TResult>)

Methods

AddChild<TChildModel>(Expression<Func<TReadModel, IEnumerable<TChildModel>>>, Action<IAddChildBuilder<TChildModel, TEvent>>)

Start building the add child operation to a target property holding an collection of a specific child model type.

TBuilder AddChild<TChildModel>(Expression<Func<TReadModel, IEnumerable<TChildModel>>> targetProperty, Action<IAddChildBuilder<TChildModel, TEvent>> builderCallback)

Parameters

targetProperty Expression<Func<TReadModel, IEnumerable<TChildModel>>>: The collection property that will receive the child.
builderCallback Action<IAddChildBuilder<TChildModel, TEvent>>: Builder callback for building the composite key.

Returns

TBuilder: Builder continuation.

Type Parameters

TChildModel: Type of child model.

AddChild<TChildModel>(Expression<Func<TReadModel, IEnumerable<TChildModel>>>, Expression<Func<TEvent, TChildModel>>)

Start building a child operation that add a child based on a property on the event.

TBuilder AddChild<TChildModel>(Expression<Func<TReadModel, IEnumerable<TChildModel>>> targetProperty, Expression<Func<TEvent, TChildModel>> eventProperty)

Parameters

targetProperty Expression<Func<TReadModel, IEnumerable<TChildModel>>>: The collection property that will receive the child.
eventProperty Expression<Func<TEvent, TChildModel>>: Event property accessor for defining the source property.

Returns

TBuilder: Builder continuation.

Type Parameters

TChildModel: Type of child model.

Add<TProperty>(Expression<Func<TReadModel, TProperty>>)

Start building the add operation to a target property on the model.

IAddBuilder<TReadModel, TEvent, TProperty, TBuilder> Add<TProperty>(Expression<Func<TReadModel, TProperty>> readModelPropertyAccessor)

Parameters

readModelPropertyAccessor Expression<Func<TReadModel, TProperty>>: Model property accessor for defining the target property.

Returns

IAddBuilder<TReadModel, TEvent, TProperty, TBuilder>: Builder continuation.

Type Parameters

TProperty: Type of the property.

Clear<TProperty>(Expression<Func<TReadModel, TProperty>>)

Clear a property on the model, returning it to no value.

TBuilder Clear<TProperty>(Expression<Func<TReadModel, TProperty>> readModelPropertyAccessor)

Parameters

readModelPropertyAccessor Expression<Func<TReadModel, TProperty>>: Model property accessor for defining the target property.

Returns

TBuilder: Builder continuation.

Type Parameters

TProperty: Type of the property.

Remarks

Clearing is its own operation rather than a set of a special value: the member is written back to null every time the event is observed, replay included. The property has to be able to hold null - clearing one that cannot is refused here, because the only value that could be written is the type default, which is a different fact than "no value". Use Set(...).ToValue(...) when a type default is what you mean. The default implementation throws, so adding this member does not break an implementation outside this assembly: it keeps compiling, and only fails if it is actually asked to clear something.

Exceptions

CannotClearNonNullableMember: Thrown when the target property cannot hold null.
ClearNotSupported: Thrown when an alternate builder implementation does not support clearing a member.

Count<TProperty>(Expression<Func<TReadModel, TProperty>>)

Start building the count operation to a target property on the model.

TBuilder Count<TProperty>(Expression<Func<TReadModel, TProperty>> readModelPropertyAccessor)

Parameters

readModelPropertyAccessor Expression<Func<TReadModel, TProperty>>: Model property accessor for defining the target property.

Returns

TBuilder: Builder continuation.

Type Parameters

TProperty: Type of the property.

Decrement<TProperty>(Expression<Func<TReadModel, TProperty>>)

Increment the value of a property on the model.

TBuilder Decrement<TProperty>(Expression<Func<TReadModel, TProperty>> readModelPropertyAccessor)

Parameters

readModelPropertyAccessor Expression<Func<TReadModel, TProperty>>: Model property accessor for defining the target property.

Returns

TBuilder: Builder continuation.

Type Parameters

TProperty: Type of the property.

Increment<TProperty>(Expression<Func<TReadModel, TProperty>>)

Increment the value of a property on the model.

TBuilder Increment<TProperty>(Expression<Func<TReadModel, TProperty>> readModelPropertyAccessor)

Parameters

readModelPropertyAccessor Expression<Func<TReadModel, TProperty>>: Model property accessor for defining the target property.

Returns

TBuilder: Builder continuation.

Type Parameters

TProperty: Type of the property.

Set(PropertyPath)

Start building the set operation to a target property on the model.

ISetBuilder<TReadModel, TEvent, TBuilder> Set(PropertyPath propertyPath)

Parameters

propertyPath PropertyPath: Model property path for defining the target property.

Returns

ISetBuilder<TReadModel, TEvent, TBuilder>: The ISetBuilder<TReadModel, TEvent, TParentBuilder> to continue building on.

SetThisValue()

Start building the set operation to target the value instance itself.

ISetBuilder<TReadModel, TEvent, TBuilder> SetThisValue()

Returns

ISetBuilder<TReadModel, TEvent, TBuilder>: The ISetBuilder<TReadModel, TEvent, TParentBuilder> to continue building on.

Set<TProperty>(Expression<Func<TReadModel, TProperty>>)

Start building the set operation to a target property on the model.

ISetBuilder<TReadModel, TEvent, TProperty, TBuilder> Set<TProperty>(Expression<Func<TReadModel, TProperty>> readModelPropertyAccessor)

Parameters

readModelPropertyAccessor Expression<Func<TReadModel, TProperty>>: Model property accessor for defining the target property.

Returns

ISetBuilder<TReadModel, TEvent, TProperty, TBuilder>: The ISetBuilder<TReadModel, TEvent, TProperty, TParentBuilder> to continue building on.

Type Parameters

TProperty: Type of the property.

Subtract<TProperty>(Expression<Func<TReadModel, TProperty>>)

Start building the add operation to a target property on the model.

ISubtractBuilder<TReadModel, TEvent, TProperty, TBuilder> Subtract<TProperty>(Expression<Func<TReadModel, TProperty>> readModelPropertyAccessor)

Parameters

readModelPropertyAccessor Expression<Func<TReadModel, TProperty>>: Model property accessor for defining the target property.

Returns

ISubtractBuilder<TReadModel, TEvent, TProperty, TBuilder>: Builder continuation.

Type Parameters

TProperty: Type of the property.

UsingCompositeKey<TKeyType>(Action<ICompositeKeyBuilder<TKeyType, TEvent>>)

Define what key to use based on a composite of expressions.

TBuilder UsingCompositeKey<TKeyType>(Action<ICompositeKeyBuilder<TKeyType, TEvent>> builderCallback)

Parameters

builderCallback Action<ICompositeKeyBuilder<TKeyType, TEvent>>: Builder callback for building the composite key.

Returns

TBuilder: Builder continuation.

Type Parameters

TKeyType: Type of key.

UsingConstantKey(string)

Define a constant value to use as the key. All events of this type will update the same read model instance.

TBuilder UsingConstantKey(string value)

Parameters

value string: The constant value to use as key.

Returns

TBuilder: Builder continuation.

UsingConstantParentKey(string)

Define a constant value to use as the parent key. All events of this type will update the same parent read model instance.

TBuilder UsingConstantParentKey(string value)

Parameters

value string: The constant value to use as parent key.

Returns

TBuilder: Builder continuation.

UsingKeyFromContext<TProperty>(Expression<Func<EventContext, TProperty>>)

Define what key to use based on a value in the EventContext.

TBuilder UsingKeyFromContext<TProperty>(Expression<Func<EventContext, TProperty>> keyAccessor)

Parameters

keyAccessor Expression<Func<EventContext, TProperty>>: Accessor for the property within EventContext to use.

Returns

TBuilder: Builder continuation.

Type Parameters

TProperty: Type of the property.

UsingKey<TProperty>(Expression<Func<TEvent, TProperty>>)

Define what key to use. This is optional, if not set - it will default to using the event source identifier on the event.

TBuilder UsingKey<TProperty>(Expression<Func<TEvent, TProperty>> keyAccessor)

Parameters

keyAccessor Expression<Func<TEvent, TProperty>>: Accessor for the property to use.

Returns

TBuilder: Builder continuation.

Type Parameters

TProperty: Type of the property.

UsingParentCompositeKey<TKeyType>(Action<ICompositeKeyBuilder<TKeyType, TEvent>>)

Define what composite key based on properties on the event represents the parent key. This is typically used in child relationships to identify the parent read model to work with.

TBuilder UsingParentCompositeKey<TKeyType>(Action<ICompositeKeyBuilder<TKeyType, TEvent>> builderCallback)

Parameters

builderCallback Action<ICompositeKeyBuilder<TKeyType, TEvent>>: Builder callback for building the composite key.

Returns

TBuilder: Builder continuation.

Type Parameters

TKeyType: Type of key.

UsingParentKeyFromContext<TProperty>(Expression<Func<EventContext, TProperty>>)

Define what property on the event represents the parent key based on a property in the EventContext. This is typically used in child relationships to identify the parent read model to work with.

TBuilder UsingParentKeyFromContext<TProperty>(Expression<Func<EventContext, TProperty>> keyAccessor)

Parameters

keyAccessor Expression<Func<EventContext, TProperty>>: Accessor for the property to use.

Returns

TBuilder: Builder continuation.

Type Parameters

TProperty: Type of the property.

UsingParentKey<TProperty>(Expression<Func<TEvent, TProperty>>)

Define what property on the event represents the parent key. This is typically used in child relationships to identify the parent read model to work with.

TBuilder UsingParentKey<TProperty>(Expression<Func<TEvent, TProperty>> keyAccessor)

Parameters

keyAccessor Expression<Func<TEvent, TProperty>>: Accessor for the property to use.

Returns

TBuilder: Builder continuation.

Type Parameters

TProperty: Type of the property.