OmeroBlitz API

omero::model::IObject

Overview

[ "protected" ] class IObject

Base class of all model types. On the server, the interface ome.model.IObject unifies the model. In Ice, interfaces have a more remote connotation.

Derived Classes and Interfaces

AcquisitionMode
AdminPrivilege
AffineTransform
Annotation
AnnotationAnnotationLink
ArcType
Binning
Channel
ChannelAnnotationLink
ChannelBinding
ChecksumAlgorithm
CodomainMapContext
ContrastMethod
Correction
DBPatch
Dataset
DatasetAnnotationLink
DatasetImageLink
Detector
DetectorAnnotationLink
DetectorSettings
DetectorType
Dichroic
DichroicAnnotationLink
DimensionOrder
Event
EventLog
EventType
Experiment
ExperimentType
Experimenter
ExperimenterAnnotationLink
ExperimenterGroup
ExperimenterGroupAnnotationLink
ExternalInfo
Family
FilamentType
Fileset
FilesetAnnotationLink
FilesetEntry
FilesetJobLink
Filter
FilterAnnotationLink
FilterSet
FilterSetEmissionFilterLink
FilterSetExcitationFilterLink
FilterType
Folder
FolderAnnotationLink
FolderImageLink
FolderRoiLink
Format
GroupExperimenterMap
Illumination
Image
ImageAnnotationLink
ImagingEnvironment
Immersion
Instrument
InstrumentAnnotationLink
Job
JobOriginalFileLink
JobStatus
LaserMedium
LaserType
LightPath
LightPathAnnotationLink
LightPathEmissionFilterLink
LightPathExcitationFilterLink
LightSettings
LightSource
LightSourceAnnotationLink
Link
LogicalChannel
Medium
MicrobeamManipulation
MicrobeamManipulationType
Microscope
MicroscopeType
Namespace
NamespaceAnnotationLink
Node
NodeAnnotationLink
OTF
Objective
ObjectiveAnnotationLink
ObjectiveSettings
OriginalFile
OriginalFileAnnotationLink
PhotometricInterpretation
Pixels
PixelsOriginalFileMap
PixelsType
PlaneInfo
PlaneInfoAnnotationLink
Plate
PlateAcquisition
PlateAcquisitionAnnotationLink
PlateAnnotationLink
Project
ProjectAnnotationLink
ProjectDatasetLink
ProjectionAxis
ProjectionDef
ProjectionType
Pulse
QuantumDef
Reagent
ReagentAnnotationLink
RenderingDef
RenderingModel
Roi
RoiAnnotationLink
Screen
ScreenAnnotationLink
ScreenPlateLink
Session
SessionAnnotationLink
Shape
ShapeAnnotationLink
ShareMember
StageLabel
StatsInfo
Thumbnail
TransmittanceRange
Well
WellAnnotationLink
WellReagentLink
WellSample

Used By

RObject::getValue
RObject::val
api::IObjectList
api::IAdmin::canUpdate
api::IAdmin::changeGroup
api::IAdmin::changeOwner
api::IAdmin::changePermissions
api::IContainer::createDataObject
api::IContainer::retrieveCollection
api::IContainer::updateDataObject
api::IPixels::getEnumeration
api::IQuery::find
api::IQuery::findAllByExample
api::IQuery::findByExample
api::IQuery::findByQuery
api::IQuery::findByString
api::IQuery::get
api::IQuery::refresh
api::IShare::addObject
api::IShare::removeObject
api::ITypes::createEnumeration
api::ITypes::deleteEnumeration
api::ITypes::getEnumeration
api::ITypes::updateEnumeration
api::IUpdate::deleteObject
api::IUpdate::indexObject
api::IUpdate::saveAndReturnObject
api::IUpdate::saveObject
api::Save::obj
api::SaveRsp::obj
api::Search::next
api::ServiceFactory::setSecurityContext
grid::ImportSettings::userSpecifiedTarget
metadatastore::IObjectContainer::sourceObject
proxy
shallowCopy

Operation Index

getId
setId
getDetails
proxy: Return another instance of the same type as this instance constructed as if by: new InstanceI( this.id.val, false );
shallowCopy: Return another instance of the same type as this instance with all single-value entities unloaded and all members of collections also unloaded.
unload: Sets the loaded boolean to false and empties all state from this entity to make sending it over the network less costly.
unloadCollections: Each collection can also be unloaded, independently of the object itself.
unloadDetails: As with collections, the objects under details can link to many other objects.
isLoaded: Tests if the objects are loaded or not.
isGlobal: Marker interface which means that special rules apply for both reading and writing these instances.
isLink: A link between two other types.
isMutable: The server will persist changes made to these types.
isAnnotated: Allows for the attachment of any omero.model.Annotation subclasses.

Data Member Index

id: The database id for this entity.
details: Internal details (permissions, owner, etc.) for this entity.
loaded: An unloaded object contains no state other than id.

Operations

RLong getId()

Details getDetails()

IObject proxy()

Return another instance of the same type as this instance constructed as if by: new InstanceI( this.id.val, false );

IObject shallowCopy()

Return another instance of the same type as this instance with all single-value entities unloaded and all members of collections also unloaded.

void unload()

Sets the loaded boolean to false and empties all state from this entity to make sending it over the network less costly.

Each collection can also be unloaded, independently of the object itself. To unload all collections, use: object.unloadCollections(); This is useful when it is possible that a collection no longer represents the state in the database, and passing the collections back to the server might delete some entities. Sending back empty collections can also save a significant amount of bandwidth, when working with large data graphs.

void unloadDetails()

As with collections, the objects under details can link to many other objects. Unloading the details can same bandwidth and simplify the server logic.

bool isLoaded()

Tests if the objects are loaded or not. If this value is false, then any method call on this instance other than getId or setId will result in an exception.

bool isGlobal()

Marker interface which means that special rules apply for both reading and writing these instances.

bool isLink()

A link between two other types. Methods provided: - getParent() - getChild()

bool isMutable()

The server will persist changes made to these types. Methods provided: - getVersion() - setVersion()

bool isAnnotated()

Allows for the attachment of any omero.model.Annotation subclasses. Methods provided are: - linkAnnotation(Annotation) -

Data Members

RLong id;

The database id for this entity. Of RLong value so that transient entities can have a null id.

Details details;

Internal details (permissions, owner, etc.) for this entity. All entities have Details, and even a newly created object will have a non-null Details instance. (In the OMERO provided mapping!)

bool loaded;

An unloaded object contains no state other than id. An exception will be raised if any field other than id is accessed via the OMERO-generated methods. Unloaded objects are useful as pointers or proxies to server-side state.

Home

Index