omero.model

Class PlaneSlicingContextI

java.lang.Object

Ice.ObjectImpl

omero.model.IObject

omero.model.CodomainMapContext

omero.model.PlaneSlicingContext

omero.model.PlaneSlicingContextI

All Implemented Interfaces:

Ice.Object, java.io.Serializable, java.lang.Cloneable, ome.model.ModelBased, _CodomainMapContextOperations, _CodomainMapContextOperationsNC, _IObjectOperations, _IObjectOperationsNC, _PlaneSlicingContextOperations, _PlaneSlicingContextOperationsNC

public class PlaneSlicingContextI
extends PlaneSlicingContext
implements ome.model.ModelBased

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CHANNELBINDING
static java.lang.String	CONSTANT
static java.lang.String	DETAILS
static java.lang.String	LOWERLIMIT
static java.lang.String	PLANEPREVIOUS
static java.lang.String	PLANESELECTED
static java.lang.String	UPPERLIMIT

Fields inherited from class omero.model.PlaneSlicingContext

__ids, constant, lowerLimit, planePrevious, planeSelected, serialVersionUID, upperLimit

Fields inherited from class omero.model.CodomainMapContext

channelBinding, 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
PlaneSlicingContextI()
PlaneSlicingContextI(long id, boolean loaded)
PlaneSlicingContextI(RLong id, boolean loaded)

Method Summary

