com.emphysic.myriad.core.data.io

Class TextDataset

java.lang.Object

com.emphysic.myriad.core.data.io.Dataset

com.emphysic.myriad.core.data.io.IODataset

com.emphysic.myriad.core.data.io.TextDataset

All Implemented Interfaces:

java.io.Serializable

public class TextDataset
extends IODataset

TextDataset - IODatasets read from delimited ASCII files.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.emphysic.myriad.core.data.io.IODataset

source

Fields inherited from class com.emphysic.myriad.core.data.io.Dataset

data, height, width

Constructor Summary

Constructors

Constructor and Description
TextDataset(java.io.File dataSource, int width, int height) Creates a new TextDataset from the specified file.
TextDataset(java.io.File dataSource, java.lang.String delim, int width, int height) Creates a new TextDataset from the specified file.
TextDataset(java.io.File dataSource, java.lang.String delim, java.lang.String commentChar, int width, int height) Creates a new TextDataset from the specified file.
TextDataset(java.lang.String dataFileName, int width, int height) Creates a new TextDataset from the specified file.
TextDataset(java.lang.String dataFileName, java.lang.String delim, int width, int height) Creates a new TextDataset from the specified file.
TextDataset(java.lang.String dataFileName, java.lang.String delim, java.lang.String commentChar, int width, int height) Creates a new TextDataset from the specified file.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCommentChar() Gets the comment character.
java.lang.String	getDelim() Returns the token delimiter.
java.util.List<java.util.List<java.lang.String>>	getStringData() Returns the String tokens from the data file, i.e.
void	read() Reads the data file.
static java.util.List<java.util.List<java.lang.String>>	readAsString(java.io.File dataFile, java.lang.String delim, java.lang.String commentChar) Reads and returns an array of elements from a delimited ASCII stringData file.
void	setCommentChar(java.lang.String commentChar) Sets the comment character.
void	setDelim(java.lang.String delim) Sets the token delimiter.

Methods inherited from class com.emphysic.myriad.core.data.io.Dataset

get, getData, getHeight, getSize, getWidth, prettyPrint, prettyPrint, set, setData, setData, write, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TextDataset

public TextDataset(java.io.File dataSource,
                   int width,
                   int height)
            throws java.io.IOException

Creates a new TextDataset from the specified file. Default delimiter and comment character assumed.

Parameters:

dataSource - file to read

width - width of data

height - height of data

Throws:

java.io.IOException - if an I/O error occurs

TextDataset

public TextDataset(java.lang.String dataFileName,
                   int width,
                   int height)
            throws java.io.IOException

Creates a new TextDataset from the specified file. Default delimiter and comment character assumed.

Parameters:

dataFileName - file to read

width - width of data

height - height of data

Throws:

java.io.IOException - if an I/O error occurs

TextDataset

public TextDataset(java.io.File dataSource,
                   java.lang.String delim,
                   java.lang.String commentChar,
                   int width,
                   int height)
            throws java.io.IOException

Creates a new TextDataset from the specified file.

Parameters:

dataSource - file to read

delim - token delimiter

commentChar - comment character

width - width of data

height - height of data

Throws:

java.io.IOException - if an I/O error occurs

TextDataset

public TextDataset(java.lang.String dataFileName,
                   java.lang.String delim,
                   java.lang.String commentChar,
                   int width,
                   int height)
            throws java.io.IOException

Creates a new TextDataset from the specified file.

Parameters:

dataFileName - file to read

delim - token delimiter

commentChar - comment character

width - width of data

height - height of data

Throws:

java.io.IOException - if an I/O error occurs

TextDataset

public TextDataset(java.io.File dataSource,
                   java.lang.String delim,
                   int width,
                   int height)
            throws java.io.IOException

Creates a new TextDataset from the specified file. Uses default comment character.

Parameters:

dataSource - file to read

delim - token delimiter

width - width of data

height - height of data

Throws:

java.io.IOException - if an I/O error occurs

TextDataset

public TextDataset(java.lang.String dataFileName,
                   java.lang.String delim,
                   int width,
                   int height)
            throws java.io.IOException

Creates a new TextDataset from the specified file. Uses default comment character.

Parameters:

dataFileName - file to read

delim - token delimiter

width - width of data

height - height of data

Throws:

java.io.IOException - if an I/O error occurs

Method Detail

readAsString

public static java.util.List<java.util.List<java.lang.String>> readAsString(java.io.File dataFile,
                                                                            java.lang.String delim,
                                                                            java.lang.String commentChar)
                                                                     throws java.io.IOException

Reads and returns an array of elements from a delimited ASCII stringData file.

Parameters:

dataFile - file to read

delim - character used to delimit elements in the file

commentChar - lines beginning with this character are treated as comments and ignored

Returns:

stringData array

Throws:

java.io.IOException - if an error occurs reading the file

read

public void read()
          throws java.io.IOException

Reads the data file.

Specified by:

read in class IODataset

Throws:

java.io.IOException - if an I/O error occurs

getDelim

public java.lang.String getDelim()

Returns the token delimiter.

Returns:

token delimiter

setDelim

public void setDelim(java.lang.String delim)

Sets the token delimiter.

Parameters:

delim - token delimiter

getCommentChar

public java.lang.String getCommentChar()

Gets the comment character.

Returns:

comment character

setCommentChar

public void setCommentChar(java.lang.String commentChar)

Sets the comment character.

Parameters:

commentChar - comment character

getStringData

public java.util.List<java.util.List<java.lang.String>> getStringData()

Returns the String tokens from the data file, i.e. its contents before being converted to numeric values.

Returns:

tokenized contents of file.