LogicalChannel (OMERO API)

java.lang.Object
- ome.model.core.LogicalChannel

All Implemented Interfaces:

java.io.Serializable, IMutable, IObject, Filterable
```
@Entity
 @Indexed(index="FullText")
 @ClassBridge(name="details",
             impl=DetailsFieldBridge.class,
             index=UN_TOKENIZED,
             store=NO)
public class LogicalChannel
extends java.lang.Object
implements java.io.Serializable, IObject, IMutable
```
These filter definitions are used by the security system to eliminate non-readable objects from queries. The regular user does not need to worry about them, as they will be injected directly into the SQL (not HQL)

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class LogicalChannel.Details

Nested Classes
Modifier and Type	Class and Description
`static class`	`LogicalChannel.Details`

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.Map<java.lang.String,java.lang.Object>`	`_dynamicFields`
`protected boolean`	`_loaded`
`protected java.util.Set<Channel>`	`channels`
`static java.lang.String`	`CHANNELS`
`protected ContrastMethod`	`contrastMethod`
`static java.lang.String`	`CONTRASTMETHOD`
`protected Details`	`details`
`static java.lang.String`	`DETAILS`
`protected DetectorSettings`	`detectorSettings`
`static java.lang.String`	`DETECTORSETTINGS`
`protected Length`	`emissionWave`
`static java.lang.String`	`EMISSIONWAVE`
`static java.lang.String`	`EVENT_FILTER`
`static java.lang.String`	`EVENT_FILTER_CHANNELS`
`protected Length`	`excitationWave`
`static java.lang.String`	`EXCITATIONWAVE`
`static java.util.Set<java.lang.String>`	`FIELDS`
`protected FilterSet`	`filterSet`
`static java.lang.String`	`FILTERSET`
`protected java.lang.String`	`fluor`
`static java.lang.String`	`FLUOR`
`static java.lang.String`	`GROUP_FILTER`
`static java.lang.String`	`GROUP_FILTER_CHANNELS`
`protected java.lang.Long`	`id`
`static java.lang.String`	`ID`
`protected Illumination`	`illumination`
`static java.lang.String`	`ILLUMINATION`
`protected LightPath`	`lightPath`
`static java.lang.String`	`LIGHTPATH`
`protected LightSettings`	`lightSourceSettings`
`static java.lang.String`	`LIGHTSOURCESETTINGS`
`protected AcquisitionMode`	`mode`
`static java.lang.String`	`MODE`
`protected java.lang.String`	`name`
`static java.lang.String`	`NAME`
`protected java.lang.Double`	`ndFilter`
`static java.lang.String`	`NDFILTER`
`protected OTF`	`otf`
`static java.lang.String`	`OTF`
`static java.lang.String`	`OWNER_FILTER`
`static java.lang.String`	`OWNER_FILTER_CHANNELS`
`static java.lang.String`	`PERMS_FILTER`
`static java.lang.String`	`PERMS_FILTER_CHANNELS`
`protected PhotometricInterpretation`	`photometricInterpretation`
`static java.lang.String`	`PHOTOMETRICINTERPRETATION`
`protected Length`	`pinHoleSize`
`static java.lang.String`	`PINHOLESIZE`
`protected java.lang.Integer`	`pockelCellSetting`
`static java.lang.String`	`POCKELCELLSETTING`
`protected java.lang.Integer`	`samplesPerPixel`
`static java.lang.String`	`SAMPLESPERPIXEL`
`protected java.lang.Integer`	`version`
`static java.lang.String`	`VERSION`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`LogicalChannel()`
`protected`	`LogicalChannel(java.lang.Long id)`
	`LogicalChannel(java.lang.Long id, boolean loaded)` Main constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`acceptFilter(Filter __filter)`
`void`	`addChannel(Channel target)` use instead of setChannels .
`void`	`addChannelSet(java.util.Collection<Channel> targets)` use like addChannel.
`void`	`clearChannels()` clears the set.
`<E> java.util.List<E>`	`collectChannels(CBlock<E> block)` takes a CBlock and calls the block once for each ome.model.core.Channel while collecting the results.
`protected void`	`errorIfUnloaded()`
`java.util.Set<java.lang.String>`	`fields()` returns a Set of field names that belong to this class
`protected java.util.Set<Channel>`	`getChannels()` returns channels .
`ContrastMethod`	`getContrastMethod()` Many-to-one field ome.model.core.LogicalChannel.contrastMethod (ome.model.enums.ContrastMethod)
`Details`	`getDetails()` The details of this object correspond to low-level system information.
`DetectorSettings`	`getDetectorSettings()` Many-to-one field ome.model.core.LogicalChannel.detectorSettings (ome.model.acquisition.DetectorSettings)
`Length`	`getEmissionWave()` Enum-mapped unit-based field ome.model.core.LogicalChannel.emissionWave (ome.model.units.Length)
`Length`	`getExcitationWave()` Enum-mapped unit-based field ome.model.core.LogicalChannel.excitationWave (ome.model.units.Length)
`FilterSet`	`getFilterSet()` Many-to-one field ome.model.core.LogicalChannel.filterSet (ome.model.acquisition.FilterSet)
`java.lang.String`	`getFluor()` Simple field ome.model.core.LogicalChannel.fluor (java.lang.String)
`GraphHolder`	`getGraphHolder()` retrieves the `GraphHolder` for this entity.
`java.lang.Long`	`getId()` The DB unique identifier for this object.
`Illumination`	`getIllumination()` Many-to-one field ome.model.core.LogicalChannel.illumination (ome.model.enums.Illumination)
`LightPath`	`getLightPath()` Many-to-one field ome.model.core.LogicalChannel.lightPath (ome.model.acquisition.LightPath)
`LightSettings`	`getLightSourceSettings()` Many-to-one field ome.model.core.LogicalChannel.lightSourceSettings (ome.model.acquisition.LightSettings)
`AcquisitionMode`	`getMode()` Many-to-one field ome.model.core.LogicalChannel.mode (ome.model.enums.AcquisitionMode)
`java.lang.String`	`getName()` Simple field ome.model.core.LogicalChannel.name (java.lang.String)
`java.lang.Double`	`getNdFilter()` Simple field ome.model.core.LogicalChannel.ndFilter (java.lang.Double)
`OTF`	`getOtf()` Many-to-one field ome.model.core.LogicalChannel.otf (ome.model.acquisition.OTF)
`PhotometricInterpretation`	`getPhotometricInterpretation()` Many-to-one field ome.model.core.LogicalChannel.photometricInterpretation (ome.model.enums.PhotometricInterpretation)
`Length`	`getPinHoleSize()` Enum-mapped unit-based field ome.model.core.LogicalChannel.pinHoleSize (ome.model.units.Length)
`java.lang.Integer`	`getPockelCellSetting()` Simple field ome.model.core.LogicalChannel.pockelCellSetting (java.lang.Integer)
`java.lang.Integer`	`getSamplesPerPixel()` Simple field ome.model.core.LogicalChannel.samplesPerPixel (java.lang.Integer)
`java.lang.Integer`	`getVersion()` This version number is controlled by the database for optimisitic locking.
`boolean`	`isLoaded()` transient field (not stored in the DB) which specifies whether this object has been loaded from the DB or is only a wrapper around the ID.
`boolean`	`isValid()` calls the class-specific validator for this instance and returns the value from `Validation.isValid()`
`java.util.Iterator<Channel>`	`iterateChannels()` should be used rather than accessing the channels set directly.
`LogicalChannel`	`newInstance()`
`LogicalChannel`	`proxy()`
`void`	`putAt(java.lang.String field, java.lang.Object value)` stores a value in this instance.
`void`	`removeChannel(Channel target)` removes a single element from this set and makes the inverse call on ome.model.core.Channel
`void`	`removeChannelSet(java.util.Collection<Channel> targets)` use like removeChannel
`java.lang.Object`	`retrieve(java.lang.String field)` retrieves a value from this instance.
`protected void`	`setChannels(java.util.Set<Channel> channels)` setter for channels should be avoided.
`void`	`setContrastMethod(ContrastMethod contrastMethod)`
`protected void`	`setDetails(Details details)` Use the `Details.copy(ome.model.internal.Details)` or `Details.shallowCopy(ome.model.internal.Details)` methods to set the `LogicalChannel.Details` instance instead.
`void`	`setDetectorSettings(DetectorSettings detectorSettings)`
`void`	`setEmissionWave(Length emissionWave)`
`void`	`setExcitationWave(Length excitationWave)`
`void`	`setFilterSet(FilterSet filterSet)`
`void`	`setFluor(java.lang.String fluor)`
`void`	`setId(java.lang.Long id)` usually unneeded.
`void`	`setIllumination(Illumination illumination)`
`void`	`setLightPath(LightPath lightPath)`
`void`	`setLightSourceSettings(LightSettings lightSourceSettings)`
`void`	`setMode(AcquisitionMode mode)`
`void`	`setName(java.lang.String name)`
`void`	`setNdFilter(java.lang.Double ndFilter)`
`void`	`setOtf(OTF otf)`
`void`	`setPhotometricInterpretation(PhotometricInterpretation photometricInterpretation)`
`void`	`setPinHoleSize(Length pinHoleSize)`
`void`	`setPockelCellSetting(java.lang.Integer pockelCellSetting)`
`void`	`setSamplesPerPixel(java.lang.Integer samplesPerPixel)`
`void`	`setVersion(java.lang.Integer version)` use with caution.
`int`	`sizeOfChannels()` returns the size of channels.
`protected void`	`throwNullCollectionException(java.lang.String propertyName)`
`java.lang.String`	`toString()`
`void`	`unload()` set the loaded field to false, and set all non-ID fields to null.
`java.util.Collection<Channel>`	`unmodifiableChannels()` Returns an unmodifiable collection-view
`Validation`	`validate()` calls the class-specific validator for this instance and returns the `Validation` object.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - OWNER_FILTER
```
public static final java.lang.String OWNER_FILTER
```
    See Also:
    
    Constant Field Values
  - GROUP_FILTER
```
public static final java.lang.String GROUP_FILTER
```
    See Also:
    
    Constant Field Values
  - EVENT_FILTER
```
public static final java.lang.String EVENT_FILTER
```
    See Also:
    
    Constant Field Values
  - PERMS_FILTER
```
public static final java.lang.String PERMS_FILTER
```
    See Also:
    
    Constant Field Values
  - ID
```
public static final java.lang.String ID
```
    See Also:
    
    Constant Field Values
  - id
```
protected java.lang.Long id
```
  - VERSION
```
public static final java.lang.String VERSION
```
    See Also:
    
    Constant Field Values
  - version
```
protected java.lang.Integer version
```
  - name
```
protected java.lang.String name
```
  - pinHoleSize
```
protected Length pinHoleSize
```
  - illumination
```
protected Illumination illumination
```
  - contrastMethod
```
protected ContrastMethod contrastMethod
```
  - excitationWave
```
protected Length excitationWave
```
  - emissionWave
```
protected Length emissionWave
```
  - fluor
```
protected java.lang.String fluor
```
  - ndFilter
```
protected java.lang.Double ndFilter
```
  - otf
```
protected OTF otf
```
  - detectorSettings
```
protected DetectorSettings detectorSettings
```
  - lightSourceSettings
```
protected LightSettings lightSourceSettings
```
  - filterSet
```
protected FilterSet filterSet
```
  - samplesPerPixel
```
protected java.lang.Integer samplesPerPixel
```
  - photometricInterpretation
```
protected PhotometricInterpretation photometricInterpretation
```
  - mode
```
protected AcquisitionMode mode
```
  - pockelCellSetting
```
protected java.lang.Integer pockelCellSetting
```
  - channels
```
protected java.util.Set<Channel> channels
```
  - OWNER_FILTER_CHANNELS
```
public static final java.lang.String OWNER_FILTER_CHANNELS
```
    See Also:
    
    Constant Field Values
  - GROUP_FILTER_CHANNELS
```
public static final java.lang.String GROUP_FILTER_CHANNELS
```
    See Also:
    
    Constant Field Values
  - EVENT_FILTER_CHANNELS
```
public static final java.lang.String EVENT_FILTER_CHANNELS
```
    See Also:
    
    Constant Field Values
  - PERMS_FILTER_CHANNELS
```
public static final java.lang.String PERMS_FILTER_CHANNELS
```
    See Also:
    
    Constant Field Values
  - lightPath
```
protected LightPath lightPath
```
  - details
```
protected Details details
```
  - NAME
```
public static final java.lang.String NAME
```
    See Also:
    
    Constant Field Values
  - PINHOLESIZE
```
public static final java.lang.String PINHOLESIZE
```
    See Also:
    
    Constant Field Values
  - ILLUMINATION
```
public static final java.lang.String ILLUMINATION
```
    See Also:
    
    Constant Field Values
  - CONTRASTMETHOD
```
public static final java.lang.String CONTRASTMETHOD
```
    See Also:
    
    Constant Field Values
  - EXCITATIONWAVE
```
public static final java.lang.String EXCITATIONWAVE
```
    See Also:
    
    Constant Field Values
  - EMISSIONWAVE
```
public static final java.lang.String EMISSIONWAVE
```
    See Also:
    
    Constant Field Values
  - FLUOR
```
public static final java.lang.String FLUOR
```
    See Also:
    
    Constant Field Values
  - NDFILTER
```
public static final java.lang.String NDFILTER
```
    See Also:
    
    Constant Field Values
  - OTF
```
public static final java.lang.String OTF
```
    See Also:
    
    Constant Field Values
  - DETECTORSETTINGS
```
public static final java.lang.String DETECTORSETTINGS
```
    See Also:
    
    Constant Field Values
  - LIGHTSOURCESETTINGS
```
public static final java.lang.String LIGHTSOURCESETTINGS
```
    See Also:
    
    Constant Field Values
  - FILTERSET
```
public static final java.lang.String FILTERSET
```
    See Also:
    
    Constant Field Values
  - SAMPLESPERPIXEL
```
public static final java.lang.String SAMPLESPERPIXEL
```
    See Also:
    
    Constant Field Values
  - PHOTOMETRICINTERPRETATION
```
public static final java.lang.String PHOTOMETRICINTERPRETATION
```
    See Also:
    
    Constant Field Values
  - MODE
```
public static final java.lang.String MODE
```
    See Also:
    
    Constant Field Values
  - POCKELCELLSETTING
```
public static final java.lang.String POCKELCELLSETTING
```
    See Also:
    
    Constant Field Values
  - CHANNELS
```
public static final java.lang.String CHANNELS
```
    See Also:
    
    Constant Field Values
  - LIGHTPATH
```
public static final java.lang.String LIGHTPATH
```
    See Also:
    
    Constant Field Values
  - DETAILS
```
public static final java.lang.String DETAILS
```
    See Also:
    
    Constant Field Values
  - FIELDS
```
public static final java.util.Set<java.lang.String> FIELDS
```
  - _dynamicFields
```
protected java.util.Map<java.lang.String,java.lang.Object> _dynamicFields
```
  - _loaded
```
protected boolean _loaded
```
- Constructor Detail
  - LogicalChannel
```
public LogicalChannel()
```
  - LogicalChannel
```
protected LogicalChannel(java.lang.Long id)
```
  - LogicalChannel
```
public LogicalChannel(java.lang.Long id,
                      boolean loaded)
