umontreal.ssj.util.TextDataReader Class Reference

Provides static methods to read data from text files. More...

Static Public Member Functions
static double[]	readDoubleData (Reader input) throws IOException
	Reads an array of double-precision values from the reader input.
static double[]	readDoubleData (URL url) throws IOException
	Connects to the URL referred to by the URL object url, and calls readDoubleData(Reader) to obtain an array of double-precision values from the resource.
static double[]	readDoubleData (File file) throws IOException
	Opens the file referred to by the file object file, and calls readDoubleData(Reader) to obtain an array of double-precision values from the file.
static double[]	readDoubleData (String file) throws IOException
	Opens the file with name file, and calls readDoubleData(Reader) to obtain an array of double-precision values from the file.
static int[]	readIntData (Reader input) throws IOException
	This is equivalent to readDoubleData(Reader), for reading integers.
static int[]	readIntData (URL url) throws IOException
	Connects to the URL referred to by the URL object url, and calls readIntData(Reader) to obtain an array of integers from the resource.
static int[]	readIntData (File file) throws IOException
	This is equivalent to readDoubleData(File), for reading integers.
static int[]	readIntData (String file) throws IOException
	This is equivalent to readDoubleData(String), for reading integers.
static String[]	readStringData (Reader input) throws IOException
	Reads an array of strings from the reader input.
static String[]	readStringData (URL url) throws IOException
	Connects to the URL referred to by the URL object url, and calls readStringData(Reader) to obtain an array of integers from the resource.
static String[]	readStringData (File file) throws IOException
	This is equivalent to readDoubleData(File), for reading strings.
static String[]	readStringData (String file) throws IOException
	This is equivalent to readDoubleData(String), for reading strings.
static double[][]	readDoubleData2D (Reader input) throws IOException
	Uses the reader input to obtain a 2-dimensional array of double-precision values.
static double[][]	readDoubleData2D (URL url) throws IOException
	Connects to the URL referred to by the URL object url, and calls readDoubleData2D(Reader) to obtain a matrix of double-precision values from the resource.
static double[][]	readDoubleData2D (File file) throws IOException
	Opens the file referred to by the file object file, and calls readDoubleData2D(Reader) to obtain a matrix of double-precision values from the file.
static double[][]	readDoubleData2D (String file) throws IOException
	Opens the file with name file, and calls readDoubleData2D(Reader) to obtain a matrix of double-precision values from the file.
static int[][]	readIntData2D (Reader input) throws IOException
	This is equivalent to readDoubleData2D(Reader), for reading integers.
static int[][]	readIntData2D (URL url) throws IOException
	Connects to the URL referred to by the URL object url, and calls readDoubleData(Reader) to obtain a matrix of integers from the resource.
static int[][]	readIntData2D (File file) throws IOException
	This is equivalent to readDoubleData2D(File), for reading integers.
static int[][]	readIntData2D (String file) throws IOException
	This is equivalent to readDoubleData2D(String), for reading integers.
static String[][]	readCSVData (Reader input, char colDelim, char stringDelim) throws IOException
	Reads comma-separated values (CSV) from reader input, and returns a 2D array of strings corresponding to the read data.
static String[][]	readCSVData (URL url, char colDelim, char stringDelim) throws IOException
	Connects to the URL referred to by the URL object url, and calls readCSVData(Reader,char,char) to obtain a matrix of strings from the resource.
static String[][]	readCSVData (File file, char colDelim, char stringDelim) throws IOException
	This is equivalent to readDoubleData2D(File), for reading strings.
static String[][]	readCSVData (String file, char colDelim, char stringDelim) throws IOException
	This is equivalent to readDoubleData2D(String), for reading strings.

Detailed Description

Provides static methods to read data from text files.

Definition at line 41 of file TextDataReader.java.

Member Function Documentation

readCSVData() [1/4]

String[][] umontreal.ssj.util.TextDataReader.readCSVData ( File file, char colDelim, char stringDelim ) throws IOException

