org.biolegato.tables

Class CSVFile

java.lang.Object

javax.swing.filechooser.FileFilter

org.biolegato.tables.CSVFile

All Implemented Interfaces:

CSVFileConstants

public class CSVFile
extends javax.swing.filechooser.FileFilter
implements CSVFileConstants

CSV (Comma Separated Values) file format parser. A CSV file is a spreadsheet, where the rows are separated by new line characters (i.e. each line of the file is a row), and the columns are separated by comma characters. Thus an example of a CSV file would be:

       Name,Phone Num,Birthday
       John,555-5123,Apr. 30, 1937
       Jane,555-4352,Feb. 13, 1976
       Sam,555-6333,Jan. 7, 1961
       Tom,555-7777,Aug. 4, 1943

Where name, phone number, and birthday are all separated by comma characters and are each columns of a spreadsheet.

NOTE: fields may be double or single quoted. In such cases, the single or double quotes character may be escaped by doubling it (e.g. "AB""C" will be read as AB"C).

Author:

Graham Alvare, Brian Fristensky

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[][]	DBL_EST An empty 2D string array for calling the List.toArray method.
static java.lang.String[]	EST An empty 1D string array for calling the List.toArray method.
Token	jj_nt Next token.
Token	token Current token.
CSVFileTokenManager	token_source Generated Token Manager.

Fields inherited from interface org.biolegato.tables.CSVFileConstants

ACCEPTSQ, CDELIM, CHAR, CHARS, DCHAR, DEFAULT, DQEND, DQSTART, DQUOTE, EOF, RDELIM, SCHAR, SQEND, SQSTART, SQUOTE, tokenImage

Constructor Summary

Constructors

Constructor and Description
CSVFile() Creates a new instance of CSVFile
CSVFile(CSVFileTokenManager tm) Constructor with generated Token Manager.
CSVFile(java.io.InputStream stream) Constructor with InputStream.
CSVFile(java.io.InputStream stream, java.lang.String encoding) Constructor with InputStream and supplied encoding
CSVFile(java.io.Reader stream) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	accept(java.io.File file) Determines whether a file is a CSV file (based on extension).
void	disable_tracing() Disable tracing.
void	enable_tracing() Enable tracing.
ParseException	generateParseException() Generate ParseException.
java.lang.String	getDescription() Returns a description of the file format that can be displayed to the user.
Token	getNextToken() Get the next Token.
Token	getToken(int index) Get the specific Token.
boolean	isFormat(java.io.Reader test) Used to auto-detect BioLegato table canvas formats.
java.lang.String	parseColumn() Parses a column of the CSV data.
void	parseCSV(TableCanvas table) Parse CSV data into a table canvas.
java.lang.String[][]	parseDoubleArray() Parse CSV data into a table canvas.
java.lang.String[]	parseRow() Parses a row of the CSV data.
static java.lang.String[][]	readCSV(java.io.Reader currentFile) Reads CSV data from a Reader object into a 2D string array.
static void	readFile(TableCanvas table, java.io.Reader currentFile, boolean overwrite, boolean forceall) Reads CSV data from a Reader object into a table canvas.
void	ReInit(CSVFileTokenManager tm) Reinitialise.
void	ReInit(java.io.InputStream stream) Reinitialise.
void	ReInit(java.io.InputStream stream, java.lang.String encoding) Reinitialise.
void	ReInit(java.io.Reader stream) Reinitialise.
static void	writeFile(java.lang.Appendable writer, java.lang.String[][] data) Writes a 2D string array as CSV data into an Appendable object.

Methods inherited from class java.lang.Object

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

Field Detail

EST

public static final java.lang.String[] EST

An empty 1D string array for calling the List.toArray method.

DBL_EST

public static final java.lang.String[][] DBL_EST

An empty 2D string array for calling the List.toArray method.

token_source

public CSVFileTokenManager token_source

Generated Token Manager.

token

public Token token

Current token.

jj_nt

public Token jj_nt

Next token.

Constructor Detail

CSVFile

public CSVFile()

Creates a new instance of CSVFile

CSVFile

public CSVFile(java.io.InputStream stream)

Constructor with InputStream.

CSVFile

public CSVFile(java.io.InputStream stream,
               java.lang.String encoding)

Constructor with InputStream and supplied encoding

CSVFile

public CSVFile(java.io.Reader stream)

Constructor.

CSVFile

public CSVFile(CSVFileTokenManager tm)

Constructor with generated Token Manager.

Method Detail

accept

public boolean accept(java.io.File file)

Determines whether a file is a CSV file (based on extension). Currently the only extension supported is ".csv"

Specified by:

accept in class javax.swing.filechooser.FileFilter

Parameters:

file - the file to test for CSV format compatibility.

Returns:

true if the file is a CSV file (otherwise false).

See Also:

FileFilter.accept(java.io.File)

getDescription

public java.lang.String getDescription()

Returns a description of the file format that can be displayed to the user. This allows the user to easily find and identify a file format in the file type combo box (within file chooser objects).

Specified by:

getDescription in class javax.swing.filechooser.FileFilter

Returns:

the string description of the file format.

See Also:

FileFilter.getDescription()

isFormat

public boolean isFormat(java.io.Reader test)

Used to auto-detect BioLegato table canvas formats. This function will return true if the format is suspected to be a CSV file. Otherwise, the function will return false.

Parameters:

test - the reader to attempt to detect the format of.

Returns:

whether the format is a CSV file.

readFile

public static void readFile(TableCanvas table,
                            java.io.Reader currentFile,
                            boolean overwrite,
                            boolean forceall)
                     throws java.io.IOException

Reads CSV data from a Reader object into a table canvas.

Parameters:

table - the table canvas to read the CSV file into.

currentFile - the Reader object to parsed the CSV data from.

overwrite - whether to overwrite the currently selected content in the table canvas with the data parsed by this function. Note that this currently does not work, and should be implemented in the future.

Throws:

java.io.IOException - thrown if there is any exception while reading from the Reader object.

readCSV

public static java.lang.String[][] readCSV(java.io.Reader currentFile)
                                    throws java.io.IOException

Reads CSV data from a Reader object into a 2D string array. Please note that the 2D string array is specified as follows: the rows are the first index of the array (e.g. data[0] is the first row of the array), and the columns are the second index of the array (e.g. data[0][1] is the second column of the first row of the array.

Parameters:

currentFile - the Reader object to parsed the CSV data from.

Throws:

java.io.IOException - thrown if there is any exception while reading from the Reader object.

writeFile

public static void writeFile(java.lang.Appendable writer,
                             java.lang.String[][] data)
                      throws java.io.IOException

Writes a 2D string array as CSV data into an Appendable object. Please note that the rows are the first index of the array (e.g. data[0] is the first row of the array), and the columns are the second index of the array (e.g. data[0][1] is the second column of the first row of the array.

Parameters:

writer - the Appendable object to write the CSV data to.

data - the 2D string array to parse into CSV data.

Throws:

java.io.IOException - thrown if there is any exception while writing to the Appendable object.

parseCSV

public final void parseCSV(TableCanvas table)
                    throws ParseException

Parse CSV data into a table canvas.

Parameters:

table - the table canvas to parse the data into.

Throws:

ParseException

See Also:

TableCanvas.namedHeaders

parseDoubleArray

public final java.lang.String[][] parseDoubleArray()
                                            throws ParseException

Parse CSV data into a table canvas. Please note that the 2D string array is specified as follows: the rows are the first index of the array (e.g. data[0] is the first row of the array), and the columns are the second index of the array (e.g. data[0][1] is the second column of the first row of the array.

Returns:

the 2D string array generated from the parse.

Throws:

ParseException

parseRow

public final java.lang.String[] parseRow()
                                  throws ParseException

Parses a row of the CSV data.

Returns:

the array of columns contained in the row.

Throws:

ParseException

parseColumn

public final java.lang.String parseColumn()
                                   throws ParseException

Parses a column of the CSV data.

Returns:

a single column, represented as a string object.

Throws:

ParseException

ReInit

public void ReInit(java.io.InputStream stream)

Reinitialise.

ReInit

public void ReInit(java.io.InputStream stream,
                   java.lang.String encoding)

Reinitialise.

ReInit

public void ReInit(java.io.Reader stream)

Reinitialise.

ReInit

public void ReInit(CSVFileTokenManager tm)

Reinitialise.

getNextToken

public final Token getNextToken()

Get the next Token.

getToken

public final Token getToken(int index)

Get the specific Token.

generateParseException

public ParseException generateParseException()

Generate ParseException.

enable_tracing

public final void enable_tracing()

Enable tracing.

disable_tracing

public final void disable_tracing()

Disable tracing.