Class BlockTransformation<TInput, TOutput>

A block transformation will wait for all data from the flow to be loaded into its buffer. After all data is in the buffer, the transformation function is executed for the complete data and the result posted into the targets. The block transformations allows you to access all data in the flow in one generic collection. But as this block any processing until all data is buffered, it will also need to store the whole data in memory.

Inheritance
System.Object
LoggableTask
DataFlowComponent
DataFlowSource<TOutput>
DataFlowTransformation<TInput, TOutput>
BlockTransformation<TInput, TOutput>
BlockTransformation<TInput>
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: ETLBox.DataFlow.Transformations
Assembly: ETLBox.dll
Syntax
public class BlockTransformation<TInput, TOutput> : DataFlowTransformation<TInput, TOutput>, ILoggableTask, IDataFlowLogging, IDataFlowTransformation<TInput, TOutput>, IDataFlowSource<TOutput>, IDataFlowSource, IDataFlowDestination<TInput>, IDataFlowDestination, IDataFlowComponent
Type Parameters
Name Description
TInput

Type of ingoing data.
TOutput

Type of outgoing data.
Examples
BlockTransformation<InputType> block = new BlockTransformation<InputType>(
    inputData => {
        inputData.RemoveRange(1, 2);
        inputData.Add(new InputType() { Value = 1 });
        return inputData;
});

Constructors

BlockTransformation()

Declaration
public BlockTransformation()

BlockTransformation(Func<List<TInput>, List<TOutput>>)

Declaration
public BlockTransformation(Func<List<TInput>, List<TOutput>> blockTransformationFunc)
Parameters
Type Name Description
System.Func<System.Collections.Generic.List<TInput>, System.Collections.Generic.List<TOutput>> blockTransformationFunc

Sets the BlockTransformationFunc

Properties

BlockTransformationFunc

The transformation Func that is executed on the all input data. It should return a new list that contains all output data for further processing.

Declaration
public Func<List<TInput>, List<TOutput>> BlockTransformationFunc { get; set; }
Property Value
Type Description
System.Func<System.Collections.Generic.List<TInput>, System.Collections.Generic.List<TOutput>>

SourceBlock

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

Declaration
public override ISourceBlock<TOutput> SourceBlock { get; }
Property Value
Type Description
System.Threading.Tasks.Dataflow.ISourceBlock<TOutput>
Overrides
ETLBox.DataFlow.DataFlowSource<TOutput>.SourceBlock

TargetBlock

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

Declaration
public override ITargetBlock<TInput> TargetBlock { get; }
Property Value
Type Description
System.Threading.Tasks.Dataflow.ITargetBlock<TInput>
Overrides
ETLBox.DataFlow.DataFlowTransformation<TInput, TOutput>.TargetBlock

TaskName

A name to identify the task or component. Every component or task comes with a default name that can be overwritten.

Declaration
public override string TaskName { get; set; }
Property Value
Type Description
System.String
Overrides

Methods

CleanUpOnFaulted(Exception)

Declaration
protected override void CleanUpOnFaulted(Exception e)
Parameters
Type Name Description
System.Exception e
Overrides

CleanUpOnSuccess()

Declaration
protected override void CleanUpOnSuccess()
Overrides

InternalInitBufferObjects()

Declaration
protected override void InternalInitBufferObjects()
Overrides

Implements