TSVFile

java.lang.Object
- org.biolegato.tables.TSVFile

All Implemented Interfaces:

TSVFileConstants
```
public class TSVFile
extends java.lang.Object
implements TSVFileConstants
```
TSV (Tab Separated Values) file format parser. A TSV 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 tab characters. Thus an example of a TSV 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 tab 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.
`TSVFileTokenManager`	`token_source` Generated Token Manager.
`static javax.swing.filechooser.FileFilter`	`TSV_FILTER` TSV file format filter (for file chooser objects).

Fields inherited from interface org.biolegato.tables.TSVFileConstants
ACCEPTSQ, CDELIM, CHAR, CHARS, DCHAR, DEFAULT, DQEND, DQSTART, DQUOTE, EOF, RDELIM, SCHAR, SQEND, SQSTART, SQUOTE, tokenImage

Constructor Summary

Constructors
Constructor and Description
`TSVFile(java.io.InputStream stream)` Constructor with InputStream.
`TSVFile(java.io.InputStream stream, java.lang.String encoding)` Constructor with InputStream and supplied encoding
`TSVFile(java.io.Reader stream)` Constructor.
`TSVFile(TSVFileTokenManager tm)` Constructor with generated Token Manager.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`disable_tracing()` Disable tracing.
`void`	`enable_tracing()` Enable tracing.
`ParseException`	`generateParseException()` Generate ParseException.
`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 TSV data.
`java.lang.String[][]`	`parseDoubleArray()` Parse TSV data into a table canvas.
`java.lang.String[]`	`parseRow()` Parses a row of the TSV data.
`void`	`parseTSV(TableCanvas table)` Parse TSV data into a table canvas.
`static void`	`readFile(TableCanvas table, java.io.Reader currentFile, boolean overwrite, boolean forceall)` Reads TSV data from a Reader object into a table canvas.
`static java.lang.String[][]`	`readTSV(java.io.Reader currentFile)` Reads TSV data from a Reader object into a 2D string array.
`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.
`void`	`ReInit(TSVFileTokenManager tm)` Reinitialise.
`static void`	`writeFile(java.lang.Appendable writer, java.lang.String[][] data)` Writes a 2D string array as TSV 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.
  - TSV_FILTER
```
public static final javax.swing.filechooser.FileFilter TSV_FILTER
```
    TSV file format filter (for file chooser objects). This file filter will determine which files in a file chooser are TSV (tab separated values) files, based on their file extension.
  - token_source
```
public TSVFileTokenManager token_source
```
    Generated Token Manager.
  - token
```
public Token token
```
    Current token.
  - jj_nt
```
public Token jj_nt
```
    Next token.
- Constructor Detail
  - TSVFile
```
public TSVFile(java.io.InputStream stream)
```
    Constructor with InputStream.
  - TSVFile
```
public TSVFile(java.io.InputStream stream,
               java.lang.String encoding)
```
    Constructor with InputStream and supplied encoding
  - TSVFile
```
public TSVFile(java.io.Reader stream)
```
    Constructor.
  - TSVFile
```
public TSVFile(TSVFileTokenManager tm)
```
    Constructor with generated Token Manager.
- Method Detail
  - 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 TSV file. Otherwise, the function will return false.
    
    Parameters:
    
    test - the reader to attempt to detect the format of.
    
    Returns:
    
    whether the format is a TSV file.
  - readFile
```
public static void readFile(TableCanvas table,
                            java.io.Reader currentFile,
                            boolean overwrite,
                            boolean forceall)
                     throws java.io.IOException
```
    Reads TSV data from a Reader object into a table canvas.
    
    Parameters:
    
    table - the table canvas to read the TSV file into.
    
    currentFile - the Reader object to parsed the TSV data from.
    
    overwrite - whether to overwrite the currently selected content in the table canvas with the data parsed by this function.
    
    Throws:
    
    java.io.IOException - thrown if there is any exception while reading from the Reader object.
  - readTSV
```
public static java.lang.String[][] readTSV(java.io.Reader currentFile)
                                    throws java.io.IOException
```
    Reads TSV 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 TSV 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 TSV 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 TSV data to.
    
    data - the 2D string array to parse into TSV data.
    
    Throws:
    
    java.io.IOException - thrown if there is any exception while writing to the Appendable object.
  - parseTSV
```
public final void parseTSV(TableCanvas table)
                    throws ParseException
```
    Parse TSV 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 TSV 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.
    
    Parameters:
    
    table - the table canvas to parse the data into.
    
    Throws:
    
    ParseException
  - parseRow
```
public final java.lang.String[] parseRow()
                                  throws ParseException
```
    Parses a row of the TSV 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 TSV 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(TSVFileTokenManager 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.

Class TSVFile

Field Summary

Fields inherited from interface org.biolegato.tables.TSVFileConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EST

DBL_EST

TSV_FILTER

token_source

token

jj_nt

Constructor Detail

TSVFile

TSVFile

TSVFile

TSVFile

Method Detail

isFormat

readFile

readTSV

writeFile

parseTSV

parseDoubleArray

parseRow

parseColumn

ReInit

ReInit

ReInit

ReInit

getNextToken

getToken

generateParseException

enable_tracing

disable_tracing