Class RowWithErrorTargetBase<TDerived, TInputError>

An abstract dataflow worker which repeatedly executes the OnInputRow(TInputError) method when there is an input row available on the Input port. It also has an ErrorOutput port of the same type as the Input. The library user must inherit this class and override OnInputRow to provide custom functionality.

OnInputRow(TInputError) is passed the row as a parameter, and does not itself take rows from the input port.

If the method throws an exception, the input row will be rejected to the ErrorOutput port.

This class simplifies the implementation by allowing the developer to write synchronous code that operates on a single row at a time, without having to check for the availability of incoming rows.

The derived class can additionally override RunAsync() to add logic that runs before and after all processing of rows, in which case the base class base.RunAsync() must be called. The derived class (or its user) can also use worker callbacks to add logic.

Use RowTargetBase<TDerived, TInput> if an error output port is not needed. Also see the RowTargetBase example.

Note: The input port uses the Default policy. Consider whether this is appropriate, or should be changed, see BufferingMode for further details.

Inheritance
Object
WorkerParent
WorkerBase
WorkerBase<TDerived>
RowsTargetBase<TDerived, TInputError>
RowWithErrorTargetBase<TDerived, TInputError>
Implements
Inherited Members
Namespace: actionETL
Assembly: actionETL.dll
Syntax
public abstract class RowWithErrorTargetBase<TDerived, TInputError> : RowsTargetBase<TDerived, TInputError>, IDisposeOnFinished where TDerived : RowWithErrorTargetBase<TDerived, TInputError> where TInputError : class
Type Parameters
Name Description
TDerived

The type of the derived worker. Class definition example:

public class MyTarget<TInputError>
    : RowsTargetBase<MyTarget<TInputError>,TInputError>
    where TInputError : class
{ 
    // ...
}
TInputError

The type of each Input and ErrorOutput row.

Constructors

RowWithErrorTargetBase(in DownstreamFactory<TInputError>, String)

Initializes a new instance of the RowWithErrorTargetBase<TDerived, TInputError> abstract dataflow worker, which repeatedly executes the OnInputRow method when there are input rows available on the Input port.

Declaration
protected RowWithErrorTargetBase(in DownstreamFactory<TInputError> downstreamFactory, string workerName)
Parameters
Type Name Description
DownstreamFactory<TInputError> downstreamFactory

The downstream factory, which specifies the parent worker and (optionally) the upstream port to link the "first" input port of this dataflow worker to.

Get it from Link when the upstream port is known ahead of time (which is usually the case). Otherwise get it from GetDownstreamFactory<TInput>(), and link the transform or target explicitly using LinkTo(InputPort<TOutput>) or LinkFrom(OutputPortBase<TInput>).

String workerName

Name of the worker.

Set to a prefix plus a trailing "/" (e.g. "MyPrefix-/") to generate a unique name from the prefix plus an increasing number starting at 1.

While less useful, set to null, whitespace or "/" to generate a unique name from the worker type plus an increasing number starting at 1.

The name cannot otherwise contain "/", and cannot start with double underscore "__".

Exceptions
Type Condition
ArgumentException

workerName:

  • Workers with the same parent must have unique names.
  • Worker and worker system names cannot contain '/' or start with double underscore '__'.
ArgumentNullException

workerParent - All workers must have a parent. The top level workers have the worker system as parent.
InvalidOperationException
  • Cannot add child worker to parent which has completed. Are you adding it to the correct parent?
  • Cannot add worker to parent, since its children have been started. Are you adding it to the correct parent?

Properties

ErrorOutput

Gets the error output port for sending error rows to logging and an optional downstream worker.

Declaration
public ErrorOutputPort<TInputError> ErrorOutput { get; }
Property Value
Type Description
ErrorOutputPort<TInputError>

Methods

OnInputRow(TInputError)

An abstract method that gets called repeatedly when there is an input row available on the Input port. Override it and process each incoming row.

Declaration
protected abstract ProgressStatus OnInputRow(TInputError inputRow)
Parameters
Type Name Description
TInputError inputRow

The incoming row. Guaranteed to not be null.
Returns
Type Description
ProgressStatus
  • NotCompleted to continue to be called when there are input rows available.
  • Succeeded to discard all additional incoming rows, and successfully finish row processing and the worker.
  • Error or Fatal to fail the worker.

OnInputRowsAsync()

For internal use.

Declaration
protected sealed override Task<ProgressStatus> OnInputRowsAsync()
Returns
Type Description
Task<ProgressStatus>
Overrides
actionETL.RowsTargetBase<TDerived, TInputError>.OnInputRowsAsync()

Implements

See Also

RowTargetBase<TDerived, TInput>