# Aggregation {{< rawhtml >}}

Class Aggregation<TInput, TOutput>

Aggregates data by the given aggregation methods. The aggregate is a partial-blocking transformation - only the aggregation values are stored in separate memory objects. When all rows have been processed by the aggregation, the aggregated values are written into the output.

Inheritance
object
LoggableTask
DataFlowComponent
DataFlowSource<TOutput>
DataFlowTransformation<TInput, TOutput>
Aggregation<TInput, TOutput>
Aggregation
Aggregation
Implements
IDataFlowTransformation<TInput, TOutput>
IDataFlowSource<TOutput>
IDataFlowSource
IDataFlowDestination<TInput>
IDataFlowDestination
IDataFlowComponent
ILoggableTask
Inherited Members
DataFlowTransformation<TInput, TOutput>.TargetBlock
DataFlowTransformation<TInput, TOutput>.CompleteBuffer()
DataFlowTransformation<TInput, TOutput>.FaultBuffer(Exception)
DataFlowSource<TOutput>.LinkTo(IDataFlowDestination<TOutput>)
DataFlowSource<TOutput>.LinkTo(IDataFlowDestination<TOutput>, Predicate<TOutput>)
DataFlowSource<TOutput>.LinkTo(IDataFlowDestination<TOutput>, Predicate<TOutput>, Predicate<TOutput>)
DataFlowSource<TOutput>.LinkTo<TConvert>(IDataFlowDestination<TOutput>)
DataFlowSource<TOutput>.LinkTo<TConvert>(IDataFlowDestination<TOutput>, Predicate<TOutput>)
DataFlowSource<TOutput>.LinkTo<TConvert>(IDataFlowDestination<TOutput>, Predicate<TOutput>, Predicate<TOutput>)
DataFlowComponent.MaxBufferSize
DataFlowComponent.Predecessors
DataFlowComponent.Successors
DataFlowComponent.Completion
DataFlowComponent.BufferCancellationSource
DataFlowComponent.BufferCancellationToken
DataFlowComponent.WasComponentInitialized
DataFlowComponent.IsReadyForProcessing
DataFlowComponent.SetParentComponent(DataFlowComponent)
DataFlowComponent.LinkErrorTo(IDataFlowDestination<ETLBoxError>)
DataFlowComponent.InternalLinkTo<T>(IDataFlowDestination, object, object)
DataFlowComponent.AddComplementVoidLinkToOtherTargets(Func<Type, IDataFlowDestination>, Delegate)
DataFlowComponent.ResetComponent()
DataFlowComponent.InitBufferObjects(CancellationToken?)
DataFlowComponent.InitCheckedParameter()
DataFlowComponent.OnInitialization
DataFlowComponent.OnCompletion
DataFlowComponent.OnException
DataFlowComponent.CompleteOrFaultBufferOnPredecessorCompletion(Task)
DataFlowComponent.Exception
DataFlowComponent.ErrorSource
DataFlowComponent.CancelBufferAndThrowOperationCanceledException()
DataFlowComponent.InternalLinkErrorTo(IDataFlowDestination<ETLBoxError>)
DataFlowComponent.ThrowOrRedirectError(Exception, string, string)
DataFlowComponent.ThrowErrorAndFaultNetwork(Exception, string)
DataFlowComponent.CancelComponent()
DataFlowComponent.ErrorCount
DataFlowComponent.ProgressCount
DataFlowComponent.OnProgress
DataFlowComponent.ExecutionStartTime
DataFlowComponent.ExecutionEndTime
DataFlowComponent.Tag
DataFlowComponent.LoggingStartOnce()
DataFlowComponent.LoggingFinishOnce()
DataFlowComponent.LogProgressBatch_AfterThrowOrRedirectError(int)
DataFlowComponent.LogProgress_AfterThrowOrRedirectError()
LoggableTask.TaskType
LoggableTask.TaskName
LoggableTask.DisableLogging
LoggableTask.LogThreshold
LoggableTask.TaskHash
LoggableTask.LogInstance
LoggableTask.ParentTask
LoggableTask.LogTrace(string, params object[])
LoggableTask.LogDebug(string, params object[])
LoggableTask.LogInfo(string, params object[])
LoggableTask.LogInfoOrDebug(string, params object[])
LoggableTask.LogWarn(string, params object[])
LoggableTask.LogError(string, params object[])
LoggableTask.LogFatal(string, params object[])
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: ETLBox.DataFlow
Assembly: ETLBox.dll
Syntax
{{< /rawhtml >}} ```C# public class Aggregation : DataFlowTransformation, IDataFlowTransformation, IDataFlowSource, IDataFlowSource, IDataFlowDestination, IDataFlowDestination, IDataFlowComponent, ILoggableTask ``` {{< rawhtml >}}
Type Parameters
Name Description
TInput

Type of ingoing data.
TOutput

Type of outgoing data.
Examples
public class MyDetailValue
{
    public int DetailValue { get; set; }
}
public class MyAggRow
{
    [AggregateColumn(nameof(MyDetailValue.DetailValue), AggregationMethod.Sum)]
    public int AggValue { get; set; }
}
var source = new DbSource<MyDetailValue>("DetailValues");
var agg = new Aggregation<MyDetailValue, MyAggRow>();
var dest = new MemoryDestination<MyAggRow>();
source.LinkTo<MyAggRow>(agg).LinkTo(dest);

Constructors

Aggregation()

Declaration
{{< /rawhtml >}} ```C# public Aggregation() ``` {{< rawhtml >}}

