omero::api::IQuery

Overview

[ "ami", "amd" ] interface IQuery extends ServiceInterface

See IQuery.html

Operation Index

get
find
findAll
findByExample
findAllByExample
findByString
findAllByString
findByQuery
findAllByQuery
findAllByFullText
projection: Return a sequence of RType sequences.
refresh

Operations

model::IObject get(string klass, long id) throws ServerError

model::IObject find(string klass, long id) throws ServerError

IObjectList findAll(string klass, sys::Filter filter) throws ServerError

model::IObject findByExample(model::IObject example) throws ServerError

IObjectList findAllByExample(model::IObject example, sys::Filter filter) throws ServerError

model::IObject findByString(string klass, string field, string value) throws ServerError

IObjectList findAllByString(string klass, string field, string value, bool caseSensitive, sys::Filter filter) throws ServerError

model::IObject findByQuery(string query, sys::Parameters params) throws ServerError

IObjectList findAllByQuery(string query, sys::Parameters params) throws ServerError

IObjectList findAllByFullText(string klass, string query, sys::Parameters params) throws ServerError

RTypeSeqSeq projection(string query, sys::Parameters params) throws ServerError

Return a sequence of RType sequences.

Each element of the outer sequence is one row in the return value. Each element of the inner sequence is one column specified in the HQL.

model::IObject instances are returned wrapped in an omero::rtype::RObject instance. Primitives are mapped to the expected RType subclass. Types without an RType mapper if returned will throw an exception if present in the select except where a manual conversion is present on the server. This includes:

model::Permissions instances are serialized to an RMap containing the keys: perms, canAnnotate, canEdit, canLink, canDelete
The quantity types like model::Length are serialized to an RMap containing the keys: value, unit, symbol

As with SQL, if an aggregation statement is used, a group by clause must be added.

Examples:

select i.name, i.description from Image i where i.name like '%.dv'

select tag.textValue, tagset.textValue from TagAnnotation tag join tag.annotationLinks l join l.child tagset

select p.pixelsType.value, count(p.id) from Pixel p group by p.pixelsType.value

model::IObject refresh(model::IObject iObject) throws ServerError

Home

Index