static

This is equivalent to readDoubleData2D(File), for reading strings.

Parameters

file	the file object represented to file to read.
colDelim	the column delimiter.
stringDelim	the string delimiter.

Returns

the obtained matrix of string values.

Exceptions

IOException

if an I/O error occurs.

Definition at line 789 of file TextDataReader.java.

readCSVData() [2/4]

String[][] umontreal.ssj.util.TextDataReader.readCSVData ( Reader input, char colDelim, char stringDelim ) throws IOException

static

Reads comma-separated values (CSV) from reader input, and returns a 2D array of strings corresponding to the read data.

Lines are delimited using line separators \r, \n, and \r\n. Each line contains one or more values, separated by the column delimiter colDelim. If a string of characters is surrounded with the string delimiter stringDelim, any line separator and column separator appear in the string. The string delimiter can be inserted in such a string by putting it twice. Usually, the column delimiter is the comma, and the string delimiter is the quotation mark. The following example uses these default delimiters.

         "One","Two","Three"
          1,2,3
         "String with "" delimiter",n,m

This produces a matrix of strings with dimensions

\(3\times3\). The first row contains the strings One, Two, and Three while the second row contains the strings 1, 2, and 3. The first column of the last row contains the string String with " delimiter.

Parameters

input	the reader to obtain data from.
colDelim	the column delimiter.
stringDelim	the string delimiter.

Returns

the obtained 2D array of strings.

Exceptions

IOException

if an I/O error occurs.

Definition at line 644 of file TextDataReader.java.

readCSVData() [3/4]

String[][] umontreal.ssj.util.TextDataReader.readCSVData ( String file, char colDelim, char stringDelim ) throws IOException

static

This is equivalent to readDoubleData2D(String), for reading strings.

Parameters

file	the name of the file to read.
colDelim	the column delimiter.
stringDelim	the string delimiter.

Returns

the obtained matrix of string values.

Exceptions

IOException

if an I/O error occurs.

Definition at line 808 of file TextDataReader.java.

readCSVData() [4/4]

String[][] umontreal.ssj.util.TextDataReader.readCSVData ( URL url, char colDelim, char stringDelim ) throws IOException

static

Connects to the URL referred to by the URL object url, and calls readCSVData(Reader,char,char) to obtain a matrix of strings from the resource.

Parameters

url	the URL object representing the resource to read.
colDelim	the column delimiter.
stringDelim	the string delimiter.

Returns

the obtained matrix of strings.

Exceptions

IOException

if an I/O error occurs.

Definition at line 770 of file TextDataReader.java.

readDoubleData() [1/4]

double[] umontreal.ssj.util.TextDataReader.readDoubleData ( File file ) throws IOException

static

Opens the file referred to by the file object file, and calls readDoubleData(Reader) to obtain an array of double-precision values from the file.

Parameters

file	the file object representing the file to read.

Returns

the obtained array of double-precision values.

Exceptions

IOException

if an I/O error occurs.

Definition at line 126 of file TextDataReader.java.

readDoubleData() [2/4]

double[] umontreal.ssj.util.TextDataReader.readDoubleData ( Reader input ) throws IOException

static

Reads an array of double-precision values from the reader input.

