smile.data.parser

Class DelimitedTextParser

java.lang.Object

smile.data.parser.DelimitedTextParser

public class DelimitedTextParser
extends Object

The delimited text file parser. By default, the parser expects a white-space-separated-values file. Each line in the file corresponds to a row in the table. Within a line, fields are separated by white spaces, each field belonging to one table column. This class can also be used to read other text tabular files by setting delimiter character such ash ','. The file may contain comment lines (starting with '%') and missing values (indicated by placeholder '?'), which both can be parameterized.

Author:

Haifeng Li

Constructor Summary

Constructors

Constructor and Description
DelimitedTextParser() Constructor with default delimiter of white space, comment line starting with '%', missing value placeholder "?", no column names, no row names.

Method Summary

Methods

Modifier and Type	Method and Description
String	getCommentStartWith() Returns the character/string that starts a comment line.
String	getDelimiter() Returns the delimiter character/string.
String	getMissingValuePlaceholder() Returns the missing value placeholder.
boolean	hasColumnNames() Returns if the dataset has column namesS (at row 0).
boolean	hasRowNames() Returns if the dataset has row names (at column 0).
AttributeDataset	parse(File file) Parse a dataset from given file.
AttributeDataset	parse(String path) Parse a dataset from given file.
AttributeDataset	parse(String name, Attribute[] attributes, File file) Parse a dataset from given file.
AttributeDataset	parse(String name, Attribute[] attributes, String path) Parse a dataset from given file.
AttributeDataset	parse(String name, Attribute[] attributes, URI uri) Parse a dataset from given URI.
AttributeDataset	parse(String name, InputStream stream) Parse a dataset from an input stream.
AttributeDataset	parse(URI uri) Parse a dataset from given URI.
void	setColumnNames(boolean hasColNames) Set if the dataset has column names (at row 0).
void	setCommentStartWith(String comment) Set the character/string that starts a comment line.
void	setDelimiter(String delimiter) Set the delimiter character/string.
void	setMissingValuePlaceholder(String missing) Set the missing value placeholder.
void	setResponseIndex(Attribute response, int index) Sets the attribute and column index (starting at 0) of dependent/response variable.
void	setRowNames(boolean hasRowNames) Set if the dataset has row names (at column 0).

Methods inherited from class java.lang.Object

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

Constructor Detail

DelimitedTextParser

public DelimitedTextParser()

Constructor with default delimiter of white space, comment line starting with '%', missing value placeholder "?", no column names, no row names.

Method Detail

getDelimiter

public String getDelimiter()

Returns the delimiter character/string.

setDelimiter

public void setDelimiter(String delimiter)

Set the delimiter character/string.

getCommentStartWith

public String getCommentStartWith()

Returns the character/string that starts a comment line.

setCommentStartWith

public void setCommentStartWith(String comment)

Set the character/string that starts a comment line.

getMissingValuePlaceholder

public String getMissingValuePlaceholder()

Returns the missing value placeholder.

setMissingValuePlaceholder

public void setMissingValuePlaceholder(String missing)

Set the missing value placeholder.

setResponseIndex

public void setResponseIndex(Attribute response,
                    int index)

Sets the attribute and column index (starting at 0) of dependent/response variable.

hasRowNames

public boolean hasRowNames()

Returns if the dataset has row names (at column 0).

setRowNames

public void setRowNames(boolean hasRowNames)

Set if the dataset has row names (at column 0).

hasColumnNames

public boolean hasColumnNames()

Returns if the dataset has column namesS (at row 0).

setColumnNames

public void setColumnNames(boolean hasColNames)

Set if the dataset has column names (at row 0).

parse

public AttributeDataset parse(URI uri)
                       throws FileNotFoundException,
                              IOException,
                              ParseException

Parse a dataset from given URI.

Throws:

FileNotFoundException

IOException

ParseException

parse

public AttributeDataset parse(String name,
                     Attribute[] attributes,
                     URI uri)
                       throws FileNotFoundException,
                              IOException,
                              ParseException

Parse a dataset from given URI.

Parameters:

uri - the URI of data source.

attributes - the list attributes of data in proper order.

Throws:

FileNotFoundException

IOException

ParseException

parse

public AttributeDataset parse(String path)
                       throws FileNotFoundException,
                              IOException,
                              ParseException

Parse a dataset from given file.

Parameters:

path - the file path of data source.

Throws:

FileNotFoundException

IOException

ParseException

parse

public AttributeDataset parse(String name,
                     Attribute[] attributes,
                     String path)
                       throws FileNotFoundException,
                              IOException,
                              ParseException

Parse a dataset from given file.

Parameters:

path - the file path of data source.

attributes - the list attributes of data in proper order.

Throws:

FileNotFoundException

IOException

ParseException

parse

public AttributeDataset parse(File file)
                       throws FileNotFoundException,
                              IOException,
                              ParseException

Parse a dataset from given file.

Parameters:

file - the file of data source.

Throws:

FileNotFoundException

IOException

ParseException

parse

public AttributeDataset parse(String name,
                     Attribute[] attributes,
                     File file)
                       throws FileNotFoundException,
                              IOException,
                              ParseException

Parse a dataset from given file.

Parameters:

file - the file of data source.

attributes - the list attributes of data in proper order.

Throws:

FileNotFoundException

IOException

ParseException

parse

public AttributeDataset parse(String name,
                     InputStream stream)
                       throws IOException,
                              ParseException

Parse a dataset from an input stream.

Parameters:

name - the name of dataset.

stream - the input stream of data.

Throws:

FileNotFoundException

IOException

ParseException