Version: 5.0.8-ice34-b60

OmeroBlitz Api

omero::api

Overview

module api

The omero::api module defines all the central verbs for working with OMERO.blitz.

Arguments and return values consist of those types defined in the other ice files available here. With no further custom code, it is possible to interoperate with OMERO.blitz simply via the definitions here. Start with the ServiceFactory definition at the end of this file.

Note: Using these types is significantly easier in combination with the JavaDocs of the OMERO.server, specifically the ome.api package. Where not further noted below, the follow mappings between ome.api argument types and omero::api argument types hold:

+-----------------------+------------------------+
|        ome.api        |      omero::api        |
+-----------------------+------------------------+
|java.lang.Class        |string                  |
+-----------------------+------------------------+
|java.util.Set          |java.util.List/vector   |
+-----------------------+------------------------+
|IPojo options (Map)    |omero::sys::ParamMap    |
+-----------------------+------------------------+
|If null needed         |omero::RType subclass   |
+-----------------------+------------------------+
|...                    |...                     |
+-----------------------+------------------------+

Module Index

delete: Exploratory Delete API for background processing of deletes.

Class Index

BufferedImage: Simple wrapper around an array of packed ints.
ResolutionDescription
RoiOptions: Specifies filters used when querying the ROIs.
RoiResult: Returned by most search methods.
RoiStats: Container for ShapeStats, one with the combined values, and one per shape.
Save
SaveRsp
ShapePoints: Contains a discrete representation of the geometry of an omero::model::Shape.
ShapeStats: Contains arrays, one entry per channel, of the statistics for a given shape.

Interface Index

ClientCallback: Primary callback interface for interaction between client and server session ("ServiceFactory").
Exporter: Stateful service for generating OME-XML or OME-TIFF from data stored in OMERO.
Gateway: High-level service which provides a single interface for most client activities.
Deprecated.
IAdmin: See IAdmin.html
IConfig: See IConfig.html
IContainer: See IContainer.html
IDelete: See IDelete.html
Deprecated.
ILdap: See ILdap.html
IMetadata: See IMetadata.html
IPixels: See IPixels.html
IProjection: See IProjection.html
IQuery: See IQuery.html
IRenderingSettings: See IRenderingSettings.html
IRepositoryInfo: See IRepositoryInfo.html
IRoi: Interface for working with regions of interest.
IScript: Utility service for managing and launching scripts for execution by the Processor API.
ISession: See ISession.html
IShare: See IShare.html
ITimeline: Service for the querying of OMERO metadata based on creation and modification time.
ITypes: See ITypes.html
IUpdate: See IUpdate.html
JobHandle: See JobHandle.html
MetadataStore: Server-side interface for import.
PyramidService
RawFileStore: See RawFileStore.html
RawPixelsStore: Binary data provider.
RenderingEngine: See RenderingEngine.html
Search: See Search.html
ServiceFactory: Starting point for all OMERO.blitz interaction.
ServiceInterface: Service marker similar to ome.api.ServiceInterface.
StatefulServiceInterface: Service marker for stateful services which permits the closing of a particular service before the destruction of the session.
ThumbnailStore: See ThumbnailStore.html

Sequence Index

AnnotationList
BoolArray
ByteArray
ByteArrayArray
ChecksumAlgorithmList
DatasetList
DoubleArray
DoubleArrayArray
DoubleArrayArrayArray
EventList
EventLogList
ExperimenterGroupList
ExperimenterList
FloatArray
FloatArrayArray
FloatArrayArrayArray
IObjectList
ImageList
IntegerArray
IntegerArrayArray
IntegerArrayArrayArray
IntegerList
LogicalChannelList
LongArray
LongArrayArray
LongList
OriginalFileList
PixelsList
PixelsTypeList
ProjectList
RTypeDictArray
ResolutionDescriptions: Description of the geometry of a single resolution level.
RoiList
ScriptJobList
SearchMetadataList
ServiceList
SessionList
ShapeList
ShapeStatsList
ShortArray
ShortArrayArray
StringArray
StringArrayArray
StringSet

Dictionary Index