```
    Main constructor.
- Method Detail
  - getId
```
@DocumentId
public java.lang.Long getId()
```
    The DB unique identifier for this object. You are not responsible for setting the id; however, it can be useful for creating "unloaded" versions of your objects. Each top-level entity contains an id field of type long. For all objects returned from the server, this value will be non-null, which doesn't necessarily hold for the other fields.
    
    Specified by:
    
    getId in interface IObject
    
    Returns:
    
    Long primary key. May be null.
  - setId
```
public void setId(java.lang.Long id)
```
    Description copied from interface: IObject
    
    usually unneeded. Ids are managed by the backend.
    
    Specified by:
    
    setId in interface IObject
    
    Parameters:
    
    id - Long value for this id.
  - getVersion
```
public java.lang.Integer getVersion()
```
    This version number is controlled by the database for optimisitic locking.
    
    Specified by:
    
    getVersion in interface IMutable
  - setVersion
```
public void setVersion(java.lang.Integer version)
```
    Description copied from interface: IMutable
    
    use with caution. In general, the version should only be altered by the backend. In the best case, an exception will be thrown for a version not equal to the current DB value. In the worst (though rare) case, the new version could match the database, and override optimistic lock checks that are supposed to prevent data loss.
    
    Specified by:
    
    setVersion in interface IMutable
    
    Parameters:
    
    version - Value for this objects version.
  - getName
```
@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields")
public java.lang.String getName()
```
    Simple field ome.model.core.LogicalChannel.name (java.lang.String)
  - setName
```
public void setName(java.lang.String name)
```
  - getPinHoleSize
```
public Length getPinHoleSize()
```
    Enum-mapped unit-based field ome.model.core.LogicalChannel.pinHoleSize (ome.model.units.Length)
  - setPinHoleSize
```
public void setPinHoleSize(Length pinHoleSize)
```
  - getIllumination
```
public Illumination getIllumination()
```
    Many-to-one field ome.model.core.LogicalChannel.illumination (ome.model.enums.Illumination)
  - setIllumination
```
public void setIllumination(Illumination illumination)
```
  - getContrastMethod
```
public ContrastMethod getContrastMethod()
```
    Many-to-one field ome.model.core.LogicalChannel.contrastMethod (ome.model.enums.ContrastMethod)
  - setContrastMethod
```
public void setContrastMethod(ContrastMethod contrastMethod)
```
  - getExcitationWave
```
public Length getExcitationWave()
```
    Enum-mapped unit-based field ome.model.core.LogicalChannel.excitationWave (ome.model.units.Length)
  - setExcitationWave
```
public void setExcitationWave(Length excitationWave)
```
  - getEmissionWave
```
public Length getEmissionWave()
```
    Enum-mapped unit-based field ome.model.core.LogicalChannel.emissionWave (ome.model.units.Length)
  - setEmissionWave
```
public void setEmissionWave(Length emissionWave)
```
  - getFluor
```
@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields")
public java.lang.String getFluor()
```
    Simple field ome.model.core.LogicalChannel.fluor (java.lang.String)
  - setFluor
```
public void setFluor(java.lang.String fluor)
```
  - getNdFilter
```
@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields")
public java.lang.Double getNdFilter()
```
    Simple field ome.model.core.LogicalChannel.ndFilter (java.lang.Double)
  - setNdFilter
```
public void setNdFilter(java.lang.Double ndFilter)
```
  - getOtf
```
public OTF getOtf()
```
    Many-to-one field ome.model.core.LogicalChannel.otf (ome.model.acquisition.OTF)
  - setOtf
```
public void setOtf(OTF otf)
```
  - getDetectorSettings
```
public DetectorSettings getDetectorSettings()
```
    Many-to-one field ome.model.core.LogicalChannel.detectorSettings (ome.model.acquisition.DetectorSettings)
  - setDetectorSettings
```
public void setDetectorSettings(DetectorSettings detectorSettings)
```
  - getLightSourceSettings
```
public LightSettings getLightSourceSettings()
```
    Many-to-one field ome.model.core.LogicalChannel.lightSourceSettings (ome.model.acquisition.LightSettings)
  - setLightSourceSettings
```
public void setLightSourceSettings(LightSettings lightSourceSettings)
```
  - getFilterSet
```
public FilterSet getFilterSet()
```
    Many-to-one field ome.model.core.LogicalChannel.filterSet (ome.model.acquisition.FilterSet)
  - setFilterSet
```
public void setFilterSet(FilterSet filterSet)
```
  - getSamplesPerPixel
```
@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields")
public java.lang.Integer getSamplesPerPixel()
```
    Simple field ome.model.core.LogicalChannel.samplesPerPixel (java.lang.Integer)
  - setSamplesPerPixel
```
public void setSamplesPerPixel(java.lang.Integer samplesPerPixel)
```
  - getPhotometricInterpretation
```
public PhotometricInterpretation getPhotometricInterpretation()
```
    Many-to-one field ome.model.core.LogicalChannel.photometricInterpretation (ome.model.enums.PhotometricInterpretation)
  - setPhotometricInterpretation
```
public void setPhotometricInterpretation(PhotometricInterpretation photometricInterpretation)
```
  - getMode
```
public AcquisitionMode getMode()
```
    Many-to-one field ome.model.core.LogicalChannel.mode (ome.model.enums.AcquisitionMode)
  - setMode
```
public void setMode(AcquisitionMode mode)
```
  - getPockelCellSetting
```
@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields")
public java.lang.Integer getPockelCellSetting()
```
    Simple field ome.model.core.LogicalChannel.pockelCellSetting (java.lang.Integer)
  - setPockelCellSetting
```
public void setPockelCellSetting(java.lang.Integer pockelCellSetting)
```
  - getChannels
```
protected java.util.Set<Channel> getChannels()
```
    returns channels . You should not modify this collection unless you know what you are doing. Use the iterate method instead. one-to-many Set ome.model.core.LogicalChannel.channels (ome.model.core.Channel)
  - setChannels
```
protected void setChannels(java.util.Set<Channel> channels)
```
    setter for channels should be avoided. Does not fulfill normal semantics.
  - sizeOfChannels
```
public int sizeOfChannels()
```
    returns the size of channels. If less than zero, the Set was null.
  - iterateChannels
```
public java.util.Iterator<Channel> iterateChannels()
```
    should be used rather than accessing the channels set directly. This method will never return null, but rather will return an instance of EmptyIterator. To test for a null collection, see of sizeOfChannels() is less than zero.
  - unmodifiableChannels
```
public java.util.Collection<Channel> unmodifiableChannels()
```
    Returns an unmodifiable collection-view
  - collectChannels
```
public <E> java.util.List<E> collectChannels(CBlock<E> block)
```
    takes a CBlock and calls the block once for each ome.model.core.Channel while collecting the results. If block == null, then the iterator values themselves are collected. This method uses iterateChannels() internally and so will return a value even if the underlying collection is null.
  - addChannel
```
public void addChannel(Channel target)
```
    use instead of setChannels . Makes the necessary call on ome.model.core.Channel as well.
  - addChannelSet
```
public void addChannelSet(java.util.Collection<Channel> targets)
```
    use like addChannel.
  - removeChannel
```
public void removeChannel(Channel target)
```
    removes a single element from this set and makes the inverse call on ome.model.core.Channel
  - removeChannelSet
```
public void removeChannelSet(java.util.Collection<Channel> targets)
```
    use like removeChannel
  - clearChannels
```
public void clearChannels()
```
    clears the set.
  - getLightPath
```
public LightPath getLightPath()
```
    Many-to-one field ome.model.core.LogicalChannel.lightPath (ome.model.acquisition.LightPath)
  - setLightPath
```
public void setLightPath(LightPath lightPath)
```
  - getDetails
```
public Details getDetails()
```
    The details of this object correspond to low-level system information. Owner, permissions, Details is always guaranteed to be non-null, unless the user actively nulls it. Every entity also contains a Detail reference, which doesn't refer to a separate table but rather to a collection of fields collected into a Hibernate "component" which is embedded in the object. HQL queries which refer to the Details component cannot directly fetch the entity like this: select o from Object join fetch o.details but rather each field of the Details instance must be explicitly joined: select o from Object join fetch o.details.owner It should also be noted that not all types have all the fields which are present on Details. For example, select e from Experimenter e join fetch e.details.owner will fail. Experimenter has no owner, for obvious reasons. Note: subclasses of this class will return a subclass of the Details type.
    
    Specified by:
    
    getDetails in interface IObject
  - setDetails
```
protected void setDetails(Details details)
```
    Use the Details.copy(ome.model.internal.Details) or Details.shallowCopy(ome.model.internal.Details) methods to set the LogicalChannel.Details instance instead.
  - isValid
```
public boolean isValid()
```
    Description copied from interface: IObject
    
    calls the class-specific validator for this instance and returns the value from Validation.isValid()
    
    Specified by:
    
    isValid in interface IObject
  - validate
```
public Validation validate()
```
    Description copied from interface: IObject
    
    calls the class-specific validator for this instance and returns the Validation object.
    
    Specified by:
    
    validate in interface IObject
    
    Returns:
    
    Validation collecting parameter.
  - newInstance
```
public LogicalChannel newInstance()
```
  - proxy
```
public LogicalChannel proxy()
```
  - acceptFilter
```
public boolean acceptFilter(Filter __filter)
```
    Specified by:
    
    acceptFilter in interface Filterable
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - fields
```
public java.util.Set<java.lang.String> fields()
```
    Description copied from interface: IObject
    
    returns a Set of field names that belong to this class
    
    Specified by:
    
    fields in interface IObject
  - retrieve
```
public java.lang.Object retrieve(java.lang.String field)
```
    Description copied from interface: IObject
    
    retrieves a value from this instance. Values for field which match a field of this instance will be delegated to the accessors. Otherwise, values will be retrieved from a lazy-loaded map filled by calls to IObject.putAt(String, Object)
    
    Specified by:
    
    retrieve in interface IObject
  - putAt
```
public void putAt(java.lang.String field,
                  java.lang.Object value)
