omero.grid

Interface _TableOperationsNC

All Known Subinterfaces:

Table

All Known Implementing Classes:

_TableDisp, _TableTie

public interface _TableOperationsNC

Method Summary

Modifier and Type	Method and Description
int	addColumn(Column col) Adds a column and returns the position index of the new column.
void	addData(Column[] cols)
void	close()
void	delete()
java.util.Map<java.lang.String,RType>	getAllMetadata()
Column[]	getHeaders() Returns empty columns.
RType	getMetadata(java.lang.String key)
long	getNumberOfRows()
OriginalFile	getOriginalFile()
long[]	getWhereList(java.lang.String condition, java.util.Map<java.lang.String,RType> variables, long start, long stop, long step) http://www.pytables.org/docs/manual/apb.html Leave all three of start, stop, step to 0 to disable.
void	initialize(Column[] cols) Initializes the structure based on
Data	read(long[] colNumbers, long start, long stop) http://www.pytables.org/docs/manual/ch04.html#Table.read
Data	readCoordinates(long[] rowNumbers) Read the given rows of data.
void	setAllMetadata(java.util.Map<java.lang.String,RType> dict)
void	setMetadata(java.lang.String key, RType value)
Data	slice(long[] colNumbers, long[] rowNumbers) Simple slice method which will return only the given columns and rows in the order supplied.
void	update(Data modifiedData) Allows the user to modify a Data instance passed back from a query method and have the values modified.

Method Detail

getOriginalFile

OriginalFile getOriginalFile()
                      throws ServerError

Throws:

ServerError

getHeaders

Column[] getHeaders()
             throws ServerError

Returns empty columns.

Throws:

ServerError

getNumberOfRows

long getNumberOfRows()
              throws ServerError

Throws:

ServerError

getWhereList

long[] getWhereList(java.lang.String condition,
                    java.util.Map<java.lang.String,RType> variables,
                    long start,
                    long stop,
                    long step)
             throws ServerError

http://www.pytables.org/docs/manual/apb.html Leave all three of start, stop, step to 0 to disable. TODO:Test effect of returning a billion rows matching getWhereList()

Throws:

ServerError

readCoordinates

Data readCoordinates(long[] rowNumbers)
              throws ServerError

Read the given rows of data.

Parameters:

rowNumbers - must contain at least one element or an ApiUsageException will be thrown.

Throws:

ServerError

read

Data read(long[] colNumbers,
          long start,
          long stop)
   throws ServerError

http://www.pytables.org/docs/manual/ch04.html#Table.read

Throws:

ServerError

slice

Data slice(long[] colNumbers,
           long[] rowNumbers)
    throws ServerError

Simple slice method which will return only the given columns and rows in the order supplied. If colNumbers or rowNumbers is empty (or None), then all values will be returned.

Python examples:

 data = table.slice(None, None)
 assert len(data.rowNumbers) == table.getNumberOfRows()

 data = table.slice(None, \[3,2,1])
 assert data.rowNumbers == \[3,2,1]
 

Throws:

ServerError

addData

void addData(Column[] cols)
      throws ServerError

Throws:

ServerError

update

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 Data.lastModification and the Data.rowNumbers fields are properly set. An exception will be thrown if the data has since been modified.

Throws:

ServerError

getAllMetadata

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

Throws:

ServerError

getMetadata

RType getMetadata(java.lang.String key)
           throws ServerError

Throws:

ServerError

setAllMetadata

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

Throws:

ServerError

setMetadata

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

Throws:

ServerError

initialize

void initialize(Column[] cols)
         throws ServerError

Initializes the structure based on

Throws:

ServerError

addColumn

int addColumn(Column col)
       throws ServerError

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

Throws:

ServerError

delete

void delete()
     throws ServerError

Throws:

ServerError

close

void close()
    throws ServerError

Throws:

ServerError