BooleanIdListMap
BooleanLongListMap
IObjectListMap
IdBooleanLongListMapMap
IdListMap
IntShapeListMap
IntStringMap
LongAnnotationListMap
LongByteArrayMap
LongIObjectListMap
LongIntMap
LongPixelsMap
LongRoiResultMap
LongShapeListMap
LongStringMap
OriginalFileMap
SearchMetadata
StringIntMap
StringLongListMap
StringLongMap
StringRTypeMap
StringShapeListMap
StringStringArrayMap
StringStringMap
UserMap

Enumeration Index

ContainerClass

Sequences

[ "java:type:java.util.ArrayList:java.util.List" ] sequence<model::Annotation> AnnotationList

Used By

LongAnnotationListMap
IMetadata::loadAnnotation
IMetadata::loadSpecifiedAnnotations
IRoi::getRoiMeasurements
IShare::getComments
Search::byAnnotatedWith
grid::ImportSettings::userSpecifiedAnnotationList

sequence<bool> BoolArray

Used By

grid::BoolColumn::values
model::Permissions::restrictions

sequence<byte> ByteArray

Used By

ByteArrayArray
LongByteArrayMap
Gateway::getThumbnail

sequence<ByteArray> ByteArrayArray

Used By

grid::MaskColumn::bytes

[ "java:type:java.util.ArrayList:java.util.List" ] sequence<model::ChecksumAlgorithm> ChecksumAlgorithmList

Used By

grid::ManagedRepository::listChecksumAlgorithms
grid::ManagedRepository::suggestChecksumAlgorithm

[ "java:type:java.util.ArrayList:java.util.List" ] sequence<model::Dataset> DatasetList

Used By

Gateway::getDatasets

sequence<double> DoubleArray

[ "java:type:java.util.ArrayList:java.util.List" ] sequence<model::Event> EventList

[ "java:type:java.util.ArrayList:java.util.List" ] sequence<model::EventLog> EventLogList

Used By

ITimeline::getEventLogsByPeriod

[ "java:type:java.util.ArrayList:java.util.List" ] sequence<model::ExperimenterGroup> ExperimenterGroupList

Used By

IAdmin::addGroups
IAdmin::containedGroups
IAdmin::createExperimenter
IAdmin::createExperimenterWithPassword
IAdmin::lookupGroups
IAdmin::removeGroups

[ "java:type:java.util.ArrayList:java.util.List" ] sequence<model::Experimenter> ExperimenterList

Used By

IAdmin::addGroupOwners
IAdmin::containedExperimenters
IAdmin::lookupExperimenters
IAdmin::removeGroupOwners
ILdap::searchAll
ILdap::searchByAttribute
ILdap::searchByAttributes
IShare::addUsers
IShare::createShare
IShare::getAllMembers
IShare::removeUsers

sequence<float> FloatArray

Used By

FloatArrayArray

sequence<FloatArray> FloatArrayArray

Used By

FloatArrayArrayArray
grid::FloatArrayColumn::values

sequence<FloatArrayArray> FloatArrayArrayArray

[ "java:type:java.util.ArrayList:java.util.List" ] sequence<model::IObject> IObjectList

Used By

IObjectListMap
LongIObjectListMap
Gateway::findAllByQuery
Gateway::saveAndReturnArray
Gateway::saveArray
IAdmin::moveToCommonSpace
IContainer::createDataObjects
IContainer::deleteDataObjects
IContainer::findContainerHierarchies
IContainer::link
IContainer::loadContainerHierarchy
IContainer::retrieveCollection
IContainer::unlink
IContainer::updateDataObjects
IDelete::checkImageDelete
IDelete::previewImageDelete
IMetadata::loadAnnotationsUsedNotOwned
IMetadata::loadTagSets
IPixels::getAllEnumerations
IPixels::retrieveAllRndSettings
IQuery::findAll
IQuery::findAllByExample
IQuery::findAllByFullText
IQuery::findAllByQuery
IQuery::findAllByString
IScript::getUserScripts
IScript::validateScript
IShare::addObjects
IShare::createShare
IShare::getContentSubList
IShare::getContents
IShare::getEvents
IShare::removeObjects
ITimeline::getMostRecentAnnotationLinks
ITimeline::getMostRecentShareCommentLinks
ITypes::allEnumerations
ITypes::getOriginalEnumerations
ITypes::updateEnumerations
IUpdate::saveAndReturnArray
IUpdate::saveAndReturnIds
IUpdate::saveArray
IUpdate::saveCollection
RenderingEngine::getAvailableFamilies
RenderingEngine::getAvailableModels
Search::results
ServiceFactory::getSecurityContexts
grid::ImportResponse::objects

