Package gov.nasa.pds.objectAccess

Class TableReader

java.lang.Object

gov.nasa.pds.objectAccess.TableReader

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

RawTableReader

public class TableReader
extends Object
implements Closeable

The TableReader class defines methods for reading table records.

Field Summary

Fields

Modifier and Type	Field	Description
protected ByteWiseFileAccessor	accessor
protected DataObjectLocation	dataObjectLocation

Constructor Summary

Constructors

Constructor	Description
TableReader(Object table, File dataFile)
TableReader(Object table, URL dataFile)	Constructs a TableReader instance for reading records from a data file associated with a table object.
TableReader(Object table, URL dataFile, boolean checkSize)
TableReader(Object table, URL dataFile, boolean checkSize, boolean readEntireFile)
TableReader(Object table, URL dataFile, DataObjectLocation location, boolean checkSize, boolean readEntireFile, boolean keepQuotationsFlag)
TableReader(Object table, URL dataFile, DataObjectLocation location, boolean checkSize, boolean readEntireFile, boolean keepQuotationsFlag, RandomAccessFile raf, InputStream inputStream)	Constructs a TableReader instance for reading records from a data file associated with a table object.

Method Summary

Modifier and Type	Method	Description
void	close()
ByteWiseFileAccessor	getAccessor()
TableAdapter	getAdapter()
long	getCurrentRow()
DataObjectLocation	getDataObjectLocation()
Map<String,Integer>	getFieldMap()
FieldDescription[]	getFields()	Gets the field descriptions for fields in the table.
InputStream	getInputStream()
long	getOffset()
TableRecord	getRecord(int index)	Gets access to the table record given the index.
TableRecord	getRecord(long index, boolean keepQuotationsFlag)	Gets access to the table record given the index.
long	getRecordSize(URL dataFile, Object table)
TableRecord	readNext()	Reads the next record from the data file.
void	setCurrentRow(int row)	Sets the current row.
void	setCurrentRow(long row)	Sets the current row.
void	setDataObjectLocation(DataObjectLocation dataObjectLocation)

Methods inherited from class java.lang.Object

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

Field Details

accessor

protected ByteWiseFileAccessor accessor

dataObjectLocation

protected DataObjectLocation dataObjectLocation

Constructor Details

TableReader

public TableReader(Object table,
 File dataFile)
            throws Exception

Throws:

Exception

TableReader

public TableReader(Object table,
 URL dataFile)
            throws Exception

Constructs a TableReader instance for reading records from a data file associated with a table object.

Parameters:

table - a table object

dataFile - an input data file

Throws:

NullPointerException - if table offset is null

Exception

TableReader

public TableReader(Object table,
 URL dataFile,
 boolean checkSize)
            throws InvalidTableException,
Exception

Throws:

InvalidTableException

Exception

TableReader

public TableReader(Object table,
 URL dataFile,
 boolean checkSize,
 boolean readEntireFile)
            throws InvalidTableException,
Exception

Throws:

InvalidTableException

Exception

TableReader

public TableReader(Object table,
 URL dataFile,
 DataObjectLocation location,
 boolean checkSize,
 boolean readEntireFile,
 boolean keepQuotationsFlag)
            throws InvalidTableException,
Exception

Throws:

InvalidTableException

Exception

TableReader

public TableReader(Object table,
 URL dataFile,
 DataObjectLocation location,
 boolean checkSize,
 boolean readEntireFile,
 boolean keepQuotationsFlag,
 RandomAccessFile raf,
 InputStream inputStream)
            throws InvalidTableException,
Exception

Constructs a TableReader instance for reading records from a data file associated with a table object.

Parameters:

table - a table object

dataFile - an input data file

checkSize - check that the size of the data file is equal to the size of the table (length * records) + offset.

readEntireFile - flag to read an entire file

keepQuotationsFlag - flag to keep the starting/ending quotes

Throws:

NullPointerException - if table offset is null

InvalidTableException

Exception

Method Details

getAdapter

public TableAdapter getAdapter()

getFields

public FieldDescription[] getFields()

Gets the field descriptions for fields in the table.

Returns:

an array of field descriptions

getFieldMap

public Map<String,Integer> getFieldMap()

Returns:

the field map.

readNext

public TableRecord readNext()
                     throws IOException,
com.opencsv.exceptions.CsvValidationException

Reads the next record from the data file.

Returns:

the next record, or null if no further records.

Throws:

com.opencsv.exceptions.CsvValidationException

IOException

getRecord

public TableRecord getRecord(int index)
                      throws IllegalArgumentException,
IOException,
com.opencsv.exceptions.CsvValidationException

Gets access to the table record given the index. The current row is set to this index, thus, subsequent call to readNext() gets the next record from this position.

Parameters:

index - the record index (1-relative)

Returns:

an instance of TableRecord

Throws:

IllegalArgumentException - if index is greater than the record number

com.opencsv.exceptions.CsvValidationException

IOException

getRecord

public TableRecord getRecord(long index,
 boolean keepQuotationsFlag)
                      throws IllegalArgumentException,
IOException,
com.opencsv.exceptions.CsvValidationException

Gets access to the table record given the index. The current row is set to this index, thus, subsequent call to readNext() gets the next record from this position.

Parameters:

index - the record index (1-relative)

keepQuotationsFlag - flag to keep the starting/ending quotes or not.

Returns:

an instance of TableRecord

Throws:

IllegalArgumentException - if index is greater than the record number

com.opencsv.exceptions.CsvValidationException

IOException

setCurrentRow

public void setCurrentRow(int row)

Sets the current row.

Parameters:

row - The row to set.

setCurrentRow

public void setCurrentRow(long row)

Sets the current row.

Parameters:

row - The row to set.

getCurrentRow

public long getCurrentRow()

Returns:

the current row.

getAccessor

public ByteWiseFileAccessor getAccessor()

getInputStream

public InputStream getInputStream()

getRecordSize

public long getRecordSize(URL dataFile,
 Object table)
                   throws Exception

Returns:

the size of record (i.e. number of lines)

Throws:

Exception

getOffset

public long getOffset()

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

getDataObjectLocation

public DataObjectLocation getDataObjectLocation()

setDataObjectLocation

public void setDataObjectLocation(DataObjectLocation dataObjectLocation)