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.
C#
public static DataFrame<long, string> ReadDataFrame(
	Stream stream,
	FixedWidthTextOptions options
)

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.
C#
public static DataFrame<long, string> ReadDataFrame(
	Stream stream,
	int[] columnBreaks
)

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.
C#
public static DataFrame<R, C> ReadDataFrame<R, C>(
	Stream stream,
	FixedWidthTextOptions options
)

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.
C#
public static DataFrame<R, C> ReadDataFrame<R, C>(
	Stream stream,
	int[] columnBreaks
)

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.
C#
public static DataFrame<long, string> ReadDataFrame(
	string path,
	FixedWidthTextOptions options
)

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.
C#
public static DataFrame<long, string> ReadDataFrame(
	string path,
	int[] columnBreaks
)

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.
C#
public static DataFrame<R, C> ReadDataFrame<R, C>(
	string path,
	FixedWidthTextOptions options
)

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.
C#
public static DataFrame<R, C> ReadDataFrame<R, C>(
	string path,
	int[] columnBreaks
)

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.
C#
public static DataFrame<R, string> ReadDataFrame<R>(
	Stream stream,
	FixedWidthTextOptions options,
	string keyColumn,
	bool dropKeyColumn = true
)

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.
C#
public static DataFrame<R, string> ReadDataFrame<R>(
	Stream stream,
	int[] columnBreaks,
	string keyColumn,
	bool dropKeyColumn = true
)

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.
C#
public static DataFrame<R, string> ReadDataFrame<R>(
	string path,
	FixedWidthTextOptions options,
	string keyColumn,
	bool dropKeyColumn = true
)

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.
C#
public static DataFrame<R, string> ReadDataFrame<R>(
	string path,
	int[] columnBreaks,
	string keyColumn,
	bool dropKeyColumn = true
)

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.

See Also