ome.api
Interface IResults

All Superinterfaces:
ServiceInterface

public interface IResults
extends ServiceInterface

Provides methods for storing, quering, and retrieving analysis results. See http://cvs.openmicroscopy.org.uk/tiki/tiki-index.php?page=BostonApiSuggestions for more information. Note: Primitive operations will most likely be moved out to a separate PrimitiveResults interface.

Since:
OMERO3.0
Version:
1.0 (Internal version: $Revision$ $Date$)
Author:
Chris Allan      callan@blackcat.ca,
Jean-Marie Burel      j.burel@dundee.ac.uk,
Josh Moore      josh.moore@gmx.de,
Sheldon Change      sheldons@mit.edu,
Tony Sceflo      tonys@mit.edu

Nested Class Summary
static class IResults.PixelSet
           
static interface IResults.Result
           
 
Method Summary
 Set findPixelSets(int moduleId, Class type, int id, Map options)
          finding PixelSets.
 int[] findPixelSetsPrimitive(int moduleId, String type, int id, Map options)
           
 IResults.Result[] parseData(Map data)
          server-side parsing of data maps
 IResults.Result[] queryResults(Class resultType, Set pixelSetIds, String[] orderBy, boolean[] ascending, int limit, int offset)
          querying for IResults
 Map[] queryResultsPrimitive(String resultType, int[] pixelSetIds, String[] orderBy, boolean[] ascending, int limit, int offset)
           
 Set retrieveResult(int pixelSetId, List keys)
          retrieving data for PixelSet
 Map retrieveResultPrimitive(int pixelSetId, String[] keys)
           
 Set[] retrieveResultsBulk(int[] pixelSetIds, List[] keys)
           
 Map[] retrieveResultsBulkPrimitive(int[] pixelSetIds, String[][] keys)
           
 IResults.PixelSet store(int moduleId, Class type, int typeId, IResults.Result data)
          storing results.
 IResults.PixelSet[] storeMultiBulk(int moduleId, Class[] types, int[] typeIds, IResults.Result[] data)
           
 int[] storeMultiBulkPrimitive(int moduleId, String[] types, int[] typeIds, Map[] data)
           
 int storePrimitive(int moduleId, String type, int typeId, Map data)
           
 IResults.PixelSet storeSingleBulk(int moduleId, Class type, int typeId, IResults.Result[] data)
           
 int storeSingleBulkPrimitive(int moduleId, Class type, int typeId, Map[] data)
           
 

Method Detail

parseData

IResults.Result[] parseData(Map data)
server-side parsing of data maps

Parameters:
Map - of data. Keys are of the form: "ClassName:fieldName" ClassName must be unique within the map.
Returns:
created Result objects
To do:
is this restriction necessary

store

IResults.PixelSet store(int moduleId,
                        Class type,
                        int typeId,
                        IResults.Result data)
storing results.

Returns:
PixelSet created by attachment

storePrimitive

int storePrimitive(int moduleId,
                   String type,
                   int typeId,
                   Map data)

storeSingleBulk

IResults.PixelSet storeSingleBulk(int moduleId,
                                  Class type,
                                  int typeId,
                                  IResults.Result[] data)

storeSingleBulkPrimitive

int storeSingleBulkPrimitive(int moduleId,
                             Class type,
                             int typeId,
                             Map[] data)

storeMultiBulk

IResults.PixelSet[] storeMultiBulk(int moduleId,
                                   Class[] types,
                                   int[] typeIds,
                                   IResults.Result[] data)

storeMultiBulkPrimitive

int[] storeMultiBulkPrimitive(int moduleId,
                              String[] types,
                              int[] typeIds,
                              Map[] data)

findPixelSets

Set findPixelSets(int moduleId,
                  Class type,
                  int id,
                  Map options)
finding PixelSets. This users the type and id paramters to create a temporary PixelSet and searches for a similar, existing PixelSet In the case of Image,Pixel, or Roi5d, this should work fairly exactly. (unless DefaultPixel has changed for Image). For Project, Dataset, and other hierarchies, your mileage may vary.

Parameters:
id - of the module which created the PixelSet
type - to use as the source for this PixelSet
id - of that type
Map - of options. resultType=String or Class filtering on desired Result.class experimenter=id filtering on desired original result creator exactness=double percentage identical that two PixelSets must be (Whew!)
Returns:
Set of PixelSet ids.

findPixelSetsPrimitive

int[] findPixelSetsPrimitive(int moduleId,
                             String type,
                             int id,
                             Map options)

retrieveResult

Set retrieveResult(int pixelSetId,
                   List keys)
retrieving data for PixelSet

Parameters:
id - of a PixelSet
list - of keys; in format similar to store* methods
Returns:
a set of Result implementation

retrieveResultPrimitive

Map retrieveResultPrimitive(int pixelSetId,
                            String[] keys)

retrieveResultsBulk

Set[] retrieveResultsBulk(int[] pixelSetIds,
                          List[] keys)

retrieveResultsBulkPrimitive

Map[] retrieveResultsBulkPrimitive(int[] pixelSetIds,
                                   String[][] keys)

queryResults

IResults.Result[] queryResults(Class resultType,
                               Set pixelSetIds,
                               String[] orderBy,
                               boolean[] ascending,
                               int limit,
                               int offset)
querying for IResults

Parameters:
resultType - determines the table to be queried; could be the interface Result but then careful with orderBy
pixelSetIds - restricts the search to certain PixelSets pixel_set_id in (1,2,3,....); can be null
orderBy - field names on the table resultType; can be null
ascending - true="asc", false="desc"; must be the same size as orderBy; can be byll
limit - as in SQL; negative implies disabled
offset - as in SQL; negative implies disabled
keys - fields to be transported; currently unavailable
where - THIS FIELD NEEDS SOME MORE THOUGHT; currently unavailable

queryResultsPrimitive

Map[] queryResultsPrimitive(String resultType,
                            int[] pixelSetIds,
                            String[] orderBy,
                            boolean[] ascending,
                            int limit,
                            int offset)


OmeroJava Api

Version: 4.3.4-dbcbce5a-b4

Copyright © 2009 The University of Dundee. All Rights Reserved.