omero.gateway.model

Class TableData

java.lang.Object

omero.gateway.model.TableData

public class TableData
extends Object

A simple data 'container' for an OMERO.table

Author:

Dominik Lindner d.lindner@dundee.ac.uk

Constructor Summary

Constructors

Constructor and Description
TableData(List<TableDataColumn> columns, List<List<Object>> data) Creates a new instance
TableData(TableDataColumn[] columns, Object[][] data) Creates a new instance

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
TableDataColumn[]	getColumns() Get the headers
Object[][]	getData() Get the data in form Object['column index']['row data']
long	getNumberOfRows()
long	getOffset() Get the row offset (if this TableData represents only a subset of the original table)
long	getOriginalFileId() Get the original file id
int	hashCode()
boolean	isCompleted()
boolean	isEmpty()
void	setCompleted() Manually set completed state (sets the numberOfRows to the last row in the data array)
void	setNumberOfRows(long numberOfRows) Set the total number of rows in the original table
void	setOffset(long offset) Set the row offset (if this TableData represents only a subset of the original table)
void	setOriginalFileId(long originalFileId) Set the originalfile id
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TableData

public TableData(List<TableDataColumn> columns,
                 List<List<Object>> data)

Creates a new instance

Parameters:

columns - The column definitions

data - The data in form of List of columns

TableData

public TableData(TableDataColumn[] columns,
                 Object[][] data)

Creates a new instance

Parameters:

columns - The column definitions

data - The data in form data['column index']['row data']

Method Detail

getColumns

public TableDataColumn[] getColumns()

Get the headers

Returns:

See above

getData

public Object[][] getData()

Get the data in form Object['column index']['row data']

Returns:

See above

getOffset

public long getOffset()

Get the row offset (if this TableData represents only a subset of the original table)

Returns:

See above

getOriginalFileId

public long getOriginalFileId()

Get the original file id

Returns:

See above

setOriginalFileId

public void setOriginalFileId(long originalFileId)

Set the originalfile id

Parameters:

originalFileId - The originalfile id

setOffset

public void setOffset(long offset)

Set the row offset (if this TableData represents only a subset of the original table)

Parameters:

offset - The row offset

isEmpty

public boolean isEmpty()

Returns:

true if this TableData object doesn't contain any data, false if it does contain data.

isCompleted

public boolean isCompleted()

Returns:

true if the last available row is contained, false if there's more data available in the original table

setCompleted

public void setCompleted()

Manually set completed state (sets the numberOfRows to the last row in the data array)

getNumberOfRows

public long getNumberOfRows()

Returns:

The total number of rows in the original table (this doesn't have to match data[x].length, depending on how many rows are loaded)

setNumberOfRows

public void setNumberOfRows(long numberOfRows)

Set the total number of rows in the original table

Parameters:

numberOfRows - See above

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object