Package ca.spatial.util

Class CSVTableReader

java.lang.Object

ca.spatial.util.CSVTableReader

All Implemented Interfaces:

TableReader

public class CSVTableReader
extends Object
implements TableReader

Read data from a CSV file. Forward-only cursor operations are supported.

Field Summary

Fields

Modifier and Type	Field	Description
static int	MAX_COLUMNS	The maximum number of data columns allowed.
static int	MAX_RECORD_LENGTH	The maximum record size allowed.

Constructor Summary

Constructors

Constructor	Description
CSVTableReader(File file)
CSVTableReader(File file, String reselect)
CSVTableReader(String filename)
CSVTableReader(String filename, String reselect)

Method Summary

Modifier and Type	Method	Description
boolean	assertColumns(String[] columns)	Check to see that the desired columns are present
void	close()	Close the cursor and dispose of resources.
static void	copyTable(TableReader reader, String outputName)	Copy a table to a text file, in simple CSV format
byte[]	digest()	Get the SHA1 digest for this input stream.
static boolean	exists(File file)
String	getColumnName(int index)	Get the name of a column.
String[]	getColumnNames()	Get an array of all column labels
int	getColumnPos(String label)	Get the position of a given column name
String	getField(int index)	Get the contents of a field, by position.
String	getField(String label)	Get the contents of a field, by name.
boolean	getNext()	Advance the cursor to the next record.
int	getNumberOfColumns()	Get the number of columns
static boolean	isGZIP(File file)
TableReader	open()	Prepare the cursor for use
void	setTask(Task task)	Set a Task object to report on progress

Methods inherited from class java.lang.Object

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

Field Details

MAX_COLUMNS

public static final int MAX_COLUMNS

The maximum number of data columns allowed.

See Also:

Constant Field Values

MAX_RECORD_LENGTH

public static final int MAX_RECORD_LENGTH

The maximum record size allowed.

See Also:

Constant Field Values

Constructor Details

CSVTableReader

public CSVTableReader(String filename)

CSVTableReader

public CSVTableReader(String filename,
 String reselect)

CSVTableReader

public CSVTableReader(File file)

CSVTableReader

public CSVTableReader(File file,
 String reselect)

Method Details

open

public TableReader open()
                 throws TableReaderException

Description copied from interface: TableReader

Prepare the cursor for use

Specified by:

open in interface TableReader

Throws:

TableReaderException

exists

public static boolean exists(File file)

isGZIP

public static boolean isGZIP(File file)

getColumnName

public String getColumnName(int index)

Description copied from interface: TableReader

Get the name of a column.

Specified by:

getColumnName in interface TableReader

getColumnNames

public String[] getColumnNames()

Description copied from interface: TableReader

Get an array of all column labels

Specified by:

getColumnNames in interface TableReader

getNumberOfColumns

public int getNumberOfColumns()

Description copied from interface: TableReader

Get the number of columns

Specified by:

getNumberOfColumns in interface TableReader

getColumnPos

public int getColumnPos(String label)

Description copied from interface: TableReader

Get the position of a given column name

Specified by:

getColumnPos in interface TableReader

assertColumns

public boolean assertColumns(String[] columns)

Description copied from interface: TableReader

Check to see that the desired columns are present

Specified by:

assertColumns in interface TableReader

getField

public String getField(String label)

Description copied from interface: TableReader

Get the contents of a field, by name. Returns null if the field does not exist or an error occurs.

Specified by:

getField in interface TableReader

getField

public String getField(int index)

Description copied from interface: TableReader

Get the contents of a field, by position. Returns null if the field does not exist or an error occurs.

Specified by:

getField in interface TableReader

getNext

public boolean getNext()
                throws TableReaderException

Description copied from interface: TableReader

Advance the cursor to the next record.

Specified by:

getNext in interface TableReader

Returns:

true if the another record is available in the cursor.

Throws:

TableReaderException

close

public void close()

Description copied from interface: TableReader

Close the cursor and dispose of resources.

Specified by:

close in interface TableReader

setTask

public void setTask(Task task)

Description copied from interface: TableReader

Set a Task object to report on progress

Specified by:

setTask in interface TableReader

copyTable

public static void copyTable(TableReader reader,
 String outputName)
                      throws IOException,
TableReaderException

Copy a table to a text file, in simple CSV format

Throws:

IOException

TableReaderException

digest

public byte[] digest()

Description copied from interface: TableReader

Get the SHA1 digest for this input stream.

Specified by:

digest in interface TableReader