DelimitedTextFile.ReadDataFrame Method

Definition

Namespace: Extreme.Data.Text
Assembly: Extreme.Data (in Extreme.Data.dll) Version: 3.2.0

Overload List

ReadDataFrame(Stream, DelimitedTextOptions)	Reads a data frame from a stream in delimited text format.
ReadDataFrame(String, DelimitedTextOptions)	Reads a data frame from a file in delimited text format.
ReadDataFrame<R>(Stream, String, Boolean, DelimitedTextOptions)	Reads a data frame from a stream in delimited text format.
ReadDataFrame<R>(String, String, Boolean, DelimitedTextOptions)	Reads a data frame from a file in delimited text format.
ReadDataFrame<R, C>(Stream, DelimitedTextOptions)	Reads a data frame from a stream in delimited text format.
ReadDataFrame<R, C>(String, DelimitedTextOptions)	Reads a data frame from a file in delimited text format.

ReadDataFrame(Stream, DelimitedTextOptions)

Reads a data frame from a stream in delimited text format.

public static DataFrame<long, string> ReadDataFrame(
	Stream stream,
	DelimitedTextOptions options = null
)

Visual Basic

Public Shared Function ReadDataFrame ( 
	stream As Stream,
	Optional options As DelimitedTextOptions = Nothing
) As DataFrame(Of Long, String)

C++/CLI

public:
static DataFrame<long long, String^>^ ReadDataFrame(
	Stream^ stream, 
	DelimitedTextOptions^ options = nullptr
)

static member ReadDataFrame : 
        stream : Stream * 
        ?options : DelimitedTextOptions 
(* Defaults:
        let _options = defaultArg options null
*)
-> DataFrame<int64, string>

Parameters

stream Stream: A stream.
options DelimitedTextOptions (Optional): A DelimitedTextOptions object that specifies the options to use when reading the file.

Return Value

DataFrame<Int64, String>
The data frame that was read from the stream pointed to by stream.

ReadDataFrame<R, C>(Stream, DelimitedTextOptions)

Reads a data frame from a stream in delimited text format.

public static DataFrame<R, C> ReadDataFrame<R, C>(
	Stream stream,
	DelimitedTextOptions options = null
)

Visual Basic

Public Shared Function ReadDataFrame(Of R, C) ( 
	stream As Stream,
	Optional options As DelimitedTextOptions = Nothing
) As DataFrame(Of R, C)

C++/CLI

public:
generic<typename R, typename C>
static DataFrame<R, C>^ ReadDataFrame(
	Stream^ stream, 
	DelimitedTextOptions^ options = nullptr
)

static member ReadDataFrame : 
        stream : Stream * 
        ?options : DelimitedTextOptions 
(* Defaults:
        let _options = defaultArg options null
*)
-> DataFrame<'R, 'C>

Parameters

stream Stream: A stream.
options DelimitedTextOptions (Optional): A DelimitedTextOptions object that specifies the options to use when reading the file.

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>
The data frame that was read from the stream pointed to by stream.

ReadDataFrame(String, DelimitedTextOptions)

Reads a data frame from a file in delimited text format.

public static DataFrame<long, string> ReadDataFrame(
	string path,
	DelimitedTextOptions options = null
)

Visual Basic

Public Shared Function ReadDataFrame ( 
	path As String,
	Optional options As DelimitedTextOptions = Nothing
) As DataFrame(Of Long, String)

C++/CLI

public:
static DataFrame<long long, String^>^ ReadDataFrame(
	String^ path, 
	DelimitedTextOptions^ options = nullptr
)

static member ReadDataFrame : 
        path : string * 
        ?options : DelimitedTextOptions 
(* Defaults:
        let _options = defaultArg options null
*)
-> DataFrame<int64, string>

Parameters

path String: The path to the file.
options DelimitedTextOptions (Optional): A DelimitedTextOptions object that specifies the options to use when reading the file.

Return Value

DataFrame<Int64, String>
The data frame that was read from the file pointed to by path.

Exceptions

FileNotFoundException

The specified file does not exist.

ReadDataFrame<R, C>(String, DelimitedTextOptions)

Reads a data frame from a file in delimited text format.

public static DataFrame<R, C> ReadDataFrame<R, C>(
	string path,
	DelimitedTextOptions options = null
)

Visual Basic

Public Shared Function ReadDataFrame(Of R, C) ( 
	path As String,
	Optional options As DelimitedTextOptions = Nothing
) As DataFrame(Of R, C)

C++/CLI

public:
generic<typename R, typename C>
static DataFrame<R, C>^ ReadDataFrame(
	String^ path, 
	DelimitedTextOptions^ options = nullptr
)

