Package omero.model

Class MicrobeamManipulationI

java.lang.Object

Ice.ObjectImpl

omero.model.IObject

omero.model.MicrobeamManipulation

omero.model.MicrobeamManipulationI

All Implemented Interfaces:

Ice.Object, java.io.Serializable, java.lang.Cloneable, ome.model.ModelBased, _IObjectOperations, _IObjectOperationsNC, _MicrobeamManipulationOperations, _MicrobeamManipulationOperationsNC

public class MicrobeamManipulationI
extends MicrobeamManipulation
implements ome.model.ModelBased

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DESCRIPTION
static java.lang.String	DETAILS
static java.lang.String	EXPERIMENT
static java.lang.String	LIGHTSOURCESETTINGS
static java.lang.String	TYPE

Fields inherited from class omero.model.MicrobeamManipulation

__ids, description, experiment, lightSourceSettingsLoaded, lightSourceSettingsSeq, serialVersionUID, type, version

Fields inherited from class omero.model.IObject

details, id, loaded

Fields inherited from interface Ice.Object

ice_staticId

Constructor Summary

Constructors

Constructor	Description
MicrobeamManipulationI()
MicrobeamManipulationI(long id, boolean loaded)
MicrobeamManipulationI(RLong id, boolean loaded)

Method Summary

Modifier and Type	Method	Description
void	addAllLightSettingsSet(java.util.List<LightSettings> targets, Ice.Current current)
void	addLightSettings(LightSettings target, Ice.Current current)
static java.util.List<MicrobeamManipulationI>	cast(java.util.List list)	Casts (without warning) the given list to a list of the current type.
void	clearLightSourceSettings(Ice.Current current)
java.util.List	copyLightSourceSettings(Ice.Current current)
void	copyObject(ome.util.Filterable model, ome.util.ModelMapper _mapper)	Used by IceMapper to inject an "ome.model" object into this "omero.model" object.
protected void	errorIfUnloaded()
ome.util.Filterable	fillObject(ome.util.ReverseModelMapper _mapper)	Used by IceMapper produce an "ome.model" object from this "omero.model" object.
RString	getDescription(Ice.Current current)
Details	getDetails(Ice.Current current)
Experiment	getExperiment(Ice.Current current)
RLong	getId(Ice.Current current)
protected java.util.List	getLightSourceSettings(Ice.Current current)
MicrobeamManipulationType	getType(Ice.Current current)
RInt	getVersion(Ice.Current current)
boolean	isAnnotated(Ice.Current current)	Allows for the attachment of any omero.model.Annotation subclasses.
boolean	isGlobal(Ice.Current current)	Marker interface which means that special rules apply for both reading and writing these instances.
boolean	isLightSourceSettingsLoaded()
boolean	isLink(Ice.Current current)	A link between two other types.
boolean	isLoaded(Ice.Current current)	Tests if the objects are loaded or not.
boolean	isMutable(Ice.Current current)	The server will persist changes made to these types.
java.util.Iterator	iterateLightSourceSettings()
IObject	proxy(Ice.Current current)	Return another instance of the same type as this instance constructed as if by: new InstanceI( this.id.val, false );
void	reloadLightSourceSettings(MicrobeamManipulation toCopy, Ice.Current current)
void	removeAllLightSettingsSet(java.util.List<LightSettings> targets, Ice.Current current)
void	removeLightSettings(LightSettings target, Ice.Current current)
void	setDescription(RString description, Ice.Current current)
void	setExperiment(Experiment experiment, Ice.Current current)
void	setId(RLong id, Ice.Current current)
protected void	setLightSourceSettings(java.util.List lightSourceSettings, Ice.Current current)
void	setType(MicrobeamManipulationType type, Ice.Current current)
void	setVersion(RInt version, Ice.Current current)
IObject	shallowCopy(Ice.Current current)	Return another instance of the same type as this instance with all single-value entities unloaded and all members of collections also unloaded.
int	sizeOfLightSourceSettings(Ice.Current current)
protected void	throwNullCollectionException(java.lang.String propertyName)
protected void	toggleCollectionsLoaded(boolean load)
void	unload(Ice.Current current)	Sets the loaded boolean to false and empties all state from this entity to make sending it over the network less costly.
void	unloadCollections(Ice.Current current)	Each collection can also be unloaded, independently of the object itself.
void	unloadDescription()
void	unloadDetails(Ice.Current current)	As with collections, the objects under details can link to many other objects.
void	unloadExperiment()
void	unloadLightSourceSettings(Ice.Current current)
void	unloadType()

Methods inherited from class omero.model.MicrobeamManipulation

