Class Sort<TInput>
Sorts the incoming data with by the given comparison function.
This is a blocking transformation - no output will be produced until all input data has arrived in the transformation.
Namespace: ETLBox.DataFlow
Assembly: ETLBox.dll
Syntax
{{< /rawhtml >}}
```C#
public class Sort : DataFlowTransformation, IDataFlowTransformation, IDataFlowSource, IDataFlowSource, IDataFlowDestination, IDataFlowDestination, IDataFlowComponent, ILoggableTask
```
{{< rawhtml >}}
Type Parameters
| Name |
Description |
| TInput |
Type of ingoing (and also outgoing) data.
|
Examples
Comparison<MyDataRow> comp = new Comparison<MyDataRow>(
(x, y) => y.Value2 - x.Value2
);
Sort<MyDataRow> block = new Sort<MyDataRow>(comp);
Constructors
Sort()
Declaration
{{< /rawhtml >}}
```C#
public Sort()
```
{{< rawhtml >}}
Sort(Comparison<TInput>)
Declaration
{{< /rawhtml >}}
```C#
public Sort(Comparison sortFunction)
```
{{< rawhtml >}}
Parameters
Properties
MaxBufferSize
Declaration
{{< /rawhtml >}}
```C#
public int MaxBufferSize { get; }
```
{{< rawhtml >}}
Property Value
ProgressCount
Declaration
{{< /rawhtml >}}
```C#
public int ProgressCount { get; }
```
{{< rawhtml >}}
Property Value
SortColumns
Columns by which the input data is sorted.
If SortColumsn are defined, the SortFunction must be empty.
Declaration
{{< /rawhtml >}}
```C#
public ICollection SortColumns { get; set; }
```
{{< rawhtml >}}
Property Value
SortFunction
A System.Comparison used to sort the data.
This will always be used first, even if SortColumns are provided.
Declaration
{{< /rawhtml >}}
```C#
public Comparison SortFunction { get; set; }
```
{{< rawhtml >}}
Property Value
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
Overrides
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
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
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
Overrides
InitComponent()
Declaration
{{< /rawhtml >}}
```C#
protected override void InitComponent()
```
{{< rawhtml >}}
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
{{< /rawhtml >}}
```C#
public override IDataFlowSource LinkErrorTo(IDataFlowDestination target)
```
{{< rawhtml >}}
Parameters
Returns
Overrides
PrepareParameterForCheck()
Declaration
{{< /rawhtml >}}
```C#
protected override void PrepareParameterForCheck()
```
{{< rawhtml >}}
Overrides
Reset()
Declaration
{{< /rawhtml >}}
```C#
protected override void Reset()
```
{{< rawhtml >}}
Overrides
Implements
{{< /rawhtml >}}