gov.nasa.pds.objectAccess

Class TableReader

java.lang.Object

gov.nasa.pds.objectAccess.TableReader

public class TableReader
extends java.lang.Object

The TableReader class defines methods for reading table records.

Field Summary

Fields

Modifier and Type	Field and Description
protected ByteWiseFileAccessor	accessor

Constructor Summary

Constructors

Constructor and Description
TableReader(java.lang.Object table, java.io.File dataFile)
TableReader(java.lang.Object table, java.net.URL dataFile) Constructs a TableReader instance for reading records from a data file associated with a table object.
TableReader(java.lang.Object table, java.net.URL dataFile, boolean checkSize)
TableReader(java.lang.Object table, java.net.URL dataFile, boolean checkSize, boolean readEntireFile) Constructs a TableReader instance for reading records from a data file associated with a table object.

Method Summary

Modifier and Type	Method and Description
ByteWiseFileAccessor	getAccessor()
TableAdapter	getAdapter()
int	getCurrentRow()
java.util.Map<java.lang.String,java.lang.Integer>	getFieldMap()
FieldDescription[]	getFields() Gets the field descriptions for fields in the table.
TableRecord	getRecord(int index) Gets access to the table record given the index.
TableRecord	readNext() Reads the next record from the data file.
void	setCurrentRow(int row) Sets the current row.

Methods inherited from class java.lang.Object

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

Field Detail

accessor

protected ByteWiseFileAccessor accessor

Constructor Detail

TableReader

public TableReader(java.lang.Object table,
                   java.io.File dataFile)
            throws java.lang.Exception

Throws:

java.lang.Exception

TableReader

public TableReader(java.lang.Object table,
                   java.net.URL dataFile)
            throws java.lang.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:

java.lang.NullPointerException - if table offset is null

java.lang.Exception

TableReader

public TableReader(java.lang.Object table,
                   java.net.URL dataFile,
                   boolean checkSize)
            throws java.lang.Exception

Throws:

java.lang.Exception

TableReader

public TableReader(java.lang.Object table,
                   java.net.URL dataFile,
                   boolean checkSize,
                   boolean readEntireFile)
            throws java.lang.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.

Throws:

java.lang.NullPointerException - if table offset is null

java.lang.Exception

Method Detail

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 java.util.Map<java.lang.String,java.lang.Integer> getFieldMap()

Returns:

the field map.

readNext

public TableRecord readNext()
                     throws java.io.IOException

Reads the next record from the data file.

Returns:

the next record, or null if no further records.

Throws:

java.io.IOException

getRecord

public TableRecord getRecord(int index)
                      throws java.lang.IllegalArgumentException,
                             java.io.IOException

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:

java.lang.IllegalArgumentException - if index is greater than the record number

java.io.IOException

setCurrentRow

public void setCurrentRow(int row)

Sets the current row.

Parameters:

row - The row to set.

getCurrentRow

public int getCurrentRow()

Returns:

the current row.

getAccessor

public ByteWiseFileAccessor getAccessor()