InstrumentI (omero-blitz 5.5.12 API)

java.lang.Object
- Ice.ObjectImpl
- - omero.model.IObject
  - - omero.model.Instrument
    - - omero.model.InstrumentI

All Implemented Interfaces:

Ice.Object, java.io.Serializable, java.lang.Cloneable, ome.model.ModelBased, _InstrumentOperations, _InstrumentOperationsNC, _IObjectOperations, _IObjectOperationsNC
```
public class InstrumentI
extends Instrument
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`	`DETECTOR`
`static java.lang.String`	`DICHROIC`
`static java.lang.String`	`FILTER`
`static java.lang.String`	`FILTERSET`
`static java.lang.String`	`LIGHTSOURCE`
`static java.lang.String`	`MICROSCOPE`
`static java.lang.String`	`OBJECTIVE`
`static java.lang.String`	`OTF`

Fields inherited from class omero.model.Instrument
__ids, annotationLinksCountPerOwner, annotationLinksLoaded, annotationLinksSeq, detectorLoaded, detectorSeq, dichroicLoaded, dichroicSeq, filterLoaded, filterSeq, filterSetLoaded, filterSetSeq, lightSourceLoaded, lightSourceSeq, microscope, objectiveLoaded, objectiveSeq, otfLoaded, otfSeq, serialVersionUID, 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

InstrumentI()

InstrumentI(long id, boolean loaded)

InstrumentI(RLong id, boolean loaded)

