omero.model

Class IObject

java.lang.Object

Ice.ObjectImpl

omero.model.IObject

All Implemented Interfaces:

Ice.Object, java.io.Serializable, java.lang.Cloneable, _IObjectOperations, _IObjectOperationsNC

Direct Known Subclasses:

_IObjectTie, AcquisitionMode, AdminPrivilege, AffineTransform, Annotation, AnnotationAnnotationLink, ArcType, Binning, Channel, ChannelAnnotationLink, ChannelBinding, ChecksumAlgorithm, CodomainMapContext, ContrastMethod, Correction, Dataset, DatasetAnnotationLink, DatasetImageLink, DBPatch, Detector, DetectorAnnotationLink, DetectorSettings, DetectorType, Dichroic, DichroicAnnotationLink, DimensionOrder, Event, EventLog, EventType, Experiment, Experimenter, ExperimenterAnnotationLink, ExperimenterGroup, ExperimenterGroupAnnotationLink, ExperimentType, 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, Objective, ObjectiveAnnotationLink, ObjectiveSettings, OriginalFile, OriginalFileAnnotationLink, OTF, 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

public abstract class IObject
extends Ice.ObjectImpl
implements _IObjectOperations, _IObjectOperationsNC

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.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	__ids
protected Details	details Internal details (permissions, owner, etc.) for this entity.
protected RLong	id The database id for this entity.
protected boolean	loaded An unloaded object contains no state other than id.
static long	serialVersionUID

Fields inherited from interface Ice.Object

ice_staticId

Constructor Summary

Constructors

Constructor and Description
IObject()
IObject(RLong id, Details details, boolean loaded)

Method Summary

