org.kepler.util

Class DelimitedReader

java.lang.Object

org.kepler.util.DelimitedReader

public class DelimitedReader
extends java.lang.Object

tokenizes a delimited file. This reader assumes that one record is on one line which ends with the line

Constructor Summary

Constructors

Constructor and Description
DelimitedReader(java.io.InputStream dataStream, int numCols, java.lang.String delimiter, int numHeaderLines, java.lang.String lineEnding, int numRecords, boolean stripHeader) This constructor will read delimitered data from stream rather a string
DelimitedReader(java.lang.String data, int numCols, java.lang.String delimiter, int numHeaderLines, java.lang.String lineEnding, int numRecords, boolean isLenient) constructor. reads the csv stream.

Method Summary

Modifier and Type	Method and Description
java.util.Vector	getRowDataVectorFromStream() This method is from data source as a input stream This method will read one row from and return a data vector which element is String and the value is field data.
java.util.Vector[]	getTokenizedData(boolean stripHeaderLines) returns the data as an array of vectors. each vector will have the same number of elements as there are columns in the data.
boolean	isLenient()
void	setCollapseDelimiter(boolean collapseDelimiter) Method to set up collapseDelimiter.
void	setInputStream(java.io.InputStream dataStream) Method to set up data stream as source
void	setLenient(boolean isLenient)
void	setNumFooterLines(int numFooterLines) Set up the footer line number.
java.lang.String	toString() returns a string representation of the data
static java.lang.String	unescapeDelimiter(java.lang.String delimiter) Convert a string escaped representation of a delimiter character into an the actual String for that delimiter.

Methods inherited from class java.lang.Object

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

Constructor Detail

DelimitedReader

public DelimitedReader(java.lang.String data,
                       int numCols,
                       java.lang.String delimiter,
                       int numHeaderLines,
                       java.lang.String lineEnding,
                       int numRecords,
                       boolean isLenient)
                throws java.lang.Exception

constructor. reads the csv stream.

Parameters:

delimString - the delimited stream to read

numCols - the number of columns in the stream

delimiter - the delimiter to tokenize on

numHeaderLines - the number of lines to skip at the top of the file

lineEnding - the line ending char(s)...either "\n"lo (unix),

isLenient - specifies if extra columns should be ignored "\r\n" (windoze) or "\r" (mac)

Throws:

java.lang.Exception

DelimitedReader

public DelimitedReader(java.io.InputStream dataStream,
                       int numCols,
                       java.lang.String delimiter,
                       int numHeaderLines,
                       java.lang.String lineEnding,
                       int numRecords,
                       boolean stripHeader)

This constructor will read delimitered data from stream rather a string

Parameters:

dataStream - InputStream The input stream

numCols - int the number of columns

delimiter - String delimiter the delimiter to tokenize on

numHeaderLines - int numHeaderLines the number of lines to skip at the top of the file

lineEnding - String lineEnding the line ending char(s)...either "\n" (unix),"\r\n" (windoze) or "\r" (mac)

numRecords - int number of rows in the input stream

Method Detail

setInputStream

public void setInputStream(java.io.InputStream dataStream)

Method to set up data stream as source

Parameters:

dataStream - InputStream

setCollapseDelimiter

public void setCollapseDelimiter(boolean collapseDelimiter)

Method to set up collapseDelimiter. If it is yes, consecutive dilimiters will be consider as single dilimiter.

Parameters:

collapseDelimiter -

setNumFooterLines

public void setNumFooterLines(int numFooterLines)

Set up the footer line number.

Parameters:

numFooterLines -

isLenient

public boolean isLenient()

setLenient

public void setLenient(boolean isLenient)

getRowDataVectorFromStream

public java.util.Vector getRowDataVectorFromStream()
                                            throws java.lang.Exception

This method is from data source as a input stream This method will read one row from and return a data vector which element is String and the value is field data. After reach the end of stream, empty vector will be returned. So this method can be iterated by a while loop until a empty vector hited. During the iteration, every data in the stream will be pulled out.

Returns:

Vector

Throws:

java.lang.Exception

getTokenizedData

public java.util.Vector[] getTokenizedData(boolean stripHeaderLines)

returns the data as an array of vectors. each vector will have the same number of elements as there are columns in the data.

Parameters:

stripHeaderLines - true if the header lines should not be included in the returned data, false otherwise

toString

public java.lang.String toString()

returns a string representation of the data

Overrides:

toString in class java.lang.Object

unescapeDelimiter

public static java.lang.String unescapeDelimiter(java.lang.String delimiter)

Convert a string escaped representation of a delimiter character into an the actual String for that delimiter. This is used for translating escaped versions of tab, newline, and carriage return characters to their real character values.

Parameters:

delimiter - the String representing the delimiter

Returns:

the actual String for the delimiter