omero.model

Class GenericExcitationSourceI

java.lang.Object

Ice.ObjectImpl

omero.model.IObject

omero.model.LightSource

omero.model.GenericExcitationSource

omero.model.GenericExcitationSourceI

All Implemented Interfaces:

Ice.Object, java.io.Serializable, java.lang.Cloneable, ome.model.ModelBased, _GenericExcitationSourceOperations, _GenericExcitationSourceOperationsNC, _IObjectOperations, _IObjectOperationsNC, _LightSourceOperations, _LightSourceOperationsNC

public class GenericExcitationSourceI
extends GenericExcitationSource
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	DETAILS
static java.lang.String	INSTRUMENT
static java.lang.String	LOTNUMBER
static java.lang.String	MANUFACTURER
static java.lang.String	MAP
static java.lang.String	MODEL
static java.lang.String	POWER
static java.lang.String	SERIALNUMBER

Fields inherited from class omero.model.GenericExcitationSource

__ids, map, serialVersionUID

Fields inherited from class omero.model.LightSource

annotationLinksCountPerOwner, annotationLinksLoaded, annotationLinksSeq, instrument, lotNumber, manufacturer, model, power, serialNumber, 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
GenericExcitationSourceI()
GenericExcitationSourceI(long id, boolean loaded)
GenericExcitationSourceI(RLong id, boolean loaded)

Method Summary