Modifier and Type	Method and Description
static Ice.DispatchStatus	___getDetails(IObject __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___getId(IObject __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___isAnnotated(IObject __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___isGlobal(IObject __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___isLink(IObject __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___isLoaded(IObject __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___isMutable(IObject __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___proxy(IObject __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___setId(IObject __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___shallowCopy(IObject __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___unload(IObject __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___unloadCollections(IObject __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___unloadDetails(IObject __obj, IceInternal.Incoming __inS, Ice.Current __current)
Ice.DispatchStatus	__dispatch(IceInternal.Incoming in, Ice.Current __current)
protected void	__readImpl(IceInternal.BasicStream __is)
protected void	__writeImpl(IceInternal.BasicStream __os)
IObject	clone()
Details	getDetails()
RLong	getId()
java.lang.String	ice_id()
java.lang.String	ice_id(Ice.Current __current)
java.lang.String[]	ice_ids()
java.lang.String[]	ice_ids(Ice.Current __current)
boolean	ice_isA(java.lang.String s)
boolean	ice_isA(java.lang.String s, Ice.Current __current)
static java.lang.String	ice_staticId()
boolean	isAnnotated() Allows for the attachment of any omero.model.Annotation subclasses.
boolean	isGlobal() Marker interface which means that special rules apply for both reading and writing these instances.
boolean	isLink() A link between two other types.
boolean	isLoaded() Tests if the objects are loaded or not.
boolean	isMutable() The server will persist changes made to these types.
IObject	proxy() Return another instance of the same type as this instance constructed as if by: new InstanceI( this.id.val, false );
void	setId(RLong id)
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.
void	unloadCollections() Each collection can also be unloaded, independently of the object itself.
void	unloadDetails() As with collections, the objects under details can link to many other objects.

Methods inherited from class Ice.ObjectImpl

___ice_id, ___ice_ids, ___ice_isA, ___ice_ping, __checkMode, __read, __read, __readImpl, __write, __write, __writeImpl, ice_dispatch, ice_dispatch, ice_operationAttributes, ice_ping, ice_ping, ice_postUnmarshal, ice_preMarshal

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface omero.model._IObjectOperations

getDetails, getId, isAnnotated, isGlobal, isLink, isLoaded, isMutable, proxy, setId, shallowCopy, unload, unloadCollections, unloadDetails

Field Detail

__ids

public static final java.lang.String[] __ids

id

protected RLong id

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

details

protected 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!)

loaded

protected boolean 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.

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

IObject

public IObject()

IObject

public IObject(RLong id,
               Details details,
               boolean loaded)

Method Detail

ice_isA

public boolean ice_isA(java.lang.String s)

Specified by:

ice_isA in interface Ice.Object

Overrides:

ice_isA in class Ice.ObjectImpl

ice_isA

public boolean ice_isA(java.lang.String s,
                       Ice.Current __current)

Specified by:

ice_isA in interface Ice.Object

Overrides:

ice_isA in class Ice.ObjectImpl

ice_ids

public java.lang.String[] ice_ids()

Specified by:

ice_ids in interface Ice.Object

Overrides:

ice_ids in class Ice.ObjectImpl

ice_ids

public java.lang.String[] ice_ids(Ice.Current __current)

Specified by:

ice_ids in interface Ice.Object

Overrides:

ice_ids in class Ice.ObjectImpl

ice_id

public java.lang.String ice_id()

Specified by:

ice_id in interface Ice.Object

Overrides:

ice_id in class Ice.ObjectImpl

ice_id

public java.lang.String ice_id(Ice.Current __current)

Specified by:

ice_id in interface Ice.Object

Overrides:

ice_id in class Ice.ObjectImpl

ice_staticId

public static java.lang.String ice_staticId()

getDetails

public final Details getDetails()

Specified by:

getDetails in interface _IObjectOperationsNC

getId

public final RLong getId()

Specified by:

getId in interface _IObjectOperationsNC

isAnnotated

public final boolean isAnnotated()

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

Specified by:

isAnnotated in interface _IObjectOperationsNC

isGlobal

public final boolean isGlobal()

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

Specified by:

isGlobal in interface _IObjectOperationsNC

isLink

public final boolean isLink()

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

Specified by:

isLink in interface _IObjectOperationsNC

isLoaded

public final boolean 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.

Specified by:

isLoaded in interface _IObjectOperationsNC

isMutable

public final boolean isMutable()

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

Specified by:

isMutable in interface _IObjectOperationsNC

proxy

public final IObject proxy()

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

Specified by:

proxy in interface _IObjectOperationsNC

setId

public final void setId(RLong id)

Specified by:

setId in interface _IObjectOperationsNC

shallowCopy

public final 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.

Specified by:

shallowCopy in interface _IObjectOperationsNC

unload

public final void unload()

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

Specified by:

unload in interface _IObjectOperationsNC

unloadCollections

public final void unloadCollections()

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.

Specified by:

unloadCollections in interface _IObjectOperationsNC

unloadDetails

public final 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.

Specified by:

unloadDetails in interface _IObjectOperationsNC

___getId

public static Ice.DispatchStatus ___getId(IObject __obj,
                                          IceInternal.Incoming __inS,
                                          Ice.Current __current)

___setId

public static Ice.DispatchStatus ___setId(IObject __obj,
                                          IceInternal.Incoming __inS,
                                          Ice.Current __current)

___getDetails

public static Ice.DispatchStatus ___getDetails(IObject __obj,
                                               IceInternal.Incoming __inS,
                                               Ice.Current __current)

___proxy

public static Ice.DispatchStatus ___proxy(IObject __obj,
                                          IceInternal.Incoming __inS,
                                          Ice.Current __current)

___shallowCopy

public static Ice.DispatchStatus ___shallowCopy(IObject __obj,
                                                IceInternal.Incoming __inS,
                                                Ice.Current __current)

___unload

public static Ice.DispatchStatus ___unload(IObject __obj,
                                           IceInternal.Incoming __inS,
                                           Ice.Current __current)

___unloadCollections

public static Ice.DispatchStatus ___unloadCollections(IObject __obj,
                                                      IceInternal.Incoming __inS,
                                                      Ice.Current __current)

___unloadDetails

public static Ice.DispatchStatus ___unloadDetails(IObject __obj,
                                                  IceInternal.Incoming __inS,
                                                  Ice.Current __current)

___isLoaded

public static Ice.DispatchStatus ___isLoaded(IObject __obj,
                                             IceInternal.Incoming __inS,
                                             Ice.Current __current)

___isGlobal

public static Ice.DispatchStatus ___isGlobal(IObject __obj,
                                             IceInternal.Incoming __inS,
                                             Ice.Current __current)

___isLink

public static Ice.DispatchStatus ___isLink(IObject __obj,
                                           IceInternal.Incoming __inS,
                                           Ice.Current __current)

___isMutable

public static Ice.DispatchStatus ___isMutable(IObject __obj,
                                              IceInternal.Incoming __inS,
                                              Ice.Current __current)

___isAnnotated

public static Ice.DispatchStatus ___isAnnotated(IObject __obj,
                                                IceInternal.Incoming __inS,
                                                Ice.Current __current)

__dispatch

public Ice.DispatchStatus __dispatch(IceInternal.Incoming in,
                                     Ice.Current __current)

Specified by:

__dispatch in interface Ice.Object

Overrides:

__dispatch in class Ice.ObjectImpl

__writeImpl

protected void __writeImpl(IceInternal.BasicStream __os)

Overrides:

__writeImpl in class Ice.ObjectImpl

__readImpl

protected void __readImpl(IceInternal.BasicStream __is)

Overrides:

__readImpl in class Ice.ObjectImpl

clone

public IObject clone()

Specified by:

clone in interface Ice.Object

Overrides:

clone in class Ice.ObjectImpl