Class ColumnRename<TInput>

ColumnRename allows you to rename the column or properties names of your ingoing data. This transformation works with objects, ExpandoObjects and arrays as input data type.
ColumnRename will always convert the input type into a (dynamic) ExpandoObject. Provide a column mapping with the old and the new name. The mapping can also be automatically retrieved from existing ColumnMap attributes. For arrays provide the array index and the new name.

Inheritance
object
LoggableTask
DataFlowComponent
DataFlowSource<ExpandoObject>
DataFlowTransformation<TInput, ExpandoObject>
ColumnRename<TInput>
ColumnRename
Implements
Inherited Members
Namespace: ETLBox.DataFlow
Assembly: ETLBox.dll
Syntax
    public class ColumnRename<TInput> : DataFlowTransformation<TInput, ExpandoObject>, IDataFlowLogging, IDataFlowTransformation<TInput, ExpandoObject>, IDataFlowSource<ExpandoObject>, IDataFlowSource, IDataFlowDestination<TInput>, IDataFlowDestination, IDataFlowComponent, ILoggableTask
Type Parameters
NameDescription
TInput

Type of ingoing data

Constructors

ColumnRename()

Declaration
    public ColumnRename()

ColumnRename(ICollection<RenameColumn>)

Declaration
    public ColumnRename(ICollection<RenameColumn> renameColumns)
Parameters
TypeNameDescription
ICollection<RenameColumn>renameColumns

Properties

ProgressCount

Declaration
    public int ProgressCount { get; }
Property Value
TypeDescription
int

RenameColumns

The column mapping defines how existing properties or columns are renamed. For objects and dynamic object provide a mapping with the old and the new name (arrays: array index and new name). The mapping can also be automatically retrieved from RenameColumn attributes on the properties in strongly typed objects.

Declaration
    public ICollection<RenameColumn> RenameColumns { get; set; }
Property Value
TypeDescription
ICollection<RenameColumn>

RenameFunc

Instead (or additional) to existing column renaming provided via the RenameColumns property or the RenameColumn attribute, you can define your own renaming function. It is called for each column in each row from the input, and allows you to transform the column/property name into a different property name.

Declaration
    public Func<string, string> RenameFunc { get; set; }
Property Value
TypeDescription
Func<string, string>

SourceBlock

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

Declaration
    public override ISourceBlock<ExpandoObject> SourceBlock { get; }
Property Value
TypeDescription
ISourceBlock<ExpandoObject>
Overrides

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
TypeDescription
ITargetBlock<TInput>
Overrides

Methods

CheckParameter()

Declaration
    protected override void CheckParameter()
Overrides

CleanUpOnFaulted(Exception)

Declaration
    protected override void CleanUpOnFaulted(Exception e)
Parameters
TypeNameDescription
Exceptione
Overrides

CleanUpOnSuccess()

Declaration
    protected override void CleanUpOnSuccess()
Overrides

InitComponent()

Declaration
    protected override void InitComponent()
Overrides

LinkErrorTo(IDataFlowDestination<ETLBoxError>)

If an error occurs in the component, by default the component will throw an exception and stop execution. If you use the error linking, any erroneous records will be caught and redirected.

Declaration
    public override IDataFlowSource<ETLBoxError> LinkErrorTo(IDataFlowDestination<ETLBoxError> target)
Parameters
TypeNameDescription
IDataFlowDestination<ETLBoxError>target

The target for erroneous rows.

Returns
TypeDescription
IDataFlowSource<ETLBoxError>

The linked component.

Overrides

PrepareParameterForCheck()

Declaration
    protected override void PrepareParameterForCheck()
Overrides

Reset()

Declaration
    protected override void Reset()
Overrides

Implements