Package gov.nasa.pds.label.object
Class TableObject
java.lang.Object
gov.nasa.pds.label.object.DataObject
gov.nasa.pds.label.object.TableObject
public class TableObject extends DataObject
Implements an object that represents a table in a PDS
product. The table may be binary, character, or delimited.
-
Constructor Summary
Constructors Constructor Description TableObject(File parentDir, File fileObject, Object tableObject, long offset, long size)Creates a new instance of the table object.TableObject(URL parentDir, File fileObject, Object tableObject, long offset, long size)Creates a new instance of the table object. -
Method Summary
Modifier and Type Method Description FieldDescription[]getFields()Gets the field descriptions for fields in the table.TableRecordgetRecord(int index, boolean keepQuotationsFlag)Gets access to the table record given the index.TableRecordreadNext()Reads the next record from the data file.Methods inherited from class gov.nasa.pds.label.object.DataObject
closeChannel, getChannel, getDataFile, getInputStream, getOffset, getSize, setSize
-
Constructor Details
-
TableObject
public TableObject(File parentDir, File fileObject, Object tableObject, long offset, long size) throws ExceptionCreates a new instance of the table object.- Parameters:
parentDir- the parent directory for the table objectfileObject- the file object describing the data filetableObject- the table object describing the tableoffset- the offset of the table object within the data filesize- the size of the table object, in bytes- Throws:
Exception- if there is any error accessing the table
-
TableObject
public TableObject(URL parentDir, File fileObject, Object tableObject, long offset, long size) throws ExceptionCreates a new instance of the table object.- Parameters:
parentDir- the parent directory for the table objectfileObject- the file object describing the data filetableObject- the table object describing the tableoffset- the offset of the table object within the data filesize- the size of the table object, in bytes- Throws:
Exception- if there is any error accessing the table
-
-
Method Details
-
getFields
Gets the field descriptions for fields in the table.- Returns:
- an array of field descriptions
-
readNext
Reads the next record from the data file.- Returns:
- the next record, or null if no further records.
- Throws:
IOException- if there is an error reading from the data filecom.opencsv.exceptions.CsvValidationException
-
getRecord
public TableRecord getRecord(int index, boolean keepQuotationsFlag) throws IllegalArgumentException, IOException, com.opencsv.exceptions.CsvValidationExceptionGets 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 numberIOException- if there is an error reading from the data filecom.opencsv.exceptions.CsvValidationException
-