[ "java:type:java.util.ArrayList:java.util.List" ] sequence<model::Image> ImageList

Used By

Gateway::getImageByName
Gateway::getImageFromDatasetByName
Gateway::getImages
IContainer::getImages
IContainer::getImagesByOptions
IContainer::getUserImages

sequence<int> IntegerArray

Used By

IntegerArrayArray
BufferedImage::packedInts
Gateway::getRenderedImage
Gateway::renderAsPackedIntAsRGBA
ShapePoints::x
ShapePoints::y
grid::MaskColumn::theT
grid::MaskColumn::theZ

sequence<IntegerArray> IntegerArrayArray

Used By

IntegerArrayArrayArray
grid::JobParams::authorsInstitutions

sequence<IntegerArrayArray> IntegerArrayArrayArray

Used By

Gateway::getRenderedImageMatrix

[ "java:type:java.util.ArrayList:java.util.List" ] sequence<int> IntegerList

Used By

FilePathNamingException::illegalCodePoints
Gateway::copyImage
Gateway::copyPixels
Gateway::copyPixelsXYTZ
Gateway::createImage

[ "java:type:java.util.ArrayList:java.util.List" ] sequence<model::LogicalChannel> LogicalChannelList

Used By

IMetadata::loadChannelAcquisitionData

sequence<long> LongArray

Used By

LongArrayArray
ShapeStats::channelIds
ShapeStats::pointsCount
delete::DeleteReport::stepStarts
delete::DeleteReport::stepStops
grid::Data::rowNumbers
grid::FileColumn::values
grid::ImageColumn::values
grid::LongColumn::values
grid::MaskColumn::imageId
grid::PlateColumn::values
grid::RoiColumn::values
grid::Table::getWhereList
grid::Table::read
grid::Table::readCoordinates
grid::Table::slice
grid::WellColumn::values

sequence<LongArray> LongArrayArray

Used By

grid::LongArrayColumn::values

[ "java:type:java.util.ArrayList:java.util.List" ] sequence<long> LongList

Used By

BooleanLongListMap
StringLongListMap
Gateway::getDatasets
Gateway::getImages
Gateway::getProjects
Gateway::getThumbnailSet
IAdmin::getLeaderOfGroupIds
IAdmin::getMemberOfGroupIds
IDelete::deleteImages
IRoi::getMeasuredRoisMap
IRoi::getShapeStatsList
cmd::ManageImageBinariesResponse::archivedFiles
grid::ProcessorCallback::responseRunning

[ "java:type:java.util.ArrayList:java.util.List" ] sequence<model::OriginalFile> OriginalFileList

Used By

IAdmin::getMyUserPhotos
IScript::getScripts
IScript::getUserScripts
grid::Repository::listFiles
grid::RepositoryMap::descriptions

[ "java:type:java.util.ArrayList:java.util.List" ] sequence<model::Pixels> PixelsList

Used By

Gateway::getPixelsFromImage
grid::ImportResponse::pixels

[ "java:type:java.util.ArrayList:java.util.List" ] sequence<model::PixelsType> PixelsTypeList

Used By

Gateway::getPixelTypes

[ "java:type:java.util.ArrayList:java.util.List" ] sequence<model::Project> ProjectList

Used By

Gateway::getProjects

sequence<RTypeDict> RTypeDictArray

sequence<ResolutionDescription> ResolutionDescriptions

Description of the geometry of a single resolution level. Initially this contains simply the sizeX/sizeY so that the client can calculate percentages. Eventually, this may also include columns, rows, etc.