omero.model

Class OTFI

java.lang.Object

Ice.ObjectImpl

omero.model.IObject

omero.model.OTF

omero.model.OTFI

All Implemented Interfaces:

Ice.Object, java.io.Serializable, java.lang.Cloneable, ome.model.ModelBased, _IObjectOperations, _IObjectOperationsNC, _OTFOperations, _OTFOperationsNC

public class OTFI
extends OTF
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	FILTERSET
static java.lang.String	INSTRUMENT
static java.lang.String	OBJECTIVE
static java.lang.String	OPTICALAXISAVERAGED
static java.lang.String	PATH
static java.lang.String	PIXELSTYPE
static java.lang.String	SIZEX
static java.lang.String	SIZEY

Fields inherited from class omero.model.OTF

__ids, filterSet, instrument, objective, opticalAxisAveraged, path, pixelsType, serialVersionUID, sizeX, sizeY, 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
OTFI()
OTFI(long id, boolean loaded)
OTFI(RLong id, boolean loaded)

Method Summary

Modifier and Type	Method and Description
static java.util.List<OTFI>	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)
FilterSet	getFilterSet(Ice.Current current)
RLong	getId(Ice.Current current)
Instrument	getInstrument(Ice.Current current)
Objective	getObjective(Ice.Current current)
RBool	getOpticalAxisAveraged(Ice.Current current)
RString	getPath(Ice.Current current)
PixelsType	getPixelsType(Ice.Current current)
RInt	getSizeX(Ice.Current current)
RInt	getSizeY(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	setFilterSet(FilterSet filterSet, Ice.Current current)
void	setId(RLong id, Ice.Current current)
void	setInstrument(Instrument instrument, Ice.Current current)
void	setObjective(Objective objective, Ice.Current current)
void	setOpticalAxisAveraged(RBool opticalAxisAveraged, Ice.Current current)
void	setPath(RString path, Ice.Current current)
void	setPixelsType(PixelsType pixelsType, Ice.Current current)
void	setSizeX(RInt sizeX, Ice.Current current)
void	setSizeY(RInt sizeY, 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	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	unloadFilterSet()
void	unloadInstrument()
void	unloadObjective()
void	unloadOpticalAxisAveraged()
void	unloadPath()
void	unloadPixelsType()
void	unloadSizeX()
void	unloadSizeY()

Methods inherited from class omero.model.OTF

___getFilterSet, ___getInstrument, ___getObjective, ___getOpticalAxisAveraged, ___getPath, ___getPixelsType, ___getSizeX, ___getSizeY, ___getVersion, ___setFilterSet, ___setInstrument, ___setObjective, ___setOpticalAxisAveraged, ___setPath, ___setPixelsType, ___setSizeX, ___setSizeY, ___setVersion, __dispatch, __readImpl, __writeImpl, clone, getFilterSet, getInstrument, getObjective, getOpticalAxisAveraged, getPath, getPixelsType, getSizeX, getSizeY, getVersion, ice_id, ice_id, ice_ids, ice_ids, ice_isA, ice_isA, ice_staticId, setFilterSet, setInstrument, setObjective, setOpticalAxisAveraged, setPath, setPixelsType, setSizeX, setSizeY, 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

SIZEX

public static final java.lang.String SIZEX

See Also:

Constant Field Values

SIZEY

public static final java.lang.String SIZEY

See Also:

Constant Field Values

OPTICALAXISAVERAGED

public static final java.lang.String OPTICALAXISAVERAGED

See Also:

Constant Field Values

PIXELSTYPE

public static final java.lang.String PIXELSTYPE

See Also:

Constant Field Values

PATH

public static final java.lang.String PATH

See Also:

Constant Field Values

FILTERSET

public static final java.lang.String FILTERSET

See Also:

Constant Field Values

OBJECTIVE

public static final java.lang.String OBJECTIVE

See Also:

Constant Field Values

INSTRUMENT

public static final java.lang.String INSTRUMENT

See Also:

Constant Field Values

DETAILS

public static final java.lang.String DETAILS

See Also:

Constant Field Values

Constructor Detail

OTFI

public OTFI()

OTFI

public OTFI(long id,
            boolean loaded)

OTFI

public OTFI(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 _OTFOperations

setVersion

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

Specified by:

setVersion in interface _OTFOperations

unloadSizeX

public void unloadSizeX()

getSizeX

public RInt getSizeX(Ice.Current current)
              throws UnloadedEntityException

Specified by:

getSizeX in interface _OTFOperations

Throws:

UnloadedEntityException

setSizeX

public void setSizeX(RInt sizeX,
                     Ice.Current current)
              throws UnloadedEntityException

Specified by:

setSizeX in interface _OTFOperations

Throws:

UnloadedEntityException

unloadSizeY

public void unloadSizeY()

getSizeY

public RInt getSizeY(Ice.Current current)
              throws UnloadedEntityException

Specified by:

getSizeY in interface _OTFOperations

Throws:

UnloadedEntityException

setSizeY

public void setSizeY(RInt sizeY,
                     Ice.Current current)
              throws UnloadedEntityException

Specified by:

setSizeY in interface _OTFOperations

Throws:

UnloadedEntityException

unloadOpticalAxisAveraged

public void unloadOpticalAxisAveraged()

getOpticalAxisAveraged

public RBool getOpticalAxisAveraged(Ice.Current current)
                             throws UnloadedEntityException

Specified by:

getOpticalAxisAveraged in interface _OTFOperations

Throws:

UnloadedEntityException

setOpticalAxisAveraged

public void setOpticalAxisAveraged(RBool opticalAxisAveraged,
                                   Ice.Current current)
                            throws UnloadedEntityException

Specified by:

setOpticalAxisAveraged in interface _OTFOperations

Throws:

UnloadedEntityException

unloadPixelsType

public void unloadPixelsType()

getPixelsType

public PixelsType getPixelsType(Ice.Current current)
                         throws UnloadedEntityException

Specified by:

getPixelsType in interface _OTFOperations

Throws:

UnloadedEntityException

setPixelsType

public void setPixelsType(PixelsType pixelsType,
                          Ice.Current current)
                   throws UnloadedEntityException

Specified by:

setPixelsType in interface _OTFOperations

Throws:

UnloadedEntityException

unloadPath

public void unloadPath()

getPath

public RString getPath(Ice.Current current)
                throws UnloadedEntityException

Specified by:

getPath in interface _OTFOperations

Throws:

UnloadedEntityException

setPath

public void setPath(RString path,
                    Ice.Current current)
             throws UnloadedEntityException

Specified by:

setPath in interface _OTFOperations

Throws:

UnloadedEntityException

unloadFilterSet

public void unloadFilterSet()

getFilterSet

public FilterSet getFilterSet(Ice.Current current)
                       throws UnloadedEntityException

Specified by:

getFilterSet in interface _OTFOperations

Throws:

UnloadedEntityException

setFilterSet

public void setFilterSet(FilterSet filterSet,
                         Ice.Current current)
                  throws UnloadedEntityException

Specified by:

setFilterSet in interface _OTFOperations

Throws:

UnloadedEntityException

unloadObjective

public void unloadObjective()

getObjective

public Objective getObjective(Ice.Current current)
                       throws UnloadedEntityException

Specified by:

getObjective in interface _OTFOperations

Throws:

UnloadedEntityException

setObjective

public void setObjective(Objective objective,
                         Ice.Current current)
                  throws UnloadedEntityException

Specified by:

setObjective in interface _OTFOperations

Throws:

UnloadedEntityException

unloadInstrument

public void unloadInstrument()

getInstrument

public Instrument getInstrument(Ice.Current current)
                         throws UnloadedEntityException

Specified by:

getInstrument in interface _OTFOperations

Throws:

UnloadedEntityException

setInstrument

public void setInstrument(Instrument instrument,
                          Ice.Current current)
                   throws UnloadedEntityException

Specified by:

setInstrument in interface _OTFOperations

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

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

Throws:

java.lang.ClassCastException