omero::grid::Table
Overview
[ "ami" ]
interface Table
Operation Index
- getOriginalFile
-
- getHeaders
-
Returns empty columns.
- getNumberOfRows
-
Return the number of rows of a table.
- getWhereList
-
Run a query on a table.
- readCoordinates
-
Read a set of entire rows in the table.
- read
-
Read a subset of columns and consecutive rows from a table.
- slice
-
Read a subset of columns and consecutive rows from a table.
- addData
-
- update
-
Allows the user to modify a Data instance passed back
from a query method and have the values modified.
- getAllMetadata
-
- getMetadata
-
- setAllMetadata
-
- setMetadata
-
- initialize
-
Initializes the structure based on
- addColumn
-
Adds a column and returns the position index of the new column.
- delete
-
- close
-
Operations
Returns empty columns.
long getNumberOfRows() throws ServerError
Return the number of rows of a table.
api::LongArray getWhereList(string condition, RTypeDict variables, long start, long stop, long step) throws ServerError
Run a query on a table.
The meaning of the start and stop parameters are the same as in the
built-in Python slices. Setting start, step and stop to 0 is interpreted
as running the query against all rows.
Parameters
- condition
-
A query string - see the
tables query language
for more details.
- variables
-
A mapping of strings and variable values to be substituted into
condition. This can often be left empty.
- start
-
The start of the range of rows to consider.
- stop
-
The end of the range of rows to consider.
- step
-
The stepping interval of the range of rows to consider. Set to 0
to disable stepping.
Return Value
A list of row indices matching the condition which can be passed as a
parameter of readCoordinates or slice.
Read a set of entire rows in the table.
Parameters
- rowNumbers
-
A list of row indices to be retrieved from the table.
The indices may be non-consecutive and must contain at least one element
or an ApiUsageException will be thrown.
Return Value
The requested rows as a Data object. The results
will be returned in the same order as the row indices.
Read a subset of columns and consecutive rows from a table.
The meaning of the start and stop parameters are the same as in the
built-in Python slices. Setting both start and stop to 0 is
interpreted as returning all rows.
Parameters
- colNumbers
-
A list of column indices to be retrieved from the table.
The indices may be non-consecutive and must contain at least one element
or an ApiUsageException will be thrown.
- start
-
The first element of the range of rows to retrieve. Must be non null.
- stop
-
The stop of the range of rows to retrieve. Must be non null.
Return Value
The requested columns and rows as a Data object.
Read a subset of columns and consecutive rows from a table.
Parameters
- colNumbers
-
A list of column indices to be retrieved from the table.
The indices may be non-consecutive. If set to empty or null, all columns
will be returned.
- rowNumbers
-
A list of row indices to be retrieved from the table.
The indices may be non-consecutive. If set empty or null, all rows will
be returned.
Return Value
The requested columns and rows as a Data object.
The results will be returned in the same order as the column and row indices.
void update(Data modifiedData) throws ServerError
Allows the user to modify a Data instance passed back
from a query method and have the values modified. It
is critical that the {@code Data.lastModification} and the
{@code Data.rowNumbers} fields are properly set. An exception
will be thrown if the data has since been modified.
void setMetadata(string key, RType value) throws ServerError
Initializes the structure based on
Adds a column and returns the position index of the new column.