Modifier and Type	Method and Description
void	addAllLightSourceAnnotationLinkSet(java.util.List<LightSourceAnnotationLink> targets, Ice.Current current)
void	addLightSourceAnnotationLink(LightSourceAnnotationLink target, Ice.Current current)
void	addLightSourceAnnotationLinkToBoth(LightSourceAnnotationLink link, boolean bothSides, Ice.Current current)
static java.util.List<GenericExcitationSourceI>	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<LightSourceAnnotationLink>	findLightSourceAnnotationLink(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)
Details	getDetails(Ice.Current current)
RLong	getId(Ice.Current current)
Instrument	getInstrument(Ice.Current current)
RString	getLotNumber(Ice.Current current)
RString	getManufacturer(Ice.Current current)
java.util.List<NamedValue>	getMap(Ice.Current current)
java.util.Map<java.lang.String,java.lang.String>	getMapAsMap(Ice.Current current)
RString	getModel(Ice.Current current)
Power	getPower(Ice.Current current)
RString	getSerialNumber(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()
LightSourceAnnotationLink	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(LightSource toCopy, Ice.Current current)
void	removeAllLightSourceAnnotationLinkSet(java.util.List<LightSourceAnnotationLink> targets, Ice.Current current)
void	removeLightSourceAnnotationLink(LightSourceAnnotationLink target, Ice.Current current)
void	removeLightSourceAnnotationLinkFromBoth(LightSourceAnnotationLink link, boolean bothSides, Ice.Current current)
protected void	setAnnotationLinks(java.util.List annotationLinks, Ice.Current current)
void	setId(RLong id, Ice.Current current)
void	setInstrument(Instrument instrument, Ice.Current current)
void	setLotNumber(RString lotNumber, Ice.Current current)
void	setManufacturer(RString manufacturer, Ice.Current current)
void	setMap(java.util.List<NamedValue> map, Ice.Current current)
void	setModel(RString model, Ice.Current current)
void	setPower(Power power, Ice.Current current)
void	setSerialNumber(RString serialNumber, 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	unloadDetails(Ice.Current current) As with collections, the objects under details can link to many other objects.
void	unloadInstrument()
void	unloadLotNumber()
void	unloadManufacturer()
void	unloadMap()
void	unloadModel()
void	unloadPower()
void	unloadSerialNumber()

Methods inherited from class omero.model.GenericExcitationSource

___getMap, ___getMapAsMap, ___setMap, __dispatch, __readImpl, __writeImpl, clone, getMap, getMapAsMap, ice_id, ice_id, ice_ids, ice_ids, ice_isA, ice_isA, ice_staticId, setMap

Methods inherited from class omero.model.LightSource

___addAllLightSourceAnnotationLinkSet, ___addLightSourceAnnotationLink, ___addLightSourceAnnotationLinkToBoth, ___clearAnnotationLinks, ___copyAnnotationLinks, ___findLightSourceAnnotationLink, ___getAnnotationLinksCountPerOwner, ___getInstrument, ___getLotNumber, ___getManufacturer, ___getModel, ___getPower, ___getSerialNumber, ___getVersion, ___linkAnnotation, ___linkedAnnotationList, ___reloadAnnotationLinks, ___removeAllLightSourceAnnotationLinkSet, ___removeLightSourceAnnotationLink, ___removeLightSourceAnnotationLinkFromBoth, ___setInstrument, ___setLotNumber, ___setManufacturer, ___setModel, ___setPower, ___setSerialNumber, ___setVersion, ___sizeOfAnnotationLinks, ___unlinkAnnotation, ___unloadAnnotationLinks, addAllLightSourceAnnotationLinkSet, addLightSourceAnnotationLink, addLightSourceAnnotationLinkToBoth, clearAnnotationLinks, copyAnnotationLinks, findLightSourceAnnotationLink, getAnnotationLinksCountPerOwner, getInstrument, getLotNumber, getManufacturer, getModel, getPower, getSerialNumber, getVersion, linkAnnotation, linkedAnnotationList, reloadAnnotationLinks, removeAllLightSourceAnnotationLinkSet, removeLightSourceAnnotationLink, removeLightSourceAnnotationLinkFromBoth, setInstrument, setLotNumber, setManufacturer, setModel, setPower, setSerialNumber, 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._LightSourceOperationsNC

addAllLightSourceAnnotationLinkSet, addLightSourceAnnotationLink, addLightSourceAnnotationLinkToBoth, clearAnnotationLinks, copyAnnotationLinks, findLightSourceAnnotationLink, getAnnotationLinksCountPerOwner, getInstrument, getLotNumber, getManufacturer, getModel, getPower, getSerialNumber, getVersion, linkAnnotation, linkedAnnotationList, reloadAnnotationLinks, removeAllLightSourceAnnotationLinkSet, removeLightSourceAnnotationLink, removeLightSourceAnnotationLinkFromBoth, setInstrument, setLotNumber, setManufacturer, setModel, setPower, setSerialNumber, setVersion, sizeOfAnnotationLinks, unlinkAnnotation, unloadAnnotationLinks

Methods inherited from interface omero.model._IObjectOperationsNC

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

Field Detail

MAP

public static final java.lang.String MAP

See Also:

Constant Field Values

MANUFACTURER

public static final java.lang.String MANUFACTURER

See Also:

Constant Field Values

MODEL

public static final java.lang.String MODEL

See Also:

Constant Field Values

POWER

public static final java.lang.String POWER

See Also:

Constant Field Values

LOTNUMBER

public static final java.lang.String LOTNUMBER

See Also:

Constant Field Values

SERIALNUMBER

public static final java.lang.String SERIALNUMBER

See Also:

Constant Field Values

INSTRUMENT

public static final java.lang.String INSTRUMENT

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

GenericExcitationSourceI

public GenericExcitationSourceI()

GenericExcitationSourceI

public GenericExcitationSourceI(long id,
                                boolean loaded)

GenericExcitationSourceI

public GenericExcitationSourceI(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 _LightSourceOperations

setVersion

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

Specified by:

setVersion in interface _LightSourceOperations

unloadMap

public void unloadMap()

getMap

public java.util.List<NamedValue> getMap(Ice.Current current)
                                  throws UnloadedEntityException

Specified by:

getMap in interface _GenericExcitationSourceOperations

Throws:

UnloadedEntityException

getMapAsMap

public java.util.Map<java.lang.String,java.lang.String> getMapAsMap(Ice.Current current)
                                                             throws UnloadedEntityException

Specified by:

getMapAsMap in interface _GenericExcitationSourceOperations

Throws:

UnloadedEntityException

setMap

public void setMap(java.util.List<NamedValue> map,
                   Ice.Current current)
            throws UnloadedEntityException

Specified by:

setMap in interface _GenericExcitationSourceOperations

Throws:

UnloadedEntityException

unloadManufacturer

public void unloadManufacturer()

getManufacturer

public RString getManufacturer(Ice.Current current)
                        throws UnloadedEntityException

Specified by:

getManufacturer in interface _LightSourceOperations

Throws:

UnloadedEntityException

setManufacturer

public void setManufacturer(RString manufacturer,
                            Ice.Current current)
                     throws UnloadedEntityException

Specified by:

setManufacturer in interface _LightSourceOperations

Throws:

UnloadedEntityException

unloadModel

public void unloadModel()

getModel

public RString getModel(Ice.Current current)
                 throws UnloadedEntityException

Specified by:

getModel in interface _LightSourceOperations

Throws:

UnloadedEntityException

setModel

public void setModel(RString model,
                     Ice.Current current)
              throws UnloadedEntityException

Specified by:

setModel in interface _LightSourceOperations

Throws:

UnloadedEntityException

unloadPower

public void unloadPower()

getPower

public Power getPower(Ice.Current current)
               throws UnloadedEntityException

Specified by:

getPower in interface _LightSourceOperations

Throws:

UnloadedEntityException

setPower

public void setPower(Power power,
                     Ice.Current current)
              throws UnloadedEntityException

Specified by:

setPower in interface _LightSourceOperations

Throws:

UnloadedEntityException

unloadLotNumber

public void unloadLotNumber()

getLotNumber

public RString getLotNumber(Ice.Current current)
                     throws UnloadedEntityException

Specified by:

getLotNumber in interface _LightSourceOperations

Throws:

UnloadedEntityException

setLotNumber

public void setLotNumber(RString lotNumber,
                         Ice.Current current)
                  throws UnloadedEntityException

Specified by:

setLotNumber in interface _LightSourceOperations

Throws:

UnloadedEntityException

unloadSerialNumber

public void unloadSerialNumber()

getSerialNumber

public RString getSerialNumber(Ice.Current current)
                        throws UnloadedEntityException

Specified by:

getSerialNumber in interface _LightSourceOperations

Throws:

UnloadedEntityException

setSerialNumber

public void setSerialNumber(RString serialNumber,
                            Ice.Current current)
                     throws UnloadedEntityException

Specified by:

setSerialNumber in interface _LightSourceOperations

Throws:

UnloadedEntityException

unloadInstrument

public void unloadInstrument()

getInstrument

public Instrument getInstrument(Ice.Current current)
                         throws UnloadedEntityException

Specified by:

getInstrument in interface _LightSourceOperations

Throws:

UnloadedEntityException

setInstrument

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

Specified by:

setInstrument in interface _LightSourceOperations

Throws:

UnloadedEntityException

unloadAnnotationLinks

public void unloadAnnotationLinks(Ice.Current current)

Specified by:

unloadAnnotationLinks in interface _LightSourceOperations

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 _LightSourceOperations

Throws:

UnloadedEntityException

copyAnnotationLinks

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

Specified by:

copyAnnotationLinks in interface _LightSourceOperations

Throws:

UnloadedEntityException

iterateAnnotationLinks

public java.util.Iterator iterateAnnotationLinks()
                                          throws UnloadedEntityException

Throws:

UnloadedEntityException

addLightSourceAnnotationLink

public void addLightSourceAnnotationLink(LightSourceAnnotationLink target,
                                         Ice.Current current)
                                  throws UnloadedEntityException

Specified by:

addLightSourceAnnotationLink in interface _LightSourceOperations

Throws:

UnloadedEntityException

addAllLightSourceAnnotationLinkSet

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

Specified by:

addAllLightSourceAnnotationLinkSet in interface _LightSourceOperations

Throws:

UnloadedEntityException

removeLightSourceAnnotationLink

public void removeLightSourceAnnotationLink(LightSourceAnnotationLink target,
                                            Ice.Current current)
                                     throws UnloadedEntityException

Specified by:

removeLightSourceAnnotationLink in interface _LightSourceOperations

Throws:

UnloadedEntityException

removeAllLightSourceAnnotationLinkSet

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

Specified by:

removeAllLightSourceAnnotationLinkSet in interface _LightSourceOperations

Throws:

UnloadedEntityException

clearAnnotationLinks

public void clearAnnotationLinks(Ice.Current current)
                          throws UnloadedEntityException

Specified by:

clearAnnotationLinks in interface _LightSourceOperations

Throws:

UnloadedEntityException

reloadAnnotationLinks

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

Specified by:

reloadAnnotationLinks in interface _LightSourceOperations

Throws:

UnloadedEntityException

getAnnotationLinksCountPerOwner

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

Specified by:

getAnnotationLinksCountPerOwner in interface _LightSourceOperations

linkAnnotation

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

Specified by:

linkAnnotation in interface _LightSourceOperations

Throws:

UnloadedEntityException

addLightSourceAnnotationLinkToBoth

public void addLightSourceAnnotationLinkToBoth(LightSourceAnnotationLink link,
                                               boolean bothSides,
                                               Ice.Current current)
                                        throws UnloadedEntityException

Specified by:

addLightSourceAnnotationLinkToBoth in interface _LightSourceOperations

Throws:

UnloadedEntityException

findLightSourceAnnotationLink

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

Specified by:

findLightSourceAnnotationLink in interface _LightSourceOperations

Throws:

UnloadedEntityException

unlinkAnnotation

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

Specified by:

unlinkAnnotation in interface _LightSourceOperations

Throws:

UnloadedEntityException

removeLightSourceAnnotationLinkFromBoth

public void removeLightSourceAnnotationLinkFromBoth(LightSourceAnnotationLink link,
                                                    boolean bothSides,
                                                    Ice.Current current)
                                             throws UnloadedEntityException,
                                                    UnloadedCollectionException

Specified by:

removeLightSourceAnnotationLinkFromBoth in interface _LightSourceOperations

Throws:

UnloadedEntityException

UnloadedCollectionException

linkedAnnotationList

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

Specified by:

linkedAnnotationList in interface _LightSourceOperations

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

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

Throws:

java.lang.ClassCastException