FixedWidthTextFile.ReadDataFrame Method

Definition

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

Overload List

ReadDataFrame(Stream, FixedWidthTextOptions)	Reads a data frame from a stream in fixed-width text format.
ReadDataFrame(Stream, Int32[])	Reads a data frame from a stream in fixed-width text format.
ReadDataFrame(String, FixedWidthTextOptions)	Reads a data frame from a file in fixed-width text format.
ReadDataFrame(String, Int32[])	Reads a data frame from a file in fixed-width text format.
ReadDataFrame<R>(Stream, FixedWidthTextOptions, String, Boolean)	Reads a data frame from a stream in fixed-width text format.
ReadDataFrame<R>(Stream, Int32[], String, Boolean)	Reads a data frame from a stream in fixed-width text format.
ReadDataFrame<R>(String, FixedWidthTextOptions, String, Boolean)	Reads a data frame from a file in fixed-width text format.
ReadDataFrame<R>(String, Int32[], String, Boolean)	Reads a data frame from a file in fixed-width text format.
ReadDataFrame<R, C>(Stream, FixedWidthTextOptions)	Reads a data frame from a stream in fixed-width text format.
ReadDataFrame<R, C>(Stream, Int32[])	Reads a data frame from a stream in fixed-width text format.
ReadDataFrame<R, C>(String, FixedWidthTextOptions)	Reads a data frame from a file in fixed-width text format.
ReadDataFrame<R, C>(String, Int32[])	Reads a data frame from a file in fixed-width text format.

ReadDataFrame(Stream, FixedWidthTextOptions)

Reads a data frame from a stream in fixed-width text format.

public static DataFrame<long, string> ReadDataFrame(
	Stream stream,
	FixedWidthTextOptions options
)

Visual Basic

Public Shared Function ReadDataFrame ( 
	stream As Stream,
	options As FixedWidthTextOptions
) As DataFrame(Of Long, String)

C++/CLI

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

static member ReadDataFrame : 
        stream : Stream * 
        options : FixedWidthTextOptions -> DataFrame<int64, string>

Parameters

stream Stream: A stream.
options FixedWidthTextOptions: A FixedWidthTextOptions 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(Stream, Int32[])

Reads a data frame from a stream in fixed-width text format.

public static DataFrame<long, string> ReadDataFrame(
	Stream stream,
	int[] columnBreaks
)

Visual Basic

Public Shared Function ReadDataFrame ( 
	stream As Stream,
	columnBreaks As Integer()
) As DataFrame(Of Long, String)

C++/CLI

public:
static DataFrame<long long, String^>^ ReadDataFrame(
	Stream^ stream, 
	array<int>^ columnBreaks
)

static member ReadDataFrame : 
        stream : Stream * 
        columnBreaks : int[] -> DataFrame<int64, string>

Parameters

stream Stream: A stream.
columnBreaks Int32[]: An integer array containing the zero-based indexes of the column breaks on each row.

Return Value

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

ReadDataFrame<R, C>(Stream, FixedWidthTextOptions)

Reads a data frame from a stream in fixed-width text format.

public static DataFrame<R, C> ReadDataFrame<R, C>(
	Stream stream,
	FixedWidthTextOptions options
)

Visual Basic

Public Shared Function ReadDataFrame(Of R, C) ( 
	stream As Stream,
	options As FixedWidthTextOptions
) As DataFrame(Of R, C)

C++/CLI

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

static member ReadDataFrame : 
        stream : Stream * 
        options : FixedWidthTextOptions -> DataFrame<'R, 'C>

Parameters

stream Stream: A stream.
options FixedWidthTextOptions: A FixedWidthTextOptions 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<R, C>(Stream, Int32[])

Reads a data frame from a stream in fixed-width text format.

public static DataFrame<R, C> ReadDataFrame<R, C>(
	Stream stream,
	int[] columnBreaks
)

Visual Basic

Public Shared Function ReadDataFrame(Of R, C) ( 
	stream As Stream,
	columnBreaks As Integer()
) As DataFrame(Of R, C)

C++/CLI

public:
generic<typename R, typename C>
static DataFrame<R, C>^ ReadDataFrame(
	Stream^ stream, 
	array<int>^ columnBreaks
)

static member ReadDataFrame : 
        stream : Stream * 
        columnBreaks : int[] -> DataFrame<'R, 'C>

Parameters

stream Stream: A stream.
columnBreaks Int32[]: An integer array containing the zero-based indexes of the column breaks on each row.

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, FixedWidthTextOptions)

Reads a data frame from a file in fixed-width text format.

public static DataFrame<long, string> ReadDataFrame(
	string path,
	FixedWidthTextOptions options
)

Visual Basic

Public Shared Function ReadDataFrame ( 
	path As String,
	options As FixedWidthTextOptions
) As DataFrame(Of Long, String)

C++/CLI

public:
static DataFrame<long long, String^>^ ReadDataFrame(
	String^ path, 
	FixedWidthTextOptions^ options
)

static member ReadDataFrame : 
        path : string * 
        options : FixedWidthTextOptions -> DataFrame<int64, string>

Parameters

path String: The path to the file.
options FixedWidthTextOptions: A FixedWidthTextOptions 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(String, Int32[])

Reads a data frame from a file in fixed-width text format.

public static DataFrame<long, string> ReadDataFrame(
	string path,
	int[] columnBreaks
)

Visual Basic

Public Shared Function ReadDataFrame ( 
	path As String,
	columnBreaks As Integer()
) As DataFrame(Of Long, String)

C++/CLI

public:
static DataFrame<long long, String^>^ ReadDataFrame(
	String^ path, 
	array<int>^ columnBreaks
)

static member ReadDataFrame : 
        path : string * 
        columnBreaks : int[] -> DataFrame<int64, string>