Constructors
Constructor and Description
`InstrumentI()`
`InstrumentI(long id, boolean loaded)`
`InstrumentI(RLong id, boolean loaded)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAllDetectorSet(java.util.List<Detector> targets, Ice.Current current)`
`void`	`addAllDichroicSet(java.util.List<Dichroic> targets, Ice.Current current)`
`void`	`addAllFilterSet(java.util.List<Filter> targets, Ice.Current current)`
`void`	`addAllFilterSetSet(java.util.List<FilterSet> targets, Ice.Current current)`
`void`	`addAllInstrumentAnnotationLinkSet(java.util.List<InstrumentAnnotationLink> targets, Ice.Current current)`
`void`	`addAllLightSourceSet(java.util.List<LightSource> targets, Ice.Current current)`
`void`	`addAllObjectiveSet(java.util.List<Objective> targets, Ice.Current current)`
`void`	`addAllOTFSet(java.util.List<OTF> targets, Ice.Current current)`
`void`	`addDetector(Detector target, Ice.Current current)`
`void`	`addDichroic(Dichroic target, Ice.Current current)`
`void`	`addFilter(Filter target, Ice.Current current)`
`void`	`addFilterSet(FilterSet target, Ice.Current current)`
`void`	`addInstrumentAnnotationLink(InstrumentAnnotationLink target, Ice.Current current)`
`void`	`addInstrumentAnnotationLinkToBoth(InstrumentAnnotationLink link, boolean bothSides, Ice.Current current)`
`void`	`addLightSource(LightSource target, Ice.Current current)`
`void`	`addObjective(Objective target, Ice.Current current)`
`void`	`addOTF(OTF target, Ice.Current current)`
`static java.util.List<InstrumentI>`	`cast(java.util.List list)` Casts (without warning) the given list to a list of the current type.
`void`	`clearAnnotationLinks(Ice.Current current)`
`void`	`clearDetector(Ice.Current current)`
`void`	`clearDichroic(Ice.Current current)`
`void`	`clearFilter(Ice.Current current)`
`void`	`clearFilterSet(Ice.Current current)`
`void`	`clearLightSource(Ice.Current current)`
`void`	`clearObjective(Ice.Current current)`
`void`	`clearOtf(Ice.Current current)`
`java.util.List`	`copyAnnotationLinks(Ice.Current current)`
`java.util.List`	`copyDetector(Ice.Current current)`
`java.util.List`	`copyDichroic(Ice.Current current)`
`java.util.List`	`copyFilter(Ice.Current current)`
`java.util.List`	`copyFilterSet(Ice.Current current)`
`java.util.List`	`copyLightSource(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.
`java.util.List`	`copyObjective(Ice.Current current)`
`java.util.List`	`copyOtf(Ice.Current current)`
`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<InstrumentAnnotationLink>`	`findInstrumentAnnotationLink(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)`
`protected java.util.List`	`getDetector(Ice.Current current)`
`protected java.util.List`	`getDichroic(Ice.Current current)`
`protected java.util.List`	`getFilter(Ice.Current current)`
`protected java.util.List`	`getFilterSet(Ice.Current current)`
`RLong`	`getId(Ice.Current current)`
`protected java.util.List`	`getLightSource(Ice.Current current)`
`Microscope`	`getMicroscope(Ice.Current current)`
`protected java.util.List`	`getObjective(Ice.Current current)`
`protected java.util.List`	`getOtf(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`	`isDetectorLoaded()`
`boolean`	`isDichroicLoaded()`
`boolean`	`isFilterLoaded()`
`boolean`	`isFilterSetLoaded()`
`boolean`	`isGlobal(Ice.Current current)` Marker interface which means that special rules apply for both reading and writing these instances.
`boolean`	`isLightSourceLoaded()`
`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.
`boolean`	`isObjectiveLoaded()`
`boolean`	`isOtfLoaded()`
`java.util.Iterator`	`iterateAnnotationLinks()`
`java.util.Iterator`	`iterateDetector()`
`java.util.Iterator`	`iterateDichroic()`
`java.util.Iterator`	`iterateFilter()`
`java.util.Iterator`	`iterateFilterSet()`
`java.util.Iterator`	`iterateLightSource()`
`java.util.Iterator`	`iterateObjective()`
`java.util.Iterator`	`iterateOtf()`
`InstrumentAnnotationLink`	`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(Instrument toCopy, Ice.Current current)`
`void`	`reloadDetector(Instrument toCopy, Ice.Current current)`
`void`	`reloadDichroic(Instrument toCopy, Ice.Current current)`
`void`	`reloadFilter(Instrument toCopy, Ice.Current current)`
`void`	`reloadFilterSet(Instrument toCopy, Ice.Current current)`
`void`	`reloadLightSource(Instrument toCopy, Ice.Current current)`
`void`	`reloadObjective(Instrument toCopy, Ice.Current current)`
`void`	`reloadOtf(Instrument toCopy, Ice.Current current)`
`void`	`removeAllDetectorSet(java.util.List<Detector> targets, Ice.Current current)`
`void`	`removeAllDichroicSet(java.util.List<Dichroic> targets, Ice.Current current)`
`void`	`removeAllFilterSet(java.util.List<Filter> targets, Ice.Current current)`
`void`	`removeAllFilterSetSet(java.util.List<FilterSet> targets, Ice.Current current)`
`void`	`removeAllInstrumentAnnotationLinkSet(java.util.List<InstrumentAnnotationLink> targets, Ice.Current current)`
`void`	`removeAllLightSourceSet(java.util.List<LightSource> targets, Ice.Current current)`
`void`	`removeAllObjectiveSet(java.util.List<Objective> targets, Ice.Current current)`
`void`	`removeAllOTFSet(java.util.List<OTF> targets, Ice.Current current)`
`void`	`removeDetector(Detector target, Ice.Current current)`
`void`	`removeDichroic(Dichroic target, Ice.Current current)`
`void`	`removeFilter(Filter target, Ice.Current current)`
`void`	`removeFilterSet(FilterSet target, Ice.Current current)`
`void`	`removeInstrumentAnnotationLink(InstrumentAnnotationLink target, Ice.Current current)`
`void`	`removeInstrumentAnnotationLinkFromBoth(InstrumentAnnotationLink link, boolean bothSides, Ice.Current current)`
`void`	`removeLightSource(LightSource target, Ice.Current current)`
`void`	`removeObjective(Objective target, Ice.Current current)`
`void`	`removeOTF(OTF target, Ice.Current current)`
`protected void`	`setAnnotationLinks(java.util.List annotationLinks, Ice.Current current)`
`protected void`	`setDetector(java.util.List detector, Ice.Current current)`
`protected void`	`setDichroic(java.util.List dichroic, Ice.Current current)`
`protected void`	`setFilter(java.util.List filter, Ice.Current current)`
`protected void`	`setFilterSet(java.util.List filterSet, Ice.Current current)`
`void`	`setId(RLong id, Ice.Current current)`
`protected void`	`setLightSource(java.util.List lightSource, Ice.Current current)`
`void`	`setMicroscope(Microscope microscope, Ice.Current current)`
`protected void`	`setObjective(java.util.List objective, Ice.Current current)`
`protected void`	`setOtf(java.util.List otf, 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)`
`int`	`sizeOfDetector(Ice.Current current)`
`int`	`sizeOfDichroic(Ice.Current current)`
`int`	`sizeOfFilter(Ice.Current current)`
`int`	`sizeOfFilterSet(Ice.Current current)`
`int`	`sizeOfLightSource(Ice.Current current)`
`int`	`sizeOfObjective(Ice.Current current)`
`int`	`sizeOfOtf(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`	`unloadDetector(Ice.Current current)`
`void`	`unloadDichroic(Ice.Current current)`
`void`	`unloadFilter(Ice.Current current)`
`void`	`unloadFilterSet(Ice.Current current)`
`void`	`unloadLightSource(Ice.Current current)`
`void`	`unloadMicroscope()`
`void`	`unloadObjective(Ice.Current current)`
`void`	`unloadOtf(Ice.Current current)`

Methods inherited from class omero.model.Instrument
___addAllDetectorSet, ___addAllDichroicSet, ___addAllFilterSet, ___addAllFilterSetSet, ___addAllInstrumentAnnotationLinkSet, ___addAllLightSourceSet, ___addAllObjectiveSet, ___addAllOTFSet, ___addDetector, ___addDichroic, ___addFilter, ___addFilterSet, ___addInstrumentAnnotationLink, ___addInstrumentAnnotationLinkToBoth, ___addLightSource, ___addObjective, ___addOTF, ___clearAnnotationLinks, ___clearDetector, ___clearDichroic, ___clearFilter, ___clearFilterSet, ___clearLightSource, ___clearObjective, ___clearOtf, ___copyAnnotationLinks, ___copyDetector, ___copyDichroic, ___copyFilter, ___copyFilterSet, ___copyLightSource, ___copyObjective, ___copyOtf, ___findInstrumentAnnotationLink, ___getAnnotationLinksCountPerOwner, ___getMicroscope, ___getVersion, ___linkAnnotation, ___linkedAnnotationList, ___reloadAnnotationLinks, ___reloadDetector, ___reloadDichroic, ___reloadFilter, ___reloadFilterSet, ___reloadLightSource, ___reloadObjective, ___reloadOtf, ___removeAllDetectorSet, ___removeAllDichroicSet, ___removeAllFilterSet, ___removeAllFilterSetSet, ___removeAllInstrumentAnnotationLinkSet, ___removeAllLightSourceSet, ___removeAllObjectiveSet, ___removeAllOTFSet, ___removeDetector, ___removeDichroic, ___removeFilter, ___removeFilterSet, ___removeInstrumentAnnotationLink, ___removeInstrumentAnnotationLinkFromBoth, ___removeLightSource, ___removeObjective, ___removeOTF, ___setMicroscope, ___setVersion, ___sizeOfAnnotationLinks, ___sizeOfDetector, ___sizeOfDichroic, ___sizeOfFilter, ___sizeOfFilterSet, ___sizeOfLightSource, ___sizeOfObjective, ___sizeOfOtf, ___unlinkAnnotation, ___unloadAnnotationLinks, ___unloadDetector, ___unloadDichroic, ___unloadFilter, ___unloadFilterSet, ___unloadLightSource, ___unloadObjective, ___unloadOtf, __dispatch, __readImpl, __writeImpl, addAllDetectorSet, addAllDichroicSet, addAllFilterSet, addAllFilterSetSet, addAllInstrumentAnnotationLinkSet, addAllLightSourceSet, addAllObjectiveSet, addAllOTFSet, addDetector, addDichroic, addFilter, addFilterSet, addInstrumentAnnotationLink, addInstrumentAnnotationLinkToBoth, addLightSource, addObjective, addOTF, clearAnnotationLinks, clearDetector, clearDichroic, clearFilter, clearFilterSet, clearLightSource, clearObjective, clearOtf, clone, copyAnnotationLinks, copyDetector, copyDichroic, copyFilter, copyFilterSet, copyLightSource, copyObjective, copyOtf, findInstrumentAnnotationLink, getAnnotationLinksCountPerOwner, getMicroscope, getVersion, ice_id, ice_id, ice_ids, ice_ids, ice_isA, ice_isA, ice_staticId, linkAnnotation, linkedAnnotationList, reloadAnnotationLinks, reloadDetector, reloadDichroic, reloadFilter, reloadFilterSet, reloadLightSource, reloadObjective, reloadOtf, removeAllDetectorSet, removeAllDichroicSet, removeAllFilterSet, removeAllFilterSetSet, removeAllInstrumentAnnotationLinkSet, removeAllLightSourceSet, removeAllObjectiveSet, removeAllOTFSet, removeDetector, removeDichroic, removeFilter, removeFilterSet, removeInstrumentAnnotationLink, removeInstrumentAnnotationLinkFromBoth, removeLightSource, removeObjective, removeOTF, setMicroscope, setVersion, sizeOfAnnotationLinks, sizeOfDetector, sizeOfDichroic, sizeOfFilter, sizeOfFilterSet, sizeOfLightSource, sizeOfObjective, sizeOfOtf, unlinkAnnotation, unloadAnnotationLinks, unloadDetector, unloadDichroic, unloadFilter, unloadFilterSet, unloadLightSource, unloadObjective, unloadOtf

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

MICROSCOPE

public static final java.lang.String MICROSCOPE

See Also:: Constant Field Values

DETECTOR

public static final java.lang.String DETECTOR

See Also:: Constant Field Values

OBJECTIVE

public static final java.lang.String OBJECTIVE

See Also:: Constant Field Values

LIGHTSOURCE

public static final java.lang.String LIGHTSOURCE

See Also:: Constant Field Values

FILTER

public static final java.lang.String FILTER

See Also:: Constant Field Values

DICHROIC

public static final java.lang.String DICHROIC

See Also:: Constant Field Values

FILTERSET

public static final java.lang.String FILTERSET

See Also:: Constant Field Values

OTF

public static final java.lang.String OTF

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

InstrumentI
```
public InstrumentI()
```

InstrumentI

public InstrumentI(long id,
                   boolean loaded)

InstrumentI

public InstrumentI(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 _InstrumentOperations

setVersion

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

Specified by:: setVersion in interface _InstrumentOperations

unloadMicroscope
```
public void unloadMicroscope()
```

getMicroscope

public Microscope getMicroscope(Ice.Current current)
                         throws UnloadedEntityException

Specified by:: getMicroscope in interface _InstrumentOperations
Throws:: UnloadedEntityException

setMicroscope

public void setMicroscope(Microscope microscope,
                          Ice.Current current)
                   throws UnloadedEntityException

Specified by:: setMicroscope in interface _InstrumentOperations
Throws:: UnloadedEntityException

unloadDetector
```
public void unloadDetector(Ice.Current current)
```
Specified by:

unloadDetector in interface _InstrumentOperations

getDetector

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

Throws:: UnloadedEntityException

setDetector

protected void setDetector(java.util.List detector,
                           Ice.Current current)
                    throws UnloadedEntityException

Throws:: UnloadedEntityException

isDetectorLoaded
```
public boolean isDetectorLoaded()
```

sizeOfDetector
```
public int sizeOfDetector(Ice.Current current)
                   throws UnloadedEntityException
```
Specified by:

sizeOfDetector in interface _InstrumentOperations

Throws:

UnloadedEntityException

copyDetector

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

Specified by:: copyDetector in interface _InstrumentOperations
Throws:: UnloadedEntityException

iterateDetector

public java.util.Iterator iterateDetector()
                                   throws UnloadedEntityException

Throws:: UnloadedEntityException

addDetector

public void addDetector(Detector target,
                        Ice.Current current)
                 throws UnloadedEntityException

Specified by:: addDetector in interface _InstrumentOperations
Throws:: UnloadedEntityException

addAllDetectorSet

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

Specified by:: addAllDetectorSet in interface _InstrumentOperations
Throws:: UnloadedEntityException

removeDetector

public void removeDetector(Detector target,
                           Ice.Current current)
                    throws UnloadedEntityException

Specified by:: removeDetector in interface _InstrumentOperations
Throws:: UnloadedEntityException

removeAllDetectorSet

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

Specified by:: removeAllDetectorSet in interface _InstrumentOperations
Throws:: UnloadedEntityException

clearDetector
```
public void clearDetector(Ice.Current current)
                   throws UnloadedEntityException
```
Specified by:

clearDetector in interface _InstrumentOperations

Throws:

UnloadedEntityException

reloadDetector

public void reloadDetector(Instrument toCopy,
                           Ice.Current current)
                    throws UnloadedEntityException

Specified by:: reloadDetector in interface _InstrumentOperations
Throws:: UnloadedEntityException

unloadObjective
```
public void unloadObjective(Ice.Current current)
```
Specified by:

unloadObjective in interface _InstrumentOperations

getObjective

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

Throws:: UnloadedEntityException

setObjective

protected void setObjective(java.util.List objective,
                            Ice.Current current)
                     throws UnloadedEntityException

Throws:: UnloadedEntityException

isObjectiveLoaded
```
public boolean isObjectiveLoaded()
```

sizeOfObjective
```
public int sizeOfObjective(Ice.Current current)
                    throws UnloadedEntityException
```
Specified by:

sizeOfObjective in interface _InstrumentOperations

Throws:

UnloadedEntityException

copyObjective

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

Specified by:: copyObjective in interface _InstrumentOperations
Throws:: UnloadedEntityException

iterateObjective

public java.util.Iterator iterateObjective()
                                    throws UnloadedEntityException

Throws:: UnloadedEntityException

addObjective

public void addObjective(Objective target,
                         Ice.Current current)
                  throws UnloadedEntityException

Specified by:: addObjective in interface _InstrumentOperations
Throws:: UnloadedEntityException

addAllObjectiveSet

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

Specified by:: addAllObjectiveSet in interface _InstrumentOperations
Throws:: UnloadedEntityException

removeObjective

public void removeObjective(Objective target,
                            Ice.Current current)
                     throws UnloadedEntityException

Specified by:: removeObjective in interface _InstrumentOperations
Throws:: UnloadedEntityException

removeAllObjectiveSet

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

Specified by:: removeAllObjectiveSet in interface _InstrumentOperations
Throws:: UnloadedEntityException

clearObjective
```
public void clearObjective(Ice.Current current)
                    throws UnloadedEntityException
```
Specified by:

clearObjective in interface _InstrumentOperations

Throws:

UnloadedEntityException

reloadObjective

public void reloadObjective(Instrument toCopy,
                            Ice.Current current)
                     throws UnloadedEntityException

Specified by:: reloadObjective in interface _InstrumentOperations
Throws:: UnloadedEntityException

unloadLightSource
```
public void unloadLightSource(Ice.Current current)
```
Specified by:

unloadLightSource in interface _InstrumentOperations

getLightSource

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

Throws:: UnloadedEntityException

setLightSource

protected void setLightSource(java.util.List lightSource,
                              Ice.Current current)
                       throws UnloadedEntityException

Throws:: UnloadedEntityException

isLightSourceLoaded
```
public boolean isLightSourceLoaded()
```

sizeOfLightSource
```
public int sizeOfLightSource(Ice.Current current)
                      throws UnloadedEntityException
```
Specified by:

sizeOfLightSource in interface _InstrumentOperations

Throws:

UnloadedEntityException

copyLightSource

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

Specified by:: copyLightSource in interface _InstrumentOperations
Throws:: UnloadedEntityException

iterateLightSource

public java.util.Iterator iterateLightSource()
                                      throws UnloadedEntityException

Throws:: UnloadedEntityException

addLightSource

public void addLightSource(LightSource target,
                           Ice.Current current)
                    throws UnloadedEntityException

Specified by:: addLightSource in interface _InstrumentOperations
Throws:: UnloadedEntityException

addAllLightSourceSet

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

Specified by:: addAllLightSourceSet in interface _InstrumentOperations
Throws:: UnloadedEntityException

removeLightSource

public void removeLightSource(LightSource target,
                              Ice.Current current)
                       throws UnloadedEntityException

Specified by:: removeLightSource in interface _InstrumentOperations
Throws:: UnloadedEntityException

removeAllLightSourceSet

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

Specified by:: removeAllLightSourceSet in interface _InstrumentOperations
Throws:: UnloadedEntityException

clearLightSource
```
public void clearLightSource(Ice.Current current)
                      throws UnloadedEntityException
```
Specified by:

clearLightSource in interface _InstrumentOperations

Throws:

UnloadedEntityException

reloadLightSource

public void reloadLightSource(Instrument toCopy,
                              Ice.Current current)
                       throws UnloadedEntityException

Specified by:: reloadLightSource in interface _InstrumentOperations
Throws:: UnloadedEntityException

unloadFilter
```
public void unloadFilter(Ice.Current current)
```
Specified by:

unloadFilter in interface _InstrumentOperations

getFilter

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

Throws:: UnloadedEntityException

setFilter

protected void setFilter(java.util.List filter,
                         Ice.Current current)
                  throws UnloadedEntityException

Throws:: UnloadedEntityException

isFilterLoaded
```
public boolean isFilterLoaded()
```

sizeOfFilter
```
public int sizeOfFilter(Ice.Current current)
                 throws UnloadedEntityException
```
Specified by:

sizeOfFilter in interface _InstrumentOperations

Throws:

UnloadedEntityException

copyFilter

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

Specified by:: copyFilter in interface _InstrumentOperations
Throws:: UnloadedEntityException

iterateFilter

public java.util.Iterator iterateFilter()
                                 throws UnloadedEntityException

Throws:: UnloadedEntityException

addFilter

public void addFilter(Filter target,
                      Ice.Current current)
               throws UnloadedEntityException

Specified by:: addFilter in interface _InstrumentOperations
Throws:: UnloadedEntityException

addAllFilterSet

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

Specified by:: addAllFilterSet in interface _InstrumentOperations
Throws:: UnloadedEntityException

removeFilter

public void removeFilter(Filter target,
                         Ice.Current current)
                  throws UnloadedEntityException

Specified by:: removeFilter in interface _InstrumentOperations
Throws:: UnloadedEntityException

removeAllFilterSet

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

Specified by:: removeAllFilterSet in interface _InstrumentOperations
Throws:: UnloadedEntityException

clearFilter
```
public void clearFilter(Ice.Current current)
                 throws UnloadedEntityException
```
Specified by:

clearFilter in interface _InstrumentOperations

Throws:

UnloadedEntityException

reloadFilter

public void reloadFilter(Instrument toCopy,
                         Ice.Current current)
                  throws UnloadedEntityException

Specified by:: reloadFilter in interface _InstrumentOperations
Throws:: UnloadedEntityException

unloadDichroic
```
public void unloadDichroic(Ice.Current current)
```
Specified by:

unloadDichroic in interface _InstrumentOperations

getDichroic

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

Throws:: UnloadedEntityException

setDichroic

protected void setDichroic(java.util.List dichroic,
                           Ice.Current current)
                    throws UnloadedEntityException

Throws:: UnloadedEntityException

isDichroicLoaded
```
public boolean isDichroicLoaded()
```

sizeOfDichroic
```
public int sizeOfDichroic(Ice.Current current)
                   throws UnloadedEntityException
```
Specified by:

sizeOfDichroic in interface _InstrumentOperations

Throws:

UnloadedEntityException

copyDichroic

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

Specified by:: copyDichroic in interface _InstrumentOperations
Throws:: UnloadedEntityException

iterateDichroic

public java.util.Iterator iterateDichroic()
                                   throws UnloadedEntityException

Throws:: UnloadedEntityException

addDichroic

public void addDichroic(Dichroic target,
                        Ice.Current current)
                 throws UnloadedEntityException

Specified by:: addDichroic in interface _InstrumentOperations
Throws:: UnloadedEntityException

addAllDichroicSet

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

Specified by:: addAllDichroicSet in interface _InstrumentOperations
Throws:: UnloadedEntityException

removeDichroic

public void removeDichroic(Dichroic target,
                           Ice.Current current)
                    throws UnloadedEntityException

Specified by:: removeDichroic in interface _InstrumentOperations
Throws:: UnloadedEntityException

removeAllDichroicSet

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

Specified by:: removeAllDichroicSet in interface _InstrumentOperations
Throws:: UnloadedEntityException

clearDichroic
```
public void clearDichroic(Ice.Current current)
                   throws UnloadedEntityException
```
Specified by:

clearDichroic in interface _InstrumentOperations

Throws:

UnloadedEntityException

reloadDichroic

public void reloadDichroic(Instrument toCopy,
                           Ice.Current current)
                    throws UnloadedEntityException

Specified by:: reloadDichroic in interface _InstrumentOperations
Throws:: UnloadedEntityException

unloadFilterSet
```
public void unloadFilterSet(Ice.Current current)
```
Specified by:

unloadFilterSet in interface _InstrumentOperations

getFilterSet

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

Throws:: UnloadedEntityException

setFilterSet

protected void setFilterSet(java.util.List filterSet,
                            Ice.Current current)
                     throws UnloadedEntityException

Throws:: UnloadedEntityException

isFilterSetLoaded
```
public boolean isFilterSetLoaded()
```

sizeOfFilterSet
```
public int sizeOfFilterSet(Ice.Current current)
                    throws UnloadedEntityException
```
Specified by:

sizeOfFilterSet in interface _InstrumentOperations

Throws:

UnloadedEntityException

copyFilterSet

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

Specified by:: copyFilterSet in interface _InstrumentOperations
Throws:: UnloadedEntityException

iterateFilterSet

public java.util.Iterator iterateFilterSet()
                                    throws UnloadedEntityException

Throws:: UnloadedEntityException

addFilterSet

public void addFilterSet(FilterSet target,
                         Ice.Current current)
                  throws UnloadedEntityException

Specified by:: addFilterSet in interface _InstrumentOperations
Throws:: UnloadedEntityException

addAllFilterSetSet

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

Specified by:: addAllFilterSetSet in interface _InstrumentOperations
Throws:: UnloadedEntityException

removeFilterSet

public void removeFilterSet(FilterSet target,
                            Ice.Current current)
                     throws UnloadedEntityException

Specified by:: removeFilterSet in interface _InstrumentOperations
Throws:: UnloadedEntityException

removeAllFilterSetSet

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

Specified by:: removeAllFilterSetSet in interface _InstrumentOperations
Throws:: UnloadedEntityException

clearFilterSet
```
public void clearFilterSet(Ice.Current current)
                    throws UnloadedEntityException
```
Specified by:

clearFilterSet in interface _InstrumentOperations

Throws:

UnloadedEntityException

reloadFilterSet

public void reloadFilterSet(Instrument toCopy,
                            Ice.Current current)
                     throws UnloadedEntityException

Specified by:: reloadFilterSet in interface _InstrumentOperations
Throws:: UnloadedEntityException

unloadOtf
```
public void unloadOtf(Ice.Current current)
```
Specified by:

unloadOtf in interface _InstrumentOperations

getOtf

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

Throws:: UnloadedEntityException

setOtf

protected void setOtf(java.util.List otf,
                      Ice.Current current)
               throws UnloadedEntityException

Throws:: UnloadedEntityException

isOtfLoaded
```
public boolean isOtfLoaded()
```

sizeOfOtf
```
public int sizeOfOtf(Ice.Current current)
              throws UnloadedEntityException
```
Specified by:

sizeOfOtf in interface _InstrumentOperations

Throws:

UnloadedEntityException

copyOtf

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

Specified by:: copyOtf in interface _InstrumentOperations
Throws:: UnloadedEntityException

iterateOtf

public java.util.Iterator iterateOtf()
                              throws UnloadedEntityException

Throws:: UnloadedEntityException

addOTF

public void addOTF(OTF target,
                   Ice.Current current)
            throws UnloadedEntityException

Specified by:: addOTF in interface _InstrumentOperations
Throws:: UnloadedEntityException

addAllOTFSet

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

Specified by:: addAllOTFSet in interface _InstrumentOperations
Throws:: UnloadedEntityException

removeOTF

public void removeOTF(OTF target,
                      Ice.Current current)
               throws UnloadedEntityException

Specified by:: removeOTF in interface _InstrumentOperations
Throws:: UnloadedEntityException

removeAllOTFSet

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

Specified by:: removeAllOTFSet in interface _InstrumentOperations
Throws:: UnloadedEntityException

clearOtf
```
public void clearOtf(Ice.Current current)
              throws UnloadedEntityException
```
Specified by:

clearOtf in interface _InstrumentOperations

Throws:

UnloadedEntityException

reloadOtf

public void reloadOtf(Instrument toCopy,
                      Ice.Current current)
               throws UnloadedEntityException

Specified by:: reloadOtf in interface _InstrumentOperations
Throws:: UnloadedEntityException

unloadAnnotationLinks
```
public void unloadAnnotationLinks(Ice.Current current)
```
Specified by:

unloadAnnotationLinks in interface _InstrumentOperations

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 _InstrumentOperations

Throws:

UnloadedEntityException

copyAnnotationLinks

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

Specified by:: copyAnnotationLinks in interface _InstrumentOperations
Throws:: UnloadedEntityException

iterateAnnotationLinks

public java.util.Iterator iterateAnnotationLinks()
                                          throws UnloadedEntityException

Throws:: UnloadedEntityException

addInstrumentAnnotationLink

public void addInstrumentAnnotationLink(InstrumentAnnotationLink target,
                                        Ice.Current current)
                                 throws UnloadedEntityException

Specified by:: addInstrumentAnnotationLink in interface _InstrumentOperations
Throws:: UnloadedEntityException

addAllInstrumentAnnotationLinkSet

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

Specified by:: addAllInstrumentAnnotationLinkSet in interface _InstrumentOperations
Throws:: UnloadedEntityException

removeInstrumentAnnotationLink

public void removeInstrumentAnnotationLink(InstrumentAnnotationLink target,
                                           Ice.Current current)
                                    throws UnloadedEntityException

Specified by:: removeInstrumentAnnotationLink in interface _InstrumentOperations
Throws:: UnloadedEntityException

removeAllInstrumentAnnotationLinkSet

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

Specified by:: removeAllInstrumentAnnotationLinkSet in interface _InstrumentOperations
Throws:: UnloadedEntityException

clearAnnotationLinks
```
public void clearAnnotationLinks(Ice.Current current)
                          throws UnloadedEntityException
```
Specified by:

clearAnnotationLinks in interface _InstrumentOperations

Throws:

UnloadedEntityException

reloadAnnotationLinks

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

Specified by:: reloadAnnotationLinks in interface _InstrumentOperations
Throws:: UnloadedEntityException

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

getAnnotationLinksCountPerOwner in interface _InstrumentOperations

linkAnnotation

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

Specified by:: linkAnnotation in interface _InstrumentOperations
Throws:: UnloadedEntityException

addInstrumentAnnotationLinkToBoth

public void addInstrumentAnnotationLinkToBoth(InstrumentAnnotationLink link,
                                              boolean bothSides,
                                              Ice.Current current)
                                       throws UnloadedEntityException

Specified by:: addInstrumentAnnotationLinkToBoth in interface _InstrumentOperations
Throws:: UnloadedEntityException

findInstrumentAnnotationLink

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

Specified by:: findInstrumentAnnotationLink in interface _InstrumentOperations
Throws:: UnloadedEntityException

unlinkAnnotation

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

Specified by:: unlinkAnnotation in interface _InstrumentOperations
Throws:: UnloadedEntityException

removeInstrumentAnnotationLinkFromBoth

public void removeInstrumentAnnotationLinkFromBoth(InstrumentAnnotationLink link,
                                                   boolean bothSides,
                                                   Ice.Current current)
                                            throws UnloadedEntityException,
                                                   UnloadedCollectionException

Specified by:: removeInstrumentAnnotationLinkFromBoth in interface _InstrumentOperations
Throws:: UnloadedEntityException; UnloadedCollectionException

linkedAnnotationList

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

Specified by:: linkedAnnotationList in interface _InstrumentOperations
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<InstrumentI> cast(java.util.List list)
```
Casts (without warning) the given list to a list of the current type.

Throws:

java.lang.ClassCastException

Class InstrumentI

Field Summary

Fields inherited from class omero.model.Instrument

Fields inherited from class omero.model.IObject

Fields inherited from interface Ice.Object

Constructor Summary

Method Summary

Methods inherited from class omero.model.Instrument

Methods inherited from class omero.model.IObject

Methods inherited from class Ice.ObjectImpl

Methods inherited from class java.lang.Object

Methods inherited from interface omero.model._IObjectOperationsNC

Field Detail

MICROSCOPE

DETECTOR

OBJECTIVE

LIGHTSOURCE

FILTER

DICHROIC

FILTERSET

OTF

ANNOTATIONLINKS

DETAILS

Constructor Detail

InstrumentI

InstrumentI

InstrumentI

Method Detail

errorIfUnloaded

throwNullCollectionException

toggleCollectionsLoaded

unload

isLoaded

unloadCollections

isGlobal

isMutable

isAnnotated

isLink

shallowCopy

proxy

getId

setId

getDetails

unloadDetails

getVersion

setVersion

unloadMicroscope

getMicroscope

setMicroscope

unloadDetector

getDetector

setDetector

isDetectorLoaded

sizeOfDetector

copyDetector

iterateDetector

addDetector

addAllDetectorSet

removeDetector

removeAllDetectorSet

clearDetector

reloadDetector

unloadObjective

getObjective

setObjective

isObjectiveLoaded

sizeOfObjective

copyObjective

iterateObjective

addObjective

addAllObjectiveSet

removeObjective

removeAllObjectiveSet

clearObjective

reloadObjective

unloadLightSource

getLightSource

setLightSource

isLightSourceLoaded

sizeOfLightSource