Package nom.tam.util

Interface DataTable

All Known Implementing Classes:

ColumnTable

public interface DataTable

A non FITS-specific interface for generic table data access. For a FITS-specific interface see TableData.

Note, that this interface is the little brother to TableData, with nearly identical method signatures. But, there are differences too, such as the type of argument of setting row data, and when and what excpetions are thrown. The other one also defines some further methods. Overall it would have been a more prudent design to consolidate the two interfaces but this is what we have so we stick to it. However, mabe this is something an upcoming major release may address...

See Also:

• TableData

Method Summary

Modifier and Type	Method	Description
Object	getColumn(int column)	Returns the data for a particular column in as an array of elements.
Object	getElement(int row, int col)	Returns the data element in this table
int	getNCols()	Returns the number of columns contained in this table.
int	getNRows()	Returns the number of rows contained in this table.
Object	getRow(int row)	Indexed access to data by row
void	setColumn(int column, Object newColumn)	Sets new data for a table column.
void	setElement(int row, int col, Object newElement)	Sets new data element in this table
void	setRow(int row, Object newRow)	Sets new data for a table row

Method Details

getColumn

Object getColumn(int column)

Returns the data for a particular column in as an array of elements. See TableData.addColumn(Object) for more information about the format of data elements in general.

Parameters:

column - The 0-based column index.

Returns:

an array of primitives (for scalar columns), or else an Object[] array, or possibly null

See Also:

• setColumn(int, Object)
• getElement(int, int)
• getNCols()

getElement

Object getElement(int row,
 int col)

Returns the data element in this table

Parameters:

row - the row index of the element

col - the column index of the element

Returns:

the object to store at the specified row, col in the table.

See Also:

• setElement(int, int, Object)
• getNRows()
• getNCols()

getNCols

int getNCols()

Returns the number of columns contained in this table.

Returns:

the current number of columns in the table.

See Also:

• getNRows()
• getColumn(int)
• setColumn(int, Object)

getNRows

int getNRows()

Returns the number of rows contained in this table.

Returns:

the current number of rows in the table.

See Also:

• getNCols()
• getRow(int)
• setRow(int, Object)

getRow

Object getRow(int row)

Indexed access to data by row

Parameters:

row - the row index

Returns:

an object containing the row data (for all column) of the specified row, or possubly null.

See Also:

• getNRows()
• setRow(int, Object)
• getColumn(int)
• getElement(int, int)

setColumn

void setColumn(int column,
 Object newColumn)
        throws TableException

Sets new data for a table column. See TableData.addColumn(Object) for more information about the expected column data format.

Parameters:

column - the column index

newColumn - an object containing the new column data (for all rows) of the specified column.

Throws:

TableException - if the table could not be modified

See Also:

• getNCols()
• getColumn(int)
• setRow(int, Object)
• setElement(int, int, Object)

setElement

void setElement(int row,
 int col,
 Object newElement)
         throws TableException

Sets new data element in this table

Parameters:

row - the row index of the element

col - the column index of the element

newElement - the object to store at the specified row, col in the table.

Throws:

TableException - if the table could not be modified

See Also:

• getElement(int, int)
• getNRows()
• getNCols()

setRow

void setRow(int row,
 Object newRow)
     throws TableException

Sets new data for a table row

Parameters:

row - the column index

newRow - an object containing the new row data (for all columns) of the specified row.

Throws:

TableException - if the table could not be modified

See Also:

• getNRows()
• getRow(int)
• setColumn(int, Object)
• setElement(int, int, Object)