___addAllLightSettingsSet, ___addLightSettings, ___clearLightSourceSettings, ___copyLightSourceSettings, ___getDescription, ___getExperiment, ___getType, ___getVersion, ___reloadLightSourceSettings, ___removeAllLightSettingsSet, ___removeLightSettings, ___setDescription, ___setExperiment, ___setType, ___setVersion, ___sizeOfLightSourceSettings, ___unloadLightSourceSettings, __dispatch, __readImpl, __writeImpl, addAllLightSettingsSet, addLightSettings, clearLightSourceSettings, clone, copyLightSourceSettings, getDescription, getExperiment, getType, getVersion, ice_id, ice_id, ice_ids, ice_ids, ice_isA, ice_isA, ice_staticId, reloadLightSourceSettings, removeAllLightSettingsSet, removeLightSettings, setDescription, setExperiment, setType, setVersion, sizeOfLightSourceSettings, unloadLightSourceSettings

Methods inherited from class omero.model.IObject

___getDetails, ___getId, ___isAnnotated, ___isGlobal, ___isLink, ___isLoaded, ___isMutable, ___proxy, ___setId, ___shallowCopy, ___unload, ___unloadCollections, ___unloadDetails, getDetails, getId, isAnnotated, isGlobal, isLink, isLoaded, isMutable, proxy, setId, shallowCopy, unload, unloadCollections, unloadDetails

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._IObjectOperationsNC

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

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

LIGHTSOURCESETTINGS

public static final java.lang.String LIGHTSOURCESETTINGS

See Also:

Constant Field Values

EXPERIMENT

public static final java.lang.String EXPERIMENT

See Also:

Constant Field Values

DESCRIPTION

public static final java.lang.String DESCRIPTION

See Also:

Constant Field Values

DETAILS

public static final java.lang.String DETAILS

See Also:

Constant Field Values

Constructor Detail

MicrobeamManipulationI

public MicrobeamManipulationI()

MicrobeamManipulationI

public MicrobeamManipulationI(long id,
                              boolean loaded)

MicrobeamManipulationI

public MicrobeamManipulationI(RLong id,
                              boolean loaded)

Method Detail

errorIfUnloaded

protected void errorIfUnloaded()
                        throws UnloadedEntityException

Throws:

UnloadedEntityException

throwNullCollectionException

protected void throwNullCollectionException(java.lang.String propertyName)
                                     throws UnloadedCollectionException

Throws:

UnloadedCollectionException

toggleCollectionsLoaded

protected void toggleCollectionsLoaded(boolean load)

unload

public void unload(Ice.Current current)

Description copied from interface: _IObjectOperations

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 _IObjectOperations

Parameters:

current - The Current object for the invocation.

isLoaded

public boolean isLoaded(Ice.Current current)

Description copied from interface: _IObjectOperations

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 _IObjectOperations

Parameters:

current - The Current object for the invocation.

unloadCollections

public void unloadCollections(Ice.Current current)

Description copied from interface: _IObjectOperations

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 _IObjectOperations

Parameters:

current - The Current object for the invocation.

isGlobal

public boolean isGlobal(Ice.Current current)

Description copied from interface: _IObjectOperations

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

Specified by:

isGlobal in interface _IObjectOperations

Parameters:

current - The Current object for the invocation.

isMutable

public boolean isMutable(Ice.Current current)

Description copied from interface: _IObjectOperations

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

Specified by:

isMutable in interface _IObjectOperations

Parameters:

current - The Current object for the invocation.

isAnnotated

public boolean isAnnotated(Ice.Current current)

Description copied from interface: _IObjectOperations

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

Specified by:

isAnnotated in interface _IObjectOperations

Parameters:

current - The Current object for the invocation.

isLink

public boolean isLink(Ice.Current current)

Description copied from interface: _IObjectOperations

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

Specified by:

isLink in interface _IObjectOperations

Parameters:

current - The Current object for the invocation.

shallowCopy

public IObject shallowCopy(Ice.Current current)

Description copied from interface: _IObjectOperations

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 _IObjectOperations

Parameters:

current - The Current object for the invocation.

proxy

public IObject proxy(Ice.Current current)

Description copied from interface: _IObjectOperations

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 _IObjectOperations

Parameters:

current - The Current object for the invocation.

getId

public RLong getId(Ice.Current current)

Specified by:

getId in interface _IObjectOperations

setId

public void setId(RLong id,
                  Ice.Current current)

Specified by:

setId in interface _IObjectOperations

getDetails

public Details getDetails(Ice.Current current)

Specified by:

getDetails in interface _IObjectOperations

unloadDetails

public void unloadDetails(Ice.Current current)

Description copied from interface: _IObjectOperations

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 _IObjectOperations

Parameters:

current - The Current object for the invocation.

getVersion

public RInt getVersion(Ice.Current current)

Specified by:

getVersion in interface _MicrobeamManipulationOperations

setVersion

public void setVersion(RInt version,
                       Ice.Current current)

Specified by:

setVersion in interface _MicrobeamManipulationOperations

unloadType

public void unloadType()

getType

public MicrobeamManipulationType getType(Ice.Current current)
                                  throws UnloadedEntityException