For each line of text obtained from the given reader, this method trims whitespaces, and parses the remaining text as a double-precision value. This method ignores every character other than the digits, the plus and minus signs, the period (.), and the letters e and E. Moreover, lines starting with a pound sign (#) are considered as comments and thus skipped. The method returns an array containing all the parsed values.

Parameters

input

the reader to obtain data from.

Returns

the obtained array of double-precision values.

Exceptions

IOException

if an I/O error occurs.

Definition at line 58 of file TextDataReader.java.

readDoubleData() [3/4]

double[] umontreal.ssj.util.TextDataReader.readDoubleData ( String file ) throws IOException

static

Opens the file with name file, and calls readDoubleData(Reader) to obtain an array of double-precision values from the file.

Parameters

file	the name of the file to read.

Returns

the obtained array of double-precision values.

Exceptions

IOException

if an I/O error occurs.

Definition at line 144 of file TextDataReader.java.

readDoubleData() [4/4]

double[] umontreal.ssj.util.TextDataReader.readDoubleData ( URL url ) throws IOException

static

Connects to the URL referred to by the URL object url, and calls readDoubleData(Reader) to obtain an array of double-precision values from the resource.

Parameters

url	the URL object representing the resource to read.

Returns

the obtained array of double-precision values.

Exceptions

IOException

if an I/O error occurs.

Definition at line 107 of file TextDataReader.java.

readDoubleData2D() [1/4]

double[][] umontreal.ssj.util.TextDataReader.readDoubleData2D ( File file ) throws IOException

static

Opens the file referred to by the file object file, and calls readDoubleData2D(Reader) to obtain a matrix of double-precision values from the file.

Parameters

file	the file object representing the file to read.

Returns

the obtained matrix of double-precision values.

Exceptions

IOException

if an I/O error occurs.

Definition at line 459 of file TextDataReader.java.

readDoubleData2D() [2/4]

double[][] umontreal.ssj.util.TextDataReader.readDoubleData2D ( Reader input ) throws IOException

static

Uses the reader input to obtain a 2-dimensional array of double-precision values.

For each line of text obtained from the given reader, this method trims whitespaces, and parses the remaining text as an array of double-precision values. Every character other than the digits, the plus (+) and minus (-) signs, the period (.), and the letters e and E are ignored and can be used to separate numbers on a line. Moreover, lines starting with a pound sign (#) are considered as comments and thus skipped. The lines containing only a semicolon sign (;) are considered as empty lines. The method returns a 2D array containing all the parsed values. The returned array is not always rectangular.

Parameters

input

the reader to obtain data from.

Returns

the 2D array of double-precison values.

Exceptions

IOException

if an I/O error occurs.

Definition at line 359 of file TextDataReader.java.

readDoubleData2D() [3/4]

double[][] umontreal.ssj.util.TextDataReader.readDoubleData2D ( String file ) throws IOException

static

Opens the file with name file, and calls readDoubleData2D(Reader) to obtain a matrix of double-precision values from the file.

Parameters

file	the name of the file to read.

Returns

the obtained matrix of double-precision values.

Exceptions

IOException

if an I/O error occurs.

Definition at line 477 of file TextDataReader.java.

readDoubleData2D() [4/4]

double[][] umontreal.ssj.util.TextDataReader.readDoubleData2D ( URL url ) throws IOException

static

Connects to the URL referred to by the URL object url, and calls readDoubleData2D(Reader) to obtain a matrix of double-precision values from the resource.

Parameters

url	the URL object representing the resource to read.

Returns

the obtained matrix of double-precision values.

Exceptions

IOException

if an I/O error occurs.

Definition at line 440 of file TextDataReader.java.

readIntData() [1/4]

int[] umontreal.ssj.util.TextDataReader.readIntData ( File file ) throws IOException

static

This is equivalent to readDoubleData(File), for reading integers.

Parameters

file	the file object represented to file to read.

Returns

the array of integers.

Exceptions

IOException

if an I/O error occurs.

Definition at line 226 of file TextDataReader.java.

readIntData() [2/4]

int[] umontreal.ssj.util.TextDataReader.readIntData ( Reader input ) throws IOException

static

This is equivalent to readDoubleData(Reader), for reading integers.

Parameters

input

the reader to obtain data from.

Returns

the obtained array of integers.

Exceptions

IOException

if an I/O error occurs.

Definition at line 161 of file TextDataReader.java.

readIntData() [3/4]

int[] umontreal.ssj.util.TextDataReader.readIntData ( String file ) throws IOException

static

This is equivalent to readDoubleData(String), for reading integers.

Parameters

file	the name of the file to read.

Returns

the array of integers.

Exceptions

IOException

if an I/O error occurs.

Definition at line 243 of file TextDataReader.java.

readIntData() [4/4]

int[] umontreal.ssj.util.TextDataReader.readIntData ( URL url ) throws IOException

static

Connects to the URL referred to by the URL object url, and calls readIntData(Reader) to obtain an array of integers from the resource.

Parameters

url	the URL object representing the resource to read.

Returns

the obtained array of integers.

Exceptions

IOException

if an I/O error occurs.

Definition at line 209 of file TextDataReader.java.

readIntData2D() [1/4]

int[][] umontreal.ssj.util.TextDataReader.readIntData2D ( File file ) throws IOException

static

This is equivalent to readDoubleData2D(File), for reading integers.

Parameters

file	the file object represented to file to read.

Returns

the obtained matrix of integer values.

Exceptions

IOException

if an I/O error occurs.

Definition at line 590 of file TextDataReader.java.

readIntData2D() [2/4]

int[][] umontreal.ssj.util.TextDataReader.readIntData2D ( Reader input ) throws IOException

static

This is equivalent to readDoubleData2D(Reader), for reading integers.

Parameters

input

the reader to obtain data from.

Returns

the obtained 2D array of integers.

Exceptions

IOException

if an I/O error occurs.

Definition at line 494 of file TextDataReader.java.

readIntData2D() [3/4]

int[][] umontreal.ssj.util.TextDataReader.readIntData2D ( String file ) throws IOException

static

This is equivalent to readDoubleData2D(String), for reading integers.

Parameters

file	the name of the file to read.

Returns

the obtained matrix of integer values.

Exceptions

IOException

if an I/O error occurs.

Definition at line 607 of file TextDataReader.java.

readIntData2D() [4/4]

int[][] umontreal.ssj.util.TextDataReader.readIntData2D ( URL url ) throws IOException

static

Connects to the URL referred to by the URL object url, and calls readDoubleData(Reader) to obtain a matrix of integers from the resource.

Parameters

url	the URL object representing the resource to read.

Returns

the obtained matrix of integers.

Exceptions

IOException

if an I/O error occurs.

Definition at line 573 of file TextDataReader.java.

readStringData() [1/4]

String[] umontreal.ssj.util.TextDataReader.readStringData ( File file ) throws IOException

static

This is equivalent to readDoubleData(File), for reading strings.

Parameters

file	the file object represented to file to read.

Returns

the array of strings.

Exceptions

IOException

if an I/O error occurs.

Definition at line 315 of file TextDataReader.java.

readStringData() [2/4]

String[] umontreal.ssj.util.TextDataReader.readStringData ( Reader input ) throws IOException

static

Reads an array of strings from the reader input.

For each line of text obtained from the given reader, this method trims leading and trailing whitespaces, and stores the remaining string. Lines starting with a pound sign (#) are considered as comments and thus skipped. The method returns an array containing all the read strings.

Parameters

input

the reader to obtain data from.

Returns

the obtained array of strings.

Exceptions

IOException

if an I/O error occurs.

Definition at line 264 of file TextDataReader.java.

readStringData() [3/4]

String[] umontreal.ssj.util.TextDataReader.readStringData ( String file ) throws IOException

static

This is equivalent to readDoubleData(String), for reading strings.

Parameters

file	the name of the file to read.

Returns

the array of strings.

Exceptions

IOException

if an I/O error occurs.

Definition at line 332 of file TextDataReader.java.

readStringData() [4/4]

String[] umontreal.ssj.util.TextDataReader.readStringData ( URL url ) throws IOException

static

Connects to the URL referred to by the URL object url, and calls readStringData(Reader) to obtain an array of integers from the resource.

Parameters

url	the URL object representing the resource to read.

Returns

the obtained array of strings.

Exceptions

IOException

if an I/O error occurs.

Definition at line 298 of file TextDataReader.java.

---

The documentation for this class was generated from the following file:

• src/main/java/umontreal/ssj/util/TextDataReader.java