Aggregation(Action<TInput, TOutput>)

Declaration
{{< /rawhtml >}} ```C# public Aggregation(Action aggregationAction) ``` {{< rawhtml >}}
Parameters
Type Name Description
Action<TInput, TOutput> aggregationAction

Sets the AggregationAction

Aggregation(Action<TInput, TOutput>, Func<TInput, object>)

Declaration
{{< /rawhtml >}} ```C# public Aggregation(Action aggregationAction, Func groupingFunc) ``` {{< rawhtml >}}
Parameters
Type Name Description
Action<TInput, TOutput> aggregationAction

Sets the AggregationAction
Func<TInput, object> groupingFunc

Sets the GroupingFunc

Aggregation(Action<TInput, TOutput>, Func<TInput, object>, Action<object, TOutput>)

Declaration
{{< /rawhtml >}} ```C# public Aggregation(Action aggregationAction, Func groupingFunc, Action storeKeyAction) ``` {{< rawhtml >}}
Parameters
Type Name Description
Action<TInput, TOutput> aggregationAction

Sets the AggregationAction
Func<TInput, object> groupingFunc

Sets the GroupingFunc
Action<object, TOutput> storeKeyAction

Sets the StoreKeyAction

Properties

AggregateColumns

This list will be used to set the AggregationAction. This also works with ExpandoObjects.

Declaration
{{< /rawhtml >}} ```C# public ICollection AggregateColumns { get; set; } ``` {{< rawhtml >}}
Property Value
Type Description
ICollection<AggregateColumn>

AggregationAction

This action describes how the input data is aggregated. Not needed if you use the AggregateColumn in your object or pass a list to the AggregateColumns property.

Declaration
{{< /rawhtml >}} ```C# public Action AggregationAction { get; set; } ``` {{< rawhtml >}}
Property Value
Type Description
Action<TInput, TOutput>

AggregationCondition

When the aggregation condition is set, the pre-defined aggregation methods are only executed if this condition evaluates to true. Only applicable if you set AggregateColumn attributes on your object or if you defined your columns via the
AggregateColumns property. This func will be invoked before every aggregation (e.g. every count is Count is set for a property, and contains the currently processed row along with the current property name and aggregation method.

Declaration
{{< /rawhtml >}} ```C# public Func AggregationCondition { get; set; } ``` {{< rawhtml >}}
Property Value
Type Description
Func<TInput, AggregationMethodInfo, bool>

GroupColumns

This list will be used to set the GroupingFunc and the StoreKeyAction. This also works with ExpandoObjects.

Declaration
{{< /rawhtml >}} ```C# public ICollection GroupColumns { get; set; } ``` {{< rawhtml >}}
Property Value
Type Description
ICollection<GroupColumn>

GroupingFunc

This Func defines how the object for grouping data is retrieved. Not needed if you use the GroupColumn in your object or pass a list to the GroupColumns property.

Declaration
{{< /rawhtml >}} ```C# public Func GroupingFunc { get; set; } ``` {{< rawhtml >}}
Property Value
Type Description
Func<TInput, object>

SourceBlock

SourceBlock from the underlying TPL.Dataflow which is used as output buffer for the component.

Declaration
{{< /rawhtml >}} ```C# public override ISourceBlock SourceBlock { get; } ``` {{< rawhtml >}}
Property Value
Type Description
ISourceBlock<TOutput>
Overrides

StoreKeyAction

This action defines how the grouping object is written back into the aggregated object. Not needed if you use the GroupColumn in your object or pass a list to the GroupColumns property.

Declaration
{{< /rawhtml >}} ```C# public Action StoreKeyAction { get; set; } ``` {{< rawhtml >}}
Property Value
Type Description
Action<object, TOutput>

TargetBlock

TargetBlock from the underlying TPL.Dataflow which is used as input buffer for the component.

Declaration
{{< /rawhtml >}} ```C# public override ITargetBlock TargetBlock { get; } ``` {{< rawhtml >}}
Property Value
Type Description
ITargetBlock<TInput>
Overrides

Methods

CheckParameter()

Declaration
{{< /rawhtml >}} ```C# protected override void CheckParameter() ``` {{< rawhtml >}}
Overrides

CleanUpOnFaulted(Exception)

Declaration
{{< /rawhtml >}} ```C# protected override void CleanUpOnFaulted(Exception e) ``` {{< rawhtml >}}
Parameters
Type Name Description
Exception e
Overrides

CleanUpOnSuccess()

Declaration
{{< /rawhtml >}} ```C# protected override void CleanUpOnSuccess() ``` {{< rawhtml >}}
Overrides

CompleteBuffer()

Declaration
{{< /rawhtml >}} ```C# protected override void CompleteBuffer() ``` {{< rawhtml >}}
Overrides

FaultBuffer(Exception)

Declaration
{{< /rawhtml >}} ```C# protected override void FaultBuffer(Exception e) ``` {{< rawhtml >}}
Parameters
Type Name Description
Exception e
Overrides

InitComponent()

Declaration
{{< /rawhtml >}} ```C# protected override void InitComponent() ``` {{< rawhtml >}}
Overrides

PrepareParameterForCheck()

Declaration
{{< /rawhtml >}} ```C# protected override void PrepareParameterForCheck() ``` {{< rawhtml >}}
Overrides

Reset()

Declaration
{{< /rawhtml >}} ```C# protected override void Reset() ``` {{< rawhtml >}}
Overrides

Implements

{{< /rawhtml >}}