Package omero.grid

Interface _TableOperations

All Known Subinterfaces:

Table

All Known Implementing Classes:

_TableDisp, _TableTie, TableCloserI

public interface _TableOperations

Method Summary

Modifier and Type	Method	Description
int	addColumn(Column col, Ice.Current __current)	Adds a column and returns the position index of the new column.
void	addData(Column[] cols, Ice.Current __current)
void	close(Ice.Current __current)
void	delete(Ice.Current __current)
java.util.Map<java.lang.String,RType>	getAllMetadata(Ice.Current __current)
Column[]	getHeaders(Ice.Current __current)	Returns empty columns.
RType	getMetadata(java.lang.String key, Ice.Current __current)
long	getNumberOfRows(Ice.Current __current)	Return the number of rows of a table.
OriginalFile	getOriginalFile(Ice.Current __current)
long[]	getWhereList(java.lang.String condition, java.util.Map<java.lang.String,RType> variables, long start, long stop, long step, Ice.Current __current)	Run a query on a table.
void	initialize(Column[] cols, Ice.Current __current)	Initializes the structure based on
Data	read(long[] colNumbers, long start, long stop, Ice.Current __current)	Read a subset of columns and consecutive rows from a table.
Data	readCoordinates(long[] rowNumbers, Ice.Current __current)	Read a set of entire rows in the table.
void	setAllMetadata(java.util.Map<java.lang.String,RType> dict, Ice.Current __current)
void	setMetadata(java.lang.String key, RType value, Ice.Current __current)
Data	slice(long[] colNumbers, long[] rowNumbers, Ice.Current __current)	Read a subset of columns and consecutive rows from a table.
void	update(Data modifiedData, Ice.Current __current)	Allows the user to modify a Data instance passed back from a query method and have the values modified.

Method Detail

getOriginalFile

OriginalFile getOriginalFile(Ice.Current __current)
                      throws ServerError

Throws:

ServerError

getHeaders

Column[] getHeaders(Ice.Current __current)
             throws ServerError

Returns empty columns.

Parameters:

__current - The Current object for the invocation.

Throws:

ServerError

getNumberOfRows

long getNumberOfRows(Ice.Current __current)
              throws ServerError

Return the number of rows of a table.

Parameters:

__current - The Current object for the invocation.

Throws:

ServerError

getWhereList

long[] getWhereList(java.lang.String condition,
                    java.util.Map<java.lang.String,RType> variables,
                    long start,
                    long stop,
                    long step,
                    Ice.Current __current)
             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.

__current - The Current object for the invocation.

Returns:

A list of row indices matching the condition which can be passed as a parameter of readCoordinates(long[], Ice.Current) or slice(long[], long[], Ice.Current).

Throws:

ServerError

readCoordinates

Data readCoordinates(long[] rowNumbers,
                     Ice.Current __current)
              throws ServerError

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.

__current - The Current object for the invocation.

Returns:

The requested rows as a Data object. The results will be returned in the same order as the row indices.

Throws:

ServerError

read

Data read(long[] colNumbers,
          long start,
          long stop,
          Ice.Current __current)
   throws ServerError

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.

__current - The Current object for the invocation.

Returns:

The requested columns and rows as a Data object.

Throws:

ServerError

slice

Data slice(long[] colNumbers,
           long[] rowNumbers,
           Ice.Current __current)
    throws ServerError

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.

__current - The Current object for the invocation.

Returns:

The requested columns and rows as a Data object. The results will be returned in the same order as the column and row indices.

Throws:

ServerError

addData

void addData(Column[] cols,
             Ice.Current __current)
      throws ServerError

Throws:

ServerError

update

void update(Data modifiedData,
            Ice.Current __current)
     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 Data.lastModification and the Data.rowNumbers fields are properly set. An exception will be thrown if the data has since been modified.

Parameters:

__current - The Current object for the invocation.

Throws:

ServerError

getAllMetadata

java.util.Map<java.lang.String,RType> getAllMetadata(Ice.Current __current)
                                                    throws ServerError

Throws:

ServerError

getMetadata

RType getMetadata(java.lang.String key,
                  Ice.Current __current)
           throws ServerError

Throws:

ServerError

setAllMetadata

void setAllMetadata(java.util.Map<java.lang.String,RType> dict,
                    Ice.Current __current)
             throws ServerError

Throws:

ServerError

setMetadata

void setMetadata(java.lang.String key,
                 RType value,
                 Ice.Current __current)
          throws ServerError

Throws:

ServerError

initialize

void initialize(Column[] cols,
                Ice.Current __current)
         throws ServerError

Initializes the structure based on

Parameters:

__current - The Current object for the invocation.

Throws:

ServerError

addColumn

int addColumn(Column col,
              Ice.Current __current)
       throws ServerError

Adds a column and returns the position index of the new column.

Parameters:

__current - The Current object for the invocation.

Throws:

ServerError

delete

void delete(Ice.Current __current)
     throws ServerError

Throws:

ServerError

close

void close(Ice.Current __current)
    throws ServerError

Throws:

ServerError