Modifier and Type	Method and Description
static java.util.List<PlaneSlicingContextI>	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.
ChannelBinding	getChannelBinding(Ice.Current current)
RBool	getConstant(Ice.Current current)
Details	getDetails(Ice.Current current)
RLong	getId(Ice.Current current)
RInt	getLowerLimit(Ice.Current current)
RInt	getPlanePrevious(Ice.Current current)
RInt	getPlaneSelected(Ice.Current current)
RInt	getUpperLimit(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	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	setChannelBinding(ChannelBinding channelBinding, Ice.Current current)
void	setConstant(RBool constant, Ice.Current current)
void	setId(RLong id, Ice.Current current)
void	setLowerLimit(RInt lowerLimit, Ice.Current current)
void	setPlanePrevious(RInt planePrevious, Ice.Current current)
void	setPlaneSelected(RInt planeSelected, Ice.Current current)
void	setUpperLimit(RInt upperLimit, 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.
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	unloadChannelBinding()
void	unloadCollections(Ice.Current current) Each collection can also be unloaded, independently of the object itself.
void	unloadConstant()
void	unloadDetails(Ice.Current current) As with collections, the objects under details can link to many other objects.
void	unloadLowerLimit()
void	unloadPlanePrevious()
void	unloadPlaneSelected()
void	unloadUpperLimit()

Methods inherited from class omero.model.PlaneSlicingContext

___getConstant, ___getLowerLimit, ___getPlanePrevious, ___getPlaneSelected, ___getUpperLimit, ___setConstant, ___setLowerLimit, ___setPlanePrevious, ___setPlaneSelected, ___setUpperLimit, __dispatch, __readImpl, __writeImpl, clone, getConstant, getLowerLimit, getPlanePrevious, getPlaneSelected, getUpperLimit, ice_id, ice_id, ice_ids, ice_ids, ice_isA, ice_isA, ice_staticId, setConstant, setLowerLimit, setPlanePrevious, setPlaneSelected, setUpperLimit

Methods inherited from class omero.model.CodomainMapContext

___getChannelBinding, ___getVersion, ___setChannelBinding, ___setVersion, getChannelBinding, getVersion, setChannelBinding, setVersion

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

getChannelBinding, getVersion, setChannelBinding, setVersion

Methods inherited from interface omero.model._IObjectOperationsNC

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

Field Detail

UPPERLIMIT

public static final java.lang.String UPPERLIMIT

See Also:

Constant Field Values

LOWERLIMIT

public static final java.lang.String LOWERLIMIT

See Also:

Constant Field Values

PLANESELECTED

public static final java.lang.String PLANESELECTED

See Also:

Constant Field Values

PLANEPREVIOUS

public static final java.lang.String PLANEPREVIOUS

See Also:

Constant Field Values

CONSTANT

public static final java.lang.String CONSTANT

See Also:

Constant Field Values

CHANNELBINDING

public static final java.lang.String CHANNELBINDING

See Also:

Constant Field Values

DETAILS

public static final java.lang.String DETAILS

See Also:

Constant Field Values

Constructor Detail

PlaneSlicingContextI

public PlaneSlicingContextI()

PlaneSlicingContextI

public PlaneSlicingContextI(long id,
                            boolean loaded)

PlaneSlicingContextI

public PlaneSlicingContextI(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 _CodomainMapContextOperations

setVersion

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

Specified by:

setVersion in interface _CodomainMapContextOperations

unloadUpperLimit

public void unloadUpperLimit()

getUpperLimit

public RInt getUpperLimit(Ice.Current current)
                   throws UnloadedEntityException

Specified by:

getUpperLimit in interface _PlaneSlicingContextOperations

Throws:

UnloadedEntityException

setUpperLimit

public void setUpperLimit(RInt upperLimit,
                          Ice.Current current)
                   throws UnloadedEntityException

Specified by:

setUpperLimit in interface _PlaneSlicingContextOperations

Throws:

UnloadedEntityException

unloadLowerLimit

public void unloadLowerLimit()

getLowerLimit

public RInt getLowerLimit(Ice.Current current)
                   throws UnloadedEntityException

Specified by:

getLowerLimit in interface _PlaneSlicingContextOperations

Throws:

UnloadedEntityException

setLowerLimit

public void setLowerLimit(RInt lowerLimit,
                          Ice.Current current)
                   throws UnloadedEntityException

Specified by:

setLowerLimit in interface _PlaneSlicingContextOperations

Throws:

UnloadedEntityException

unloadPlaneSelected

public void unloadPlaneSelected()

getPlaneSelected

public RInt getPlaneSelected(Ice.Current current)
                      throws UnloadedEntityException

Specified by:

getPlaneSelected in interface _PlaneSlicingContextOperations

Throws:

UnloadedEntityException

setPlaneSelected

public void setPlaneSelected(RInt planeSelected,
                             Ice.Current current)
                      throws UnloadedEntityException

Specified by:

setPlaneSelected in interface _PlaneSlicingContextOperations

Throws:

UnloadedEntityException

unloadPlanePrevious

public void unloadPlanePrevious()

getPlanePrevious

public RInt getPlanePrevious(Ice.Current current)
                      throws UnloadedEntityException

Specified by:

getPlanePrevious in interface _PlaneSlicingContextOperations

Throws:

UnloadedEntityException

setPlanePrevious

public void setPlanePrevious(RInt planePrevious,
                             Ice.Current current)
                      throws UnloadedEntityException

Specified by:

setPlanePrevious in interface _PlaneSlicingContextOperations

Throws:

UnloadedEntityException

unloadConstant

public void unloadConstant()

getConstant

public RBool getConstant(Ice.Current current)
                  throws UnloadedEntityException

Specified by:

getConstant in interface _PlaneSlicingContextOperations

Throws:

UnloadedEntityException

setConstant

public void setConstant(RBool constant,
                        Ice.Current current)
                 throws UnloadedEntityException

Specified by:

setConstant in interface _PlaneSlicingContextOperations

Throws:

UnloadedEntityException

unloadChannelBinding

public void unloadChannelBinding()

getChannelBinding

public ChannelBinding getChannelBinding(Ice.Current current)
                                 throws UnloadedEntityException

Specified by:

getChannelBinding in interface _CodomainMapContextOperations

Throws:

UnloadedEntityException

setChannelBinding

public void setChannelBinding(ChannelBinding channelBinding,
                              Ice.Current current)
                       throws UnloadedEntityException

Specified by:

setChannelBinding in interface _CodomainMapContextOperations

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

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

Throws:

java.lang.ClassCastException