Data Stream.Read Data Frame Method
Definition
Namespace: Extreme.Data
Assembly: Extreme.Data (in Extreme.Data.dll) Version: 3.2.0
Assembly: Extreme.Data (in Extreme.Data.dll) Version: 3.2.0
Overload List
Read | Reads the data frame at the current position in the file. |
Read | Reads a data frame from the file. |
Read | Reads a data frame from the file. |
Read | Reads the data frame at the current position in the file. |
Read | Reads a data frame from the file. |
Read | Reads a data frame from the file. |
ReadDataFrame
Reads the data frame at the current position in the file.
public DataFrame<long, string> ReadDataFrame()
Return Value
DataFrame<Int64, String>A data frame containing the data.
ReadDataFrame<R, C>
Reads the data frame at the current position in the file.
public abstract DataFrame<R, C> ReadDataFrame<R, C>()
Type Parameters
- R
- The type of the row keys of the data frame.
- C
- The type of the column keys of the data frame.
Return Value
DataFrame<R, C>A data frame containing the data.
ReadDataFrame<R, C>(C, Boolean)
Reads a data frame from the file.
public DataFrame<R, C> ReadDataFrame<R, C>(
C keyColumn,
bool dropIndexColumn = true
)
Parameters
- keyColumn C
- The key of the column that serves as the index of the data frame.
- dropIndexColumn Boolean (Optional)
- Optional. Specifies whether the column that contains the row keys should be dropped from the data frame. The default is true.
Type Parameters
- R
- The type of the row keys of the data frame.
- C
- The type of the column keys of the data frame.
Return Value
DataFrame<R, C>A data frame containing the data in the file.
ReadDataFrame<R>(Int32, Boolean)
Reads a data frame from the file.
public DataFrame<R, string> ReadDataFrame<R>(
int keyColumn,
bool dropIndexColumn = true
)
Parameters
- keyColumn Int32
- The index of the column that serves as the index of the data frame.
- dropIndexColumn Boolean (Optional)
- Optional. Specifies whether the column that contains the row keys should be dropped from the data frame. The default is true.
Type Parameters
- R
- The type of the row keys of the data frame.
Return Value
DataFrame<R, String>A data frame containing the data in the file.
Exceptions
Argument | keyColumn is less than zero or greater than or equal to the number of columns in the data frame. |
Invalid | The elements in the key column can not be converted to the key type R. |
ReadDataFrame<R, C>(Int32, Boolean)
Reads a data frame from the file.
public DataFrame<R, C> ReadDataFrame<R, C>(
int keyColumn,
bool dropIndexColumn = true
)
Parameters
- keyColumn Int32
- The index of the column that serves as the index of the data frame.
- dropIndexColumn Boolean (Optional)
- Optional. Specifies whether the column that contains the row keys should be dropped from the data frame. The default is true.
Type Parameters
- R
- The type of the row keys of the data frame.
- C
- The type of the column keys of the data frame.
Return Value
DataFrame<R, C>A data frame containing the data in the file.
Exceptions
Argument | keyColumn is less than zero or greater than or equal to the number of columns in the data frame. |
Invalid | The elements in the key column can not be converted to the key type R. |
ReadDataFrame<R>(String, Boolean)
Reads a data frame from the file.
public DataFrame<R, string> ReadDataFrame<R>(
string keyColumn,
bool dropIndexColumn = true
)
Parameters
- keyColumn String
- The name of the column that serves as the index of the data frame.
- dropIndexColumn Boolean (Optional)
- Optional. Specifies whether the column that contains the row keys should be dropped from the data frame. The default is true.
Type Parameters
- R
- The type of the row keys of the data frame.
Return Value
DataFrame<R, String>A data frame containing the data in the file.
Exceptions
Key | A column named keyColumn could not be found in the data frame. |
Invalid | The elements in the key column can not be converted to the key type R. |