Parameters

path String: The path to the file.
columnBreaks Int32[]: An integer array containing the zero-based indexes of the column breaks on each row.

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, FixedWidthTextOptions)

Reads a data frame from a file in fixed-width text format.

public static DataFrame<R, C> ReadDataFrame<R, C>(
	string path,
	FixedWidthTextOptions options
)

Visual Basic

Public Shared Function ReadDataFrame(Of R, C) ( 
	path As String,
	options As FixedWidthTextOptions
) As DataFrame(Of R, C)

C++/CLI

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

static member ReadDataFrame : 
        path : string * 
        options : FixedWidthTextOptions -> DataFrame<'R, 'C>

Parameters

path String: The path to the file.
options FixedWidthTextOptions: A FixedWidthTextOptions 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, C>(String, Int32[])

Reads a data frame from a file in fixed-width text format.

public static DataFrame<R, C> ReadDataFrame<R, C>(
	string path,
	int[] columnBreaks
)

Visual Basic

Public Shared Function ReadDataFrame(Of R, C) ( 
	path As String,
	columnBreaks As Integer()
) As DataFrame(Of R, C)

C++/CLI

public:
generic<typename R, typename C>
static DataFrame<R, C>^ ReadDataFrame(
	String^ path, 
	array<int>^ columnBreaks
)

static member ReadDataFrame : 
        path : string * 
        columnBreaks : int[] -> DataFrame<'R, 'C>

Parameters

path String: The path to the file.
columnBreaks Int32[]: An integer array containing the zero-based indexes of the column breaks on each row.

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, FixedWidthTextOptions, String, Boolean)

Reads a data frame from a stream in fixed-width text format.

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

Visual Basic

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

C++/CLI

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

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

Parameters

stream Stream: A stream.
options FixedWidthTextOptions: A FixedWidthTextOptions object that specifies the options to use when reading 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.

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.
FileNotFoundException	The specified file does not exist.

ReadDataFrame<R>(Stream, Int32[], String, Boolean)

Reads a data frame from a stream in fixed-width text format.

public static DataFrame<R, string> ReadDataFrame<R>(
	Stream stream,
	int[] columnBreaks,
	string keyColumn,
	bool dropKeyColumn = true
)

Visual Basic

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

C++/CLI

public:
generic<typename R>
static DataFrame<R, String^>^ ReadDataFrame(
	Stream^ stream, 
	array<int>^ columnBreaks, 
	String^ keyColumn, 
	bool dropKeyColumn = true
)

static member ReadDataFrame : 
        stream : Stream * 
        columnBreaks : int[] * 
        keyColumn : string * 
        ?dropKeyColumn : bool 
(* Defaults:
        let _dropKeyColumn = defaultArg dropKeyColumn true
*)
-> DataFrame<'R, string>

Parameters

stream Stream: A stream.
columnBreaks Int32[]: An integer array containing the zero-based indexes of the column breaks on each row.
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.

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 stream.

Exceptions

KeyNotFoundException

A column named keyColumn was not found in the file.

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

Reads a data frame from a file in fixed-width text format.

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

Visual Basic

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

C++/CLI

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

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

Parameters

path String: The path to the file.
options FixedWidthTextOptions: A FixedWidthTextOptions object that specifies the options to use when reading 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.

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

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

ReadDataFrame<R>(String, Int32[], String, Boolean)

Reads a data frame from a file in fixed-width text format.

public static DataFrame<R, string> ReadDataFrame<R>(
	string path,
	int[] columnBreaks,
	string keyColumn,
	bool dropKeyColumn = true
)

Visual Basic

Public Shared Function ReadDataFrame(Of R) ( 
	path As String,
	columnBreaks As Integer(),
	keyColumn As String,
	Optional dropKeyColumn As Boolean = true
) As DataFrame(Of R, String)

C++/CLI

public:
generic<typename R>
static DataFrame<R, String^>^ ReadDataFrame(
	String^ path, 
	array<int>^ columnBreaks, 
	String^ keyColumn, 
	bool dropKeyColumn = true
)

static member ReadDataFrame : 
        path : string * 
        columnBreaks : int[] * 
        keyColumn : string * 
        ?dropKeyColumn : bool 
(* Defaults:
        let _dropKeyColumn = defaultArg dropKeyColumn true
*)
-> DataFrame<'R, string>

Parameters

path String: The path to the file.
columnBreaks Int32[]: An integer array containing the zero-based indexes of the column breaks on each row.
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.

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

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

FixedWidthTextFile.ReadDataFrame Method

Definition

Overload List

ReadDataFrame(Stream, FixedWidthTextOptions)

Parameters

Return Value

ReadDataFrame(Stream, Int32[])

Parameters

Return Value

ReadDataFrame<R, C>(Stream, FixedWidthTextOptions)

Parameters

Type Parameters

Return Value

ReadDataFrame<R, C>(Stream, Int32[])

Parameters

Type Parameters

Return Value

ReadDataFrame(String, FixedWidthTextOptions)

Parameters

Return Value

Exceptions

ReadDataFrame(String, Int32[])

Parameters

Return Value

Exceptions

ReadDataFrame<R, C>(String, FixedWidthTextOptions)

Parameters

Type Parameters

Return Value

Exceptions

ReadDataFrame<R, C>(String, Int32[])

Parameters

Type Parameters

Return Value

Exceptions

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

Parameters

Type Parameters

Return Value

Exceptions

ReadDataFrame<R>(Stream, Int32[], String, Boolean)

Parameters

Type Parameters

Return Value

Exceptions

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

Parameters

Type Parameters

Return Value

Exceptions

ReadDataFrame<R>(String, Int32[], String, Boolean)

Parameters

Type Parameters

Return Value

Exceptions

See Also

Reference