Specified by:

getType in interface _MicrobeamManipulationOperations

Throws:

UnloadedEntityException

setType

public void setType(MicrobeamManipulationType type,
                    Ice.Current current)
             throws UnloadedEntityException

Specified by:

setType in interface _MicrobeamManipulationOperations

Throws:

UnloadedEntityException

unloadLightSourceSettings

public void unloadLightSourceSettings(Ice.Current current)

Specified by:

unloadLightSourceSettings in interface _MicrobeamManipulationOperations

getLightSourceSettings

protected java.util.List getLightSourceSettings(Ice.Current current)
                                         throws UnloadedEntityException

Throws:

UnloadedEntityException

setLightSourceSettings

protected void setLightSourceSettings(java.util.List lightSourceSettings,
                                      Ice.Current current)
                               throws UnloadedEntityException

Throws:

UnloadedEntityException

isLightSourceSettingsLoaded

public boolean isLightSourceSettingsLoaded()

sizeOfLightSourceSettings

public int sizeOfLightSourceSettings(Ice.Current current)
                              throws UnloadedEntityException

Specified by:

sizeOfLightSourceSettings in interface _MicrobeamManipulationOperations

Throws:

UnloadedEntityException

copyLightSourceSettings

public java.util.List copyLightSourceSettings(Ice.Current current)
                                       throws UnloadedEntityException

Specified by:

copyLightSourceSettings in interface _MicrobeamManipulationOperations

Throws:

UnloadedEntityException

iterateLightSourceSettings

public java.util.Iterator iterateLightSourceSettings()
                                              throws UnloadedEntityException

Throws:

UnloadedEntityException

addLightSettings

public void addLightSettings(LightSettings target,
                             Ice.Current current)
                      throws UnloadedEntityException

Specified by:

addLightSettings in interface _MicrobeamManipulationOperations

Throws:

UnloadedEntityException

addAllLightSettingsSet

public void addAllLightSettingsSet(java.util.List<LightSettings> targets,
                                   Ice.Current current)
                            throws UnloadedEntityException

Specified by:

addAllLightSettingsSet in interface _MicrobeamManipulationOperations

Throws:

UnloadedEntityException

removeLightSettings

public void removeLightSettings(LightSettings target,
                                Ice.Current current)
                         throws UnloadedEntityException

Specified by:

removeLightSettings in interface _MicrobeamManipulationOperations

Throws:

UnloadedEntityException

removeAllLightSettingsSet

public void removeAllLightSettingsSet(java.util.List<LightSettings> targets,
                                      Ice.Current current)
                               throws UnloadedEntityException

Specified by:

removeAllLightSettingsSet in interface _MicrobeamManipulationOperations

Throws:

UnloadedEntityException

clearLightSourceSettings

public void clearLightSourceSettings(Ice.Current current)
                              throws UnloadedEntityException

Specified by:

clearLightSourceSettings in interface _MicrobeamManipulationOperations

Throws:

UnloadedEntityException

reloadLightSourceSettings

public void reloadLightSourceSettings(MicrobeamManipulation toCopy,
                                      Ice.Current current)
                               throws UnloadedEntityException

Specified by:

reloadLightSourceSettings in interface _MicrobeamManipulationOperations

Throws:

UnloadedEntityException

unloadExperiment

public void unloadExperiment()

getExperiment

public Experiment getExperiment(Ice.Current current)
                         throws UnloadedEntityException

Specified by:

getExperiment in interface _MicrobeamManipulationOperations

Throws:

UnloadedEntityException

setExperiment

public void setExperiment(Experiment experiment,
                          Ice.Current current)
                   throws UnloadedEntityException

Specified by:

setExperiment in interface _MicrobeamManipulationOperations

Throws:

UnloadedEntityException

unloadDescription

public void unloadDescription()

getDescription

public RString getDescription(Ice.Current current)
                       throws UnloadedEntityException

Specified by:

getDescription in interface _MicrobeamManipulationOperations

Throws:

UnloadedEntityException

setDescription

public void setDescription(RString description,
                           Ice.Current current)
                    throws UnloadedEntityException

Specified by:

setDescription in interface _MicrobeamManipulationOperations

Throws:

UnloadedEntityException

copyObject

public void copyObject(ome.util.Filterable model,
                       ome.util.ModelMapper _mapper)

Used by IceMapper to inject an "ome.model" object into this "omero.model" object.

Specified by:

copyObject in interface ome.model.ModelBased

fillObject

public ome.util.Filterable fillObject(ome.util.ReverseModelMapper _mapper)

Used by IceMapper produce an "ome.model" object from this "omero.model" object.

Specified by:

fillObject in interface ome.model.ModelBased

cast

public static java.util.List<MicrobeamManipulationI> cast(java.util.List list)

Casts (without warning) the given list to a list of the current type.

Throws:

java.lang.ClassCastException