Interface IDataRowCursor

Namespace

Datafication.Core.Data

Assembly

Datafication.Core.dll

Represents a cursor for iterating over rows in a data block.

public interface IDataRowCursor

Properties

this[string]

Gets the value for the specified column at the current row position using indexer syntax.

object this[string columnName] { get; }

Parameters

columnName string

The name of the column.

Property Value

object

The value for the specified column.

Position

Gets the current position of the cursor.

int Position { get; }

Property Value

int

Schema

Gets the schema of the data block.

DataSchema Schema { get; }

Property Value

DataSchema

Methods

ExtractCurrentRow()

Extracts all values for the current row as an array.

object[] ExtractCurrentRow()

Returns

object[]

Array of values for the current row.

GetValue(string)

Gets the value for the specified column at the current row position.

object GetValue(string columnName)

Parameters

columnName string

The name of the column.

Returns

object

The value for the specified column.

GetValueByIndex(int)

Gets the value for the specified column index at the current row position.

object GetValueByIndex(int columnIndex)

Parameters

columnIndex int

The zero-based column index.

Returns

object

The value for the specified column.

IsEnd()

Determines whether the cursor has reached the end of the data.

bool IsEnd()

Returns

bool

true if the cursor is at the end; otherwise, false.

MoveBy(int)

Moves the cursor by the specified offset.

void MoveBy(int offset)

Parameters

offset int

The number of rows to move by.

MoveNext()

Advances the cursor to the next row.

bool MoveNext()

Returns

bool

True if the cursor successfully moved to the next row; otherwise, false if the cursor has passed the end.

MoveTo(int)

Moves the cursor to the specified index.

void MoveTo(int index)

Parameters

index int

The row index to move to.

Reset()

Resets the cursor to the initial position.

void Reset()