static member ReadDataFrame : 
        path : string * 
        ?options : DelimitedTextOptions 
(* Defaults:
        let _options = defaultArg options null
*)
-> DataFrame<'R, 'C>

Parameters

path String: The path to the file.
options DelimitedTextOptions (Optional): A DelimitedTextOptions object that specifies the options to use when reading the file.

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>
The data frame that was read from the file pointed to by path.

Exceptions

FileNotFoundException

The specified file does not exist.

ReadDataFrame<R>(Stream, String, Boolean, DelimitedTextOptions)

Reads a data frame from a stream in delimited text format.

public static DataFrame<R, string> ReadDataFrame<R>(
	Stream stream,
	string keyColumn,
	bool dropKeyColumn = true,
	DelimitedTextOptions options = null
)

Visual Basic

Public Shared Function ReadDataFrame(Of R) ( 
	stream As Stream,
	keyColumn As String,
	Optional dropKeyColumn As Boolean = true,
	Optional options As DelimitedTextOptions = Nothing
) As DataFrame(Of R, String)

C++/CLI

public:
generic<typename R>
static DataFrame<R, String^>^ ReadDataFrame(
	Stream^ stream, 
	String^ keyColumn, 
	bool dropKeyColumn = true, 
	DelimitedTextOptions^ options = nullptr
)

static member ReadDataFrame : 
        stream : Stream * 
        keyColumn : string * 
        ?dropKeyColumn : bool * 
        ?options : DelimitedTextOptions 
(* Defaults:
        let _dropKeyColumn = defaultArg dropKeyColumn true
        let _options = defaultArg options null
*)
-> DataFrame<'R, string>

Parameters

stream Stream: A stream.
keyColumn String: The name of the column that contains the column keys.
dropKeyColumn Boolean (Optional): If true, the key column is not included in the returned data frame.
options DelimitedTextOptions (Optional): A DelimitedTextOptions object that specifies the options to use when reading the file.

Type Parameters

R: The element type of the key column.

Return Value

DataFrame<R, String>
The data frame that was read from the stream pointed to by stream.

Exceptions

KeyNotFoundException

A column named keyColumn was not found in the file.

ReadDataFrame<R>(String, String, Boolean, DelimitedTextOptions)

Reads a data frame from a file in delimited text format.

public static DataFrame<R, string> ReadDataFrame<R>(
	string path,
	string keyColumn,
	bool dropKeyColumn = true,
	DelimitedTextOptions options = null
)

Visual Basic

Public Shared Function ReadDataFrame(Of R) ( 
	path As String,
	keyColumn As String,
	Optional dropKeyColumn As Boolean = true,
	Optional options As DelimitedTextOptions = Nothing
) As DataFrame(Of R, String)

C++/CLI

public:
generic<typename R>
static DataFrame<R, String^>^ ReadDataFrame(
	String^ path, 
	String^ keyColumn, 
	bool dropKeyColumn = true, 
	DelimitedTextOptions^ options = nullptr
)

static member ReadDataFrame : 
        path : string * 
        keyColumn : string * 
        ?dropKeyColumn : bool * 
        ?options : DelimitedTextOptions 
(* Defaults:
        let _dropKeyColumn = defaultArg dropKeyColumn true
        let _options = defaultArg options null
*)
-> DataFrame<'R, string>

Parameters

path String: The path to the file.
keyColumn String: The name of the column that contains the column keys.
dropKeyColumn Boolean (Optional): If true, the key column is not included in the returned data frame.
options DelimitedTextOptions (Optional): A DelimitedTextOptions object that specifies the options to use when reading the file.

Type Parameters

R: The element type of the key column.

Return Value

DataFrame<R, String>
The data frame that was read from the file pointed to by path.

Exceptions

FileNotFoundException	The specified file does not exist.
KeyNotFoundException	A column named keyColumn was not found in the file.

DelimitedTextFile.ReadDataFrame Method

Definition

Overload List

ReadDataFrame(Stream, DelimitedTextOptions)

Parameters

Return Value

ReadDataFrame<R, C>(Stream, DelimitedTextOptions)

Parameters

Type Parameters

Return Value

ReadDataFrame(String, DelimitedTextOptions)

Parameters

Return Value

Exceptions

ReadDataFrame<R, C>(String, DelimitedTextOptions)

Parameters

Type Parameters

Return Value

Exceptions

ReadDataFrame<R>(Stream, String, Boolean, DelimitedTextOptions)

Parameters

Type Parameters

Return Value

Exceptions

ReadDataFrame<R>(String, String, Boolean, DelimitedTextOptions)

Parameters

Type Parameters

Return Value

Exceptions

See Also

Reference