```
    Description copied from interface: IObject
    
    stores a value in this instance. Values for field which match a field of this instance will be delegated to the accessors. Otherwise, values will be stored in a lazy-loaded map.
    
    Specified by:
    
    putAt in interface IObject
    
    Parameters:
    
    field - Field name
    
    value - Any object to be stored.
  - isLoaded
```
public boolean isLoaded()
```
    Description copied from interface: IObject
    
    transient field (not stored in the DB) which specifies whether this object has been loaded from the DB or is only a wrapper around the ID.
    
    Specified by:
    
    isLoaded in interface IObject
  - errorIfUnloaded
```
protected void errorIfUnloaded()
```
  - unload
```
public void unload()
```
    Description copied from interface: IObject
    
    set the loaded field to false, and set all non-ID fields to null. Subsequent calls to all accessors other than getId/setId will throw an ApiUsageException
    
    Specified by:
    
    unload in interface IObject
  - getGraphHolder
```
public final GraphHolder getGraphHolder()
```
    Description copied from interface: IObject
    
    retrieves the GraphHolder for this entity. If the GraphHolder has not been actively set, a new one will be instatiated.
    
    Specified by:
    
    getGraphHolder in interface IObject
    
    Returns:
    
    Non-null GraphHolder
  - throwNullCollectionException
```
protected void throwNullCollectionException(java.lang.String propertyName)
```

Class LogicalChannel

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

OWNER_FILTER

GROUP_FILTER

EVENT_FILTER

PERMS_FILTER

ID

id

VERSION

version

name

pinHoleSize

illumination

contrastMethod

excitationWave

emissionWave

fluor

ndFilter

otf

detectorSettings

lightSourceSettings

filterSet

samplesPerPixel

photometricInterpretation

mode

pockelCellSetting

channels

OWNER_FILTER_CHANNELS

GROUP_FILTER_CHANNELS

EVENT_FILTER_CHANNELS

PERMS_FILTER_CHANNELS

lightPath

details

NAME

PINHOLESIZE

ILLUMINATION

CONTRASTMETHOD

EXCITATIONWAVE

EMISSIONWAVE

FLUOR

NDFILTER

OTF

DETECTORSETTINGS

LIGHTSOURCESETTINGS

FILTERSET

SAMPLESPERPIXEL

PHOTOMETRICINTERPRETATION

MODE

POCKELCELLSETTING

CHANNELS

LIGHTPATH

DETAILS

FIELDS

_dynamicFields

_loaded

Constructor Detail

LogicalChannel

LogicalChannel

LogicalChannel

Method Detail

getId

setId

getVersion

setVersion

getName

setName

getPinHoleSize

setPinHoleSize

getIllumination

setIllumination

getContrastMethod

setContrastMethod

getExcitationWave

setExcitationWave

getEmissionWave