omero.model

Class PlaneInfoI

java.lang.Object

Ice.ObjectImpl

omero.model.IObject

omero.model.PlaneInfo

omero.model.PlaneInfoI

All Implemented Interfaces:

Ice.Object, java.io.Serializable, java.lang.Cloneable, ome.model.ModelBased, _IObjectOperations, _IObjectOperationsNC, _PlaneInfoOperations, _PlaneInfoOperationsNC

public class PlaneInfoI
extends PlaneInfo
implements ome.model.ModelBased

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ANNOTATIONLINKS
static java.lang.String	DELTAT
static java.lang.String	DETAILS
static java.lang.String	EXPOSURETIME
static java.lang.String	PIXELS
static java.lang.String	POSITIONX
static java.lang.String	POSITIONY
static java.lang.String	POSITIONZ
static java.lang.String	THEC
static java.lang.String	THET
static java.lang.String	THEZ

Fields inherited from class omero.model.PlaneInfo

__ids, annotationLinksCountPerOwner, annotationLinksLoaded, annotationLinksSeq, deltaT, exposureTime, pixels, positionX, positionY, positionZ, serialVersionUID, theC, theT, theZ, version

Fields inherited from class omero.model.IObject

details, id, loaded

Fields inherited from interface Ice.Object

ice_staticId

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addAllPlaneInfoAnnotationLinkSet(java.util.List<PlaneInfoAnnotationLink> targets, Ice.Current current)
void	addPlaneInfoAnnotationLink(PlaneInfoAnnotationLink target, Ice.Current current)
void	addPlaneInfoAnnotationLinkToBoth(PlaneInfoAnnotationLink link, boolean bothSides, Ice.Current current)
static java.util.List<PlaneInfoI>	cast(java.util.List list) Casts (without warning) the given list to a list of the current type.
void	clearAnnotationLinks(Ice.Current current)
java.util.List	copyAnnotationLinks(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.
java.util.List<PlaneInfoAnnotationLink>	findPlaneInfoAnnotationLink(Annotation removal, Ice.Current current)
protected java.util.List	getAnnotationLinks(Ice.Current current)
java.util.Map<java.lang.Long,java.lang.Long>	getAnnotationLinksCountPerOwner(Ice.Current current)
Time	getDeltaT(Ice.Current current)
Details	getDetails(Ice.Current current)
Time	getExposureTime(Ice.Current current)
RLong	getId(Ice.Current current)
Pixels	getPixels(Ice.Current current)
Length	getPositionX(Ice.Current current)
Length	getPositionY(Ice.Current current)
Length	getPositionZ(Ice.Current current)
RInt	getTheC(Ice.Current current)
RInt	getTheT(Ice.Current current)
RInt	getTheZ(Ice.Current current)
RInt	getVersion(Ice.Current current)
boolean	isAnnotated(Ice.Current current) Allows for the attachment of any omero.model.Annotation subclasses.
boolean	isAnnotationLinksLoaded()
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.
java.util.Iterator	iterateAnnotationLinks()
PlaneInfoAnnotationLink	linkAnnotation(Annotation addition, Ice.Current current)
java.util.List<Annotation>	linkedAnnotationList(Ice.Current current)
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	reloadAnnotationLinks(PlaneInfo toCopy, Ice.Current current)
void	removeAllPlaneInfoAnnotationLinkSet(java.util.List<PlaneInfoAnnotationLink> targets, Ice.Current current)
void	removePlaneInfoAnnotationLink(PlaneInfoAnnotationLink target, Ice.Current current)
void	removePlaneInfoAnnotationLinkFromBoth(PlaneInfoAnnotationLink link, boolean bothSides, Ice.Current current)
protected void	setAnnotationLinks(java.util.List annotationLinks, Ice.Current current)
void	setDeltaT(Time deltaT, Ice.Current current)
void	setExposureTime(Time exposureTime, Ice.Current current)
void	setId(RLong id, Ice.Current current)
void	setPixels(Pixels pixels, Ice.Current current)
void	setPositionX(Length positionX, Ice.Current current)
void	setPositionY(Length positionY, Ice.Current current)
void	setPositionZ(Length positionZ, Ice.Current current)
void	setTheC(RInt theC, Ice.Current current)
void	setTheT(RInt theT, Ice.Current current)
void	setTheZ(RInt theZ, 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	sizeOfAnnotationLinks(Ice.Current current)
protected void	throwNullCollectionException(java.lang.String propertyName)
protected void	toggleCollectionsLoaded(boolean load)
void	unlinkAnnotation(Annotation removal, Ice.Current current)
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	unloadAnnotationLinks(Ice.Current current)
void	unloadCollections(Ice.Current current) Each collection can also be unloaded, independently of the object itself.
void	unloadDeltaT()
void	unloadDetails(Ice.Current current) As with collections, the objects under details can link to many other objects.
void	unloadExposureTime()
void	unloadPixels()
void	unloadPositionX()
void	unloadPositionY()
void	unloadPositionZ()
void	unloadTheC()
void	unloadTheT()
void	unloadTheZ()

Methods inherited from class omero.model.PlaneInfo

___addAllPlaneInfoAnnotationLinkSet, ___addPlaneInfoAnnotationLink, ___addPlaneInfoAnnotationLinkToBoth, ___clearAnnotationLinks, ___copyAnnotationLinks, ___findPlaneInfoAnnotationLink, ___getAnnotationLinksCountPerOwner, ___getDeltaT, ___getExposureTime, ___getPixels, ___getPositionX, ___getPositionY, ___getPositionZ, ___getTheC, ___getTheT, ___getTheZ, ___getVersion, ___linkAnnotation, ___linkedAnnotationList, ___reloadAnnotationLinks, ___removeAllPlaneInfoAnnotationLinkSet, ___removePlaneInfoAnnotationLink, ___removePlaneInfoAnnotationLinkFromBoth, ___setDeltaT, ___setExposureTime, ___setPixels, ___setPositionX, ___setPositionY, ___setPositionZ, ___setTheC, ___setTheT, ___setTheZ, ___setVersion, ___sizeOfAnnotationLinks, ___unlinkAnnotation, ___unloadAnnotationLinks, __dispatch, __readImpl, __writeImpl, addAllPlaneInfoAnnotationLinkSet, addPlaneInfoAnnotationLink, addPlaneInfoAnnotationLinkToBoth, clearAnnotationLinks, clone, copyAnnotationLinks, findPlaneInfoAnnotationLink, getAnnotationLinksCountPerOwner, getDeltaT, getExposureTime, getPixels, getPositionX, getPositionY, getPositionZ, getTheC, getTheT, getTheZ, getVersion, ice_id, ice_id, ice_ids, ice_ids, ice_isA, ice_isA, ice_staticId, linkAnnotation, linkedAnnotationList, reloadAnnotationLinks, removeAllPlaneInfoAnnotationLinkSet, removePlaneInfoAnnotationLink, removePlaneInfoAnnotationLinkFromBoth, setDeltaT, setExposureTime, setPixels, setPositionX, setPositionY, setPositionZ, setTheC, setTheT, setTheZ, setVersion, sizeOfAnnotationLinks, unlinkAnnotation, unloadAnnotationLinks

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

PIXELS

public static final java.lang.String PIXELS

See Also:

Constant Field Values

THEZ

public static final java.lang.String THEZ

See Also:

Constant Field Values

THEC

public static final java.lang.String THEC

See Also:

Constant Field Values

THET

public static final java.lang.String THET

See Also:

Constant Field Values

DELTAT

public static final java.lang.String DELTAT

See Also:

Constant Field Values

POSITIONX

public static final java.lang.String POSITIONX

See Also:

Constant Field Values

POSITIONY

public static final java.lang.String POSITIONY

See Also:

Constant Field Values

POSITIONZ

public static final java.lang.String POSITIONZ

See Also:

Constant Field Values

EXPOSURETIME

public static final java.lang.String EXPOSURETIME

See Also:

Constant Field Values

ANNOTATIONLINKS

public static final java.lang.String ANNOTATIONLINKS

See Also:

Constant Field Values

DETAILS

public static final java.lang.String DETAILS

See Also:

Constant Field Values

Constructor Detail

PlaneInfoI

public PlaneInfoI()

PlaneInfoI

public PlaneInfoI(long id,
                  boolean loaded)

PlaneInfoI

public PlaneInfoI(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 _PlaneInfoOperations

setVersion

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

Specified by:

setVersion in interface _PlaneInfoOperations

unloadPixels

public void unloadPixels()

getPixels

public Pixels getPixels(Ice.Current current)
                 throws UnloadedEntityException

Specified by:

getPixels in interface _PlaneInfoOperations

Throws:

UnloadedEntityException

setPixels

public void setPixels(Pixels pixels,
                      Ice.Current current)
               throws UnloadedEntityException

Specified by:

setPixels in interface _PlaneInfoOperations

Throws:

UnloadedEntityException

unloadTheZ

public void unloadTheZ()

getTheZ

public RInt getTheZ(Ice.Current current)
             throws UnloadedEntityException

Specified by:

getTheZ in interface _PlaneInfoOperations

Throws:

UnloadedEntityException

setTheZ

public void setTheZ(RInt theZ,
                    Ice.Current current)
             throws UnloadedEntityException

Specified by:

setTheZ in interface _PlaneInfoOperations

Throws:

UnloadedEntityException

unloadTheC

public void unloadTheC()

getTheC

public RInt getTheC(Ice.Current current)
             throws UnloadedEntityException

Specified by:

getTheC in interface _PlaneInfoOperations

Throws:

UnloadedEntityException

setTheC

public void setTheC(RInt theC,
                    Ice.Current current)
             throws UnloadedEntityException

Specified by:

setTheC in interface _PlaneInfoOperations

Throws:

UnloadedEntityException

unloadTheT

public void unloadTheT()

getTheT

public RInt getTheT(Ice.Current current)
             throws UnloadedEntityException

Specified by:

getTheT in interface _PlaneInfoOperations

Throws:

UnloadedEntityException

setTheT

public void setTheT(RInt theT,
                    Ice.Current current)
             throws UnloadedEntityException

Specified by:

setTheT in interface _PlaneInfoOperations

Throws:

UnloadedEntityException

unloadDeltaT

public void unloadDeltaT()

getDeltaT

public Time getDeltaT(Ice.Current current)
               throws UnloadedEntityException

Specified by:

getDeltaT in interface _PlaneInfoOperations

Throws:

UnloadedEntityException

setDeltaT

public void setDeltaT(Time deltaT,
                      Ice.Current current)
               throws UnloadedEntityException

Specified by:

setDeltaT in interface _PlaneInfoOperations

Throws:

UnloadedEntityException

unloadPositionX

public void unloadPositionX()

getPositionX

public Length getPositionX(Ice.Current current)
                    throws UnloadedEntityException

Specified by:

getPositionX in interface _PlaneInfoOperations

Throws:

UnloadedEntityException

setPositionX

public void setPositionX(Length positionX,
                         Ice.Current current)
                  throws UnloadedEntityException

Specified by:

setPositionX in interface _PlaneInfoOperations

Throws:

UnloadedEntityException

unloadPositionY

public void unloadPositionY()

getPositionY

public Length getPositionY(Ice.Current current)
                    throws UnloadedEntityException

Specified by:

getPositionY in interface _PlaneInfoOperations

Throws:

UnloadedEntityException

setPositionY

public void setPositionY(Length positionY,
                         Ice.Current current)
                  throws UnloadedEntityException

Specified by:

setPositionY in interface _PlaneInfoOperations

Throws:

UnloadedEntityException

unloadPositionZ

public void unloadPositionZ()

getPositionZ

public Length getPositionZ(Ice.Current current)
                    throws UnloadedEntityException

Specified by:

getPositionZ in interface _PlaneInfoOperations

Throws:

UnloadedEntityException

setPositionZ

public void setPositionZ(Length positionZ,
                         Ice.Current current)
                  throws UnloadedEntityException

Specified by:

setPositionZ in interface _PlaneInfoOperations

Throws:

UnloadedEntityException

unloadExposureTime

public void unloadExposureTime()

getExposureTime

public Time getExposureTime(Ice.Current current)
                     throws UnloadedEntityException

Specified by:

getExposureTime in interface _PlaneInfoOperations

Throws:

UnloadedEntityException

setExposureTime

public void setExposureTime(Time exposureTime,
                            Ice.Current current)
                     throws UnloadedEntityException

Specified by:

setExposureTime in interface _PlaneInfoOperations

Throws:

UnloadedEntityException

unloadAnnotationLinks

public void unloadAnnotationLinks(Ice.Current current)

Specified by:

unloadAnnotationLinks in interface _PlaneInfoOperations

getAnnotationLinks

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

Throws:

UnloadedEntityException

setAnnotationLinks

protected void setAnnotationLinks(java.util.List annotationLinks,
                                  Ice.Current current)
                           throws UnloadedEntityException

Throws:

UnloadedEntityException

isAnnotationLinksLoaded

public boolean isAnnotationLinksLoaded()

sizeOfAnnotationLinks

public int sizeOfAnnotationLinks(Ice.Current current)
                          throws UnloadedEntityException

Specified by:

sizeOfAnnotationLinks in interface _PlaneInfoOperations

Throws:

UnloadedEntityException

copyAnnotationLinks

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

Specified by:

copyAnnotationLinks in interface _PlaneInfoOperations

Throws:

UnloadedEntityException

iterateAnnotationLinks

public java.util.Iterator iterateAnnotationLinks()
                                          throws UnloadedEntityException

Throws:

UnloadedEntityException

addPlaneInfoAnnotationLink

public void addPlaneInfoAnnotationLink(PlaneInfoAnnotationLink target,
                                       Ice.Current current)
                                throws UnloadedEntityException

Specified by:

addPlaneInfoAnnotationLink in interface _PlaneInfoOperations

Throws:

UnloadedEntityException

addAllPlaneInfoAnnotationLinkSet

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

Specified by:

addAllPlaneInfoAnnotationLinkSet in interface _PlaneInfoOperations

Throws:

UnloadedEntityException

removePlaneInfoAnnotationLink

public void removePlaneInfoAnnotationLink(PlaneInfoAnnotationLink target,
                                          Ice.Current current)
                                   throws UnloadedEntityException

Specified by:

removePlaneInfoAnnotationLink in interface _PlaneInfoOperations

Throws:

UnloadedEntityException

removeAllPlaneInfoAnnotationLinkSet

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

Specified by:

removeAllPlaneInfoAnnotationLinkSet in interface _PlaneInfoOperations

Throws:

UnloadedEntityException

clearAnnotationLinks

public void clearAnnotationLinks(Ice.Current current)
                          throws UnloadedEntityException

Specified by:

clearAnnotationLinks in interface _PlaneInfoOperations

Throws:

UnloadedEntityException

reloadAnnotationLinks

public void reloadAnnotationLinks(PlaneInfo toCopy,
                                  Ice.Current current)
                           throws UnloadedEntityException

Specified by:

reloadAnnotationLinks in interface _PlaneInfoOperations

Throws:

UnloadedEntityException

getAnnotationLinksCountPerOwner

public java.util.Map<java.lang.Long,java.lang.Long> getAnnotationLinksCountPerOwner(Ice.Current current)

Specified by:

getAnnotationLinksCountPerOwner in interface _PlaneInfoOperations

linkAnnotation

public PlaneInfoAnnotationLink linkAnnotation(Annotation addition,
                                              Ice.Current current)
                                       throws UnloadedEntityException

Specified by:

linkAnnotation in interface _PlaneInfoOperations

Throws:

UnloadedEntityException

addPlaneInfoAnnotationLinkToBoth

public void addPlaneInfoAnnotationLinkToBoth(PlaneInfoAnnotationLink link,
                                             boolean bothSides,
                                             Ice.Current current)
                                      throws UnloadedEntityException

Specified by:

addPlaneInfoAnnotationLinkToBoth in interface _PlaneInfoOperations

Throws:

UnloadedEntityException

findPlaneInfoAnnotationLink

public java.util.List<PlaneInfoAnnotationLink> findPlaneInfoAnnotationLink(Annotation removal,
                                                                           Ice.Current current)
                                                                    throws UnloadedEntityException

Specified by:

findPlaneInfoAnnotationLink in interface _PlaneInfoOperations

Throws:

UnloadedEntityException

unlinkAnnotation

public void unlinkAnnotation(Annotation removal,
                             Ice.Current current)
                      throws UnloadedEntityException

Specified by:

unlinkAnnotation in interface _PlaneInfoOperations

Throws:

UnloadedEntityException

removePlaneInfoAnnotationLinkFromBoth

public void removePlaneInfoAnnotationLinkFromBoth(PlaneInfoAnnotationLink link,
                                                  boolean bothSides,
                                                  Ice.Current current)
                                           throws UnloadedEntityException,
                                                  UnloadedCollectionException

Specified by:

removePlaneInfoAnnotationLinkFromBoth in interface _PlaneInfoOperations

Throws:

UnloadedEntityException

UnloadedCollectionException

linkedAnnotationList

public java.util.List<Annotation> linkedAnnotationList(Ice.Current current)
                                                throws UnloadedEntityException

Specified by:

linkedAnnotationList in interface _PlaneInfoOperations

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

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

Throws:

java.lang.ClassCastException