omero.model

Class ProjectionDefI

java.lang.Object

Ice.ObjectImpl

omero.model.IObject

omero.model.ProjectionDef

omero.model.ProjectionDefI

All Implemented Interfaces:

Ice.Object, java.io.Serializable, java.lang.Cloneable, ome.model.ModelBased, _IObjectOperations, _IObjectOperationsNC, _ProjectionDefOperations, _ProjectionDefOperationsNC

public class ProjectionDefI
extends ProjectionDef
implements ome.model.ModelBased

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTIVE
static java.lang.String	AXIS
static java.lang.String	DETAILS
static java.lang.String	ENDPLANE
static java.lang.String	RENDERINGDEF
static java.lang.String	STARTPLANE
static java.lang.String	STEPPING
static java.lang.String	TYPE

Fields inherited from class omero.model.ProjectionDef

__ids, active, axis, endPlane, renderingDef, serialVersionUID, startPlane, stepping, type, 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
ProjectionDefI()
ProjectionDefI(long id, boolean loaded)
ProjectionDefI(RLong id, boolean loaded)

Method Summary

Modifier and Type	Method and Description
static java.util.List<ProjectionDefI>	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.
RBool	getActive(Ice.Current current)
ProjectionAxis	getAxis(Ice.Current current)
Details	getDetails(Ice.Current current)
RInt	getEndPlane(Ice.Current current)
RLong	getId(Ice.Current current)
RenderingDef	getRenderingDef(Ice.Current current)
RInt	getStartPlane(Ice.Current current)
RInt	getStepping(Ice.Current current)
ProjectionType	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	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	setActive(RBool active, Ice.Current current)
void	setAxis(ProjectionAxis axis, Ice.Current current)
void	setEndPlane(RInt endPlane, Ice.Current current)
void	setId(RLong id, Ice.Current current)
void	setRenderingDef(RenderingDef renderingDef, Ice.Current current)
void	setStartPlane(RInt startPlane, Ice.Current current)
void	setStepping(RInt stepping, Ice.Current current)
void	setType(ProjectionType 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.
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	unloadActive()
void	unloadAxis()
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	unloadEndPlane()
void	unloadRenderingDef()
void	unloadStartPlane()
void	unloadStepping()
void	unloadType()

Methods inherited from class omero.model.ProjectionDef

___getActive, ___getAxis, ___getEndPlane, ___getRenderingDef, ___getStartPlane, ___getStepping, ___getType, ___getVersion, ___setActive, ___setAxis, ___setEndPlane, ___setRenderingDef, ___setStartPlane, ___setStepping, ___setType, ___setVersion, __dispatch, __readImpl, __writeImpl, clone, getActive, getAxis, getEndPlane, getRenderingDef, getStartPlane, getStepping, getType, getVersion, ice_id, ice_id, ice_ids, ice_ids, ice_isA, ice_isA, ice_staticId, setActive, setAxis, setEndPlane, setRenderingDef, setStartPlane, setStepping, setType, 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._IObjectOperationsNC

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

Field Detail

RENDERINGDEF

public static final java.lang.String RENDERINGDEF

See Also:

Constant Field Values

AXIS

public static final java.lang.String AXIS

See Also:

Constant Field Values

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

ACTIVE

public static final java.lang.String ACTIVE

See Also:

Constant Field Values

STARTPLANE

public static final java.lang.String STARTPLANE

See Also:

Constant Field Values

ENDPLANE

public static final java.lang.String ENDPLANE

See Also:

Constant Field Values

STEPPING

public static final java.lang.String STEPPING

See Also:

Constant Field Values

DETAILS

public static final java.lang.String DETAILS

See Also:

Constant Field Values

Constructor Detail

ProjectionDefI

public ProjectionDefI()

ProjectionDefI

public ProjectionDefI(long id,
                      boolean loaded)

ProjectionDefI

public ProjectionDefI(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 _ProjectionDefOperations

setVersion

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

Specified by:

setVersion in interface _ProjectionDefOperations

unloadRenderingDef

public void unloadRenderingDef()

getRenderingDef

public RenderingDef getRenderingDef(Ice.Current current)
                             throws UnloadedEntityException

Specified by:

getRenderingDef in interface _ProjectionDefOperations

Throws:

UnloadedEntityException

setRenderingDef

public void setRenderingDef(RenderingDef renderingDef,
                            Ice.Current current)
                     throws UnloadedEntityException

Specified by:

setRenderingDef in interface _ProjectionDefOperations

Throws:

UnloadedEntityException

unloadAxis

public void unloadAxis()

getAxis

public ProjectionAxis getAxis(Ice.Current current)
                       throws UnloadedEntityException

Specified by:

getAxis in interface _ProjectionDefOperations

Throws:

UnloadedEntityException

setAxis

public void setAxis(ProjectionAxis axis,
                    Ice.Current current)
             throws UnloadedEntityException

Specified by:

setAxis in interface _ProjectionDefOperations

Throws:

UnloadedEntityException

unloadType

public void unloadType()

getType

public ProjectionType getType(Ice.Current current)
                       throws UnloadedEntityException

Specified by:

getType in interface _ProjectionDefOperations

Throws:

UnloadedEntityException

setType

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

Specified by:

setType in interface _ProjectionDefOperations

Throws:

UnloadedEntityException

unloadActive

public void unloadActive()

getActive

public RBool getActive(Ice.Current current)
                throws UnloadedEntityException

Specified by:

getActive in interface _ProjectionDefOperations

Throws:

UnloadedEntityException

setActive

public void setActive(RBool active,
                      Ice.Current current)
               throws UnloadedEntityException

Specified by:

setActive in interface _ProjectionDefOperations

Throws:

UnloadedEntityException

unloadStartPlane

public void unloadStartPlane()

getStartPlane

public RInt getStartPlane(Ice.Current current)
                   throws UnloadedEntityException

Specified by:

getStartPlane in interface _ProjectionDefOperations

Throws:

UnloadedEntityException

setStartPlane

public void setStartPlane(RInt startPlane,
                          Ice.Current current)
                   throws UnloadedEntityException

Specified by:

setStartPlane in interface _ProjectionDefOperations

Throws:

UnloadedEntityException

unloadEndPlane

public void unloadEndPlane()

getEndPlane

public RInt getEndPlane(Ice.Current current)
                 throws UnloadedEntityException

Specified by:

getEndPlane in interface _ProjectionDefOperations

Throws:

UnloadedEntityException

setEndPlane

public void setEndPlane(RInt endPlane,
                        Ice.Current current)
                 throws UnloadedEntityException

Specified by:

setEndPlane in interface _ProjectionDefOperations

Throws:

UnloadedEntityException

unloadStepping

public void unloadStepping()

getStepping

public RInt getStepping(Ice.Current current)
                 throws UnloadedEntityException

Specified by:

getStepping in interface _ProjectionDefOperations

Throws:

UnloadedEntityException

setStepping

public void setStepping(RInt stepping,
                        Ice.Current current)
                 throws UnloadedEntityException

Specified by:

setStepping in interface _ProjectionDefOperations

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

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

Throws:

java.lang.ClassCastException