omero.model

Class WellSampleI

java.lang.Object

Ice.ObjectImpl

omero.model.IObject

omero.model.WellSample

omero.model.WellSampleI

All Implemented Interfaces:

Ice.Object, java.io.Serializable, java.lang.Cloneable, ome.model.ModelBased, _IObjectOperations, _IObjectOperationsNC, _WellSampleOperations, _WellSampleOperationsNC

public class WellSampleI
extends WellSample
implements ome.model.ModelBased

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DETAILS
static java.lang.String	IMAGE
static java.lang.String	PLATEACQUISITION
static java.lang.String	POSX
static java.lang.String	POSY
static java.lang.String	TIMEPOINT
static java.lang.String	WELL

Fields inherited from class omero.model.WellSample

__ids, image, plateAcquisition, posX, posY, serialVersionUID, timepoint, version, well

Fields inherited from class omero.model.IObject

details, id, loaded

Fields inherited from interface Ice.Object

ice_staticId

Constructor Summary

Constructors

Constructor and Description
WellSampleI()
WellSampleI(long id, boolean loaded)
WellSampleI(RLong id, boolean loaded)

Method Summary

Modifier and Type	Method and Description
static java.util.List<WellSampleI>	cast(java.util.List list) Casts (without warning) the given list to a list of the current type.
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.
Details	getDetails(Ice.Current current)
RLong	getId(Ice.Current current)
Image	getImage(Ice.Current current)
PlateAcquisition	getPlateAcquisition(Ice.Current current)
Length	getPosX(Ice.Current current)
Length	getPosY(Ice.Current current)
RTime	getTimepoint(Ice.Current current)
RInt	getVersion(Ice.Current current)
Well	getWell(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	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.
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	setId(RLong id, Ice.Current current)
void	setImage(Image image, Ice.Current current)
void	setPlateAcquisition(PlateAcquisition plateAcquisition, Ice.Current current)
void	setPosX(Length posX, Ice.Current current)
void	setPosY(Length posY, Ice.Current current)
void	setTimepoint(RTime timepoint, Ice.Current current)
void	setVersion(RInt version, Ice.Current current)
void	setWell(Well well, 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.
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	unloadDetails(Ice.Current current) As with collections, the objects under details can link to many other objects.
void	unloadImage()
void	unloadPlateAcquisition()
void	unloadPosX()
void	unloadPosY()
void	unloadTimepoint()
void	unloadWell()

Methods inherited from class omero.model.WellSample

___getImage, ___getPlateAcquisition, ___getPosX, ___getPosY, ___getTimepoint, ___getVersion, ___getWell, ___setImage, ___setPlateAcquisition, ___setPosX, ___setPosY, ___setTimepoint, ___setVersion, ___setWell, __dispatch, __readImpl, __writeImpl, clone, getImage, getPlateAcquisition, getPosX, getPosY, getTimepoint, getVersion, getWell, ice_id, ice_id, ice_ids, ice_ids, ice_isA, ice_isA, ice_staticId, setImage, setPlateAcquisition, setPosX, setPosY, setTimepoint, setVersion, setWell

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

POSX

public static final java.lang.String POSX

See Also:

Constant Field Values

POSY

public static final java.lang.String POSY

See Also:

Constant Field Values

TIMEPOINT

public static final java.lang.String TIMEPOINT

See Also:

Constant Field Values

PLATEACQUISITION

public static final java.lang.String PLATEACQUISITION

See Also:

Constant Field Values

WELL

public static final java.lang.String WELL

See Also:

Constant Field Values

IMAGE

public static final java.lang.String IMAGE

See Also:

Constant Field Values

DETAILS

public static final java.lang.String DETAILS

See Also:

Constant Field Values

Constructor Detail

WellSampleI

public WellSampleI()

WellSampleI

public WellSampleI(long id,
                   boolean loaded)

WellSampleI

public WellSampleI(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 _WellSampleOperations

setVersion

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

Specified by:

setVersion in interface _WellSampleOperations

unloadPosX

public void unloadPosX()

getPosX

public Length getPosX(Ice.Current current)
               throws UnloadedEntityException

Specified by:

getPosX in interface _WellSampleOperations

Throws:

UnloadedEntityException

setPosX

public void setPosX(Length posX,
                    Ice.Current current)
             throws UnloadedEntityException

Specified by:

setPosX in interface _WellSampleOperations

Throws:

UnloadedEntityException

unloadPosY

public void unloadPosY()

getPosY

public Length getPosY(Ice.Current current)
               throws UnloadedEntityException

Specified by:

getPosY in interface _WellSampleOperations

Throws:

UnloadedEntityException

setPosY

public void setPosY(Length posY,
                    Ice.Current current)
             throws UnloadedEntityException

Specified by:

setPosY in interface _WellSampleOperations

Throws:

UnloadedEntityException

unloadTimepoint

public void unloadTimepoint()

getTimepoint

public RTime getTimepoint(Ice.Current current)
                   throws UnloadedEntityException

Specified by:

getTimepoint in interface _WellSampleOperations

Throws:

UnloadedEntityException

setTimepoint

public void setTimepoint(RTime timepoint,
                         Ice.Current current)
                  throws UnloadedEntityException

Specified by:

setTimepoint in interface _WellSampleOperations

Throws:

UnloadedEntityException

unloadPlateAcquisition

public void unloadPlateAcquisition()

getPlateAcquisition

public PlateAcquisition getPlateAcquisition(Ice.Current current)
                                     throws UnloadedEntityException

Specified by:

getPlateAcquisition in interface _WellSampleOperations

Throws:

UnloadedEntityException

setPlateAcquisition

public void setPlateAcquisition(PlateAcquisition plateAcquisition,
                                Ice.Current current)
                         throws UnloadedEntityException

Specified by:

setPlateAcquisition in interface _WellSampleOperations

Throws:

UnloadedEntityException

unloadWell

public void unloadWell()

getWell

public Well getWell(Ice.Current current)
             throws UnloadedEntityException

Specified by:

getWell in interface _WellSampleOperations

Throws:

UnloadedEntityException

setWell

public void setWell(Well well,
                    Ice.Current current)
             throws UnloadedEntityException

Specified by:

setWell in interface _WellSampleOperations

Throws:

UnloadedEntityException

unloadImage

public void unloadImage()

getImage

public Image getImage(Ice.Current current)
               throws UnloadedEntityException

Specified by:

getImage in interface _WellSampleOperations

Throws:

UnloadedEntityException

setImage

public void setImage(Image image,
                     Ice.Current current)
              throws UnloadedEntityException

Specified by:

setImage in interface _WellSampleOperations

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<WellSampleI> cast(java.util.List list)

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

Throws:

java.lang.ClassCastException