@Entity @Indexed(index="FullText") @ClassBridge(name="details", impl=DetailsFieldBridge.class, index=UN_TOKENIZED, store=NO) public class LogicalChannel extends Object implements Serializable, IObject, IMutable
Modifier and Type | Class and Description |
---|---|
static class |
LogicalChannel.Details |
Modifier | Constructor and Description |
---|---|
|
LogicalChannel() |
protected |
LogicalChannel(Long id) |
|
LogicalChannel(Long id,
boolean loaded)
Main constructor.
|
Modifier and Type | Method and Description |
---|---|
boolean |
acceptFilter(Filter __filter) |
void |
addChannel(Channel target)
use instead of setChannels .
|
void |
addChannelSet(Collection<Channel> targets)
use like addChannel.
|
void |
clearChannels()
clears the set.
|
<E> 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() |
Set<String> |
fields()
returns a Set of field names that belong to this class
|
protected 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)
|
String |
getFluor()
Simple field ome.model.core.LogicalChannel.fluor (java.lang.String)
|
GraphHolder |
getGraphHolder()
retrieves the
GraphHolder for this entity. |
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)
|
String |
getName()
Simple field ome.model.core.LogicalChannel.name (java.lang.String)
|
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)
|
Integer |
getPockelCellSetting()
Simple field ome.model.core.LogicalChannel.pockelCellSetting (java.lang.Integer)
|
Integer |
getSamplesPerPixel()
Simple field ome.model.core.LogicalChannel.samplesPerPixel (java.lang.Integer)
|
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() |
Iterator<Channel> |
iterateChannels()
should be used rather than accessing the channels set directly.
|
LogicalChannel |
newInstance() |
LogicalChannel |
proxy() |
void |
putAt(String field,
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(Collection<Channel> targets)
use like removeChannel
|
Object |
retrieve(String field)
retrieves a value from this instance.
|
protected void |
setChannels(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(String fluor) |
void |
setId(Long id)
usually unneeded.
|
void |
setIllumination(Illumination illumination) |
void |
setLightPath(LightPath lightPath) |
void |
setLightSourceSettings(LightSettings lightSourceSettings) |
void |
setMode(AcquisitionMode mode) |
void |
setName(String name) |
void |
setNdFilter(Double ndFilter) |
void |
setOtf(OTF otf) |
void |
setPhotometricInterpretation(PhotometricInterpretation photometricInterpretation) |
void |
setPinHoleSize(Length pinHoleSize) |
void |
setPockelCellSetting(Integer pockelCellSetting) |
void |
setSamplesPerPixel(Integer samplesPerPixel) |
void |
setVersion(Integer version)
use with caution.
|
int |
sizeOfChannels()
returns the size of channels.
|
protected void |
throwNullCollectionException(String propertyName) |
String |
toString() |
void |
unload()
set the loaded field to false, and set all non-ID fields to null.
|
Collection<Channel> |
unmodifiableChannels()
Returns an unmodifiable collection-view
|
Validation |
validate()
calls the class-specific validator for this instance and returns the
Validation object. |
public static final String OWNER_FILTER
public static final String GROUP_FILTER
public static final String EVENT_FILTER
public static final String PERMS_FILTER
public static final String ID
protected Long id
public static final String VERSION
protected Integer version
protected String name
protected Length pinHoleSize
protected Illumination illumination
protected ContrastMethod contrastMethod
protected Length excitationWave
protected Length emissionWave
protected String fluor
protected Double ndFilter
protected OTF otf
protected DetectorSettings detectorSettings
protected LightSettings lightSourceSettings
protected FilterSet filterSet
protected Integer samplesPerPixel
protected PhotometricInterpretation photometricInterpretation
protected AcquisitionMode mode
protected Integer pockelCellSetting
public static final String OWNER_FILTER_CHANNELS
public static final String GROUP_FILTER_CHANNELS
public static final String EVENT_FILTER_CHANNELS
public static final String PERMS_FILTER_CHANNELS
protected LightPath lightPath
protected Details details
public static final String NAME
public static final String PINHOLESIZE
public static final String ILLUMINATION
public static final String CONTRASTMETHOD
public static final String EXCITATIONWAVE
public static final String EMISSIONWAVE
public static final String FLUOR
public static final String NDFILTER
public static final String OTF
public static final String DETECTORSETTINGS
public static final String LIGHTSOURCESETTINGS
public static final String FILTERSET
public static final String SAMPLESPERPIXEL
public static final String PHOTOMETRICINTERPRETATION
public static final String MODE
public static final String POCKELCELLSETTING
public static final String CHANNELS
public static final String LIGHTPATH
public static final String DETAILS
protected boolean _loaded
public LogicalChannel()
protected LogicalChannel(Long id)
public LogicalChannel(Long id, boolean loaded)
@DocumentId public Long getId()
public void setId(Long id)
IObject
public Integer getVersion()
getVersion
in interface IMutable
public void setVersion(Integer version)
IMutable
setVersion
in interface IMutable
version
- Value for this objects version.@Fields(value={@Field(index=TOKENIZED),@Field(index=TOKENIZED,name="combined_fields")}) public String getName()
public void setName(String name)
public Length getPinHoleSize()
public void setPinHoleSize(Length pinHoleSize)
public Illumination getIllumination()
public void setIllumination(Illumination illumination)
public ContrastMethod getContrastMethod()
public void setContrastMethod(ContrastMethod contrastMethod)
public Length getExcitationWave()
public void setExcitationWave(Length excitationWave)
public Length getEmissionWave()
public void setEmissionWave(Length emissionWave)
@Fields(value={@Field(index=TOKENIZED),@Field(index=TOKENIZED,name="combined_fields")}) public String getFluor()
public void setFluor(String fluor)
@Fields(value={@Field(index=UN_TOKENIZED),@Field(index=UN_TOKENIZED,name="combined_fields")}) public Double getNdFilter()
public void setNdFilter(Double ndFilter)
public OTF getOtf()
public void setOtf(OTF otf)
public DetectorSettings getDetectorSettings()
public void setDetectorSettings(DetectorSettings detectorSettings)
public LightSettings getLightSourceSettings()
public void setLightSourceSettings(LightSettings lightSourceSettings)
public FilterSet getFilterSet()
public void setFilterSet(FilterSet filterSet)
@Fields(value={@Field(index=UN_TOKENIZED),@Field(index=UN_TOKENIZED,name="combined_fields")}) public Integer getSamplesPerPixel()
public void setSamplesPerPixel(Integer samplesPerPixel)
public PhotometricInterpretation getPhotometricInterpretation()
public void setPhotometricInterpretation(PhotometricInterpretation photometricInterpretation)
public AcquisitionMode getMode()
public void setMode(AcquisitionMode mode)
@Fields(value={@Field(index=UN_TOKENIZED),@Field(index=UN_TOKENIZED,name="combined_fields")}) public Integer getPockelCellSetting()
public void setPockelCellSetting(Integer pockelCellSetting)
protected Set<Channel> getChannels()
protected void setChannels(Set<Channel> channels)
public int sizeOfChannels()
public Iterator<Channel> iterateChannels()
EmptyIterator
. To test for a null collection,
see of sizeOfChannels()
is less than zero.public Collection<Channel> unmodifiableChannels()
public <E> List<E> collectChannels(CBlock<E> block)
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.public void addChannel(Channel target)
public void addChannelSet(Collection<Channel> targets)
public void removeChannel(Channel target)
public void removeChannelSet(Collection<Channel> targets)
public void clearChannels()
public LightPath getLightPath()
public void setLightPath(LightPath lightPath)
public Details getDetails()
Details
type.getDetails
in interface IObject
protected void setDetails(Details details)
Details.copy(ome.model.internal.Details)
or Details.shallowCopy(ome.model.internal.Details)
methods to set the LogicalChannel.Details
instance instead.public boolean isValid()
IObject
Validation.isValid()
public Validation validate()
IObject
Validation
object.public LogicalChannel newInstance()
public LogicalChannel proxy()
public boolean acceptFilter(Filter __filter)
acceptFilter
in interface Filterable
public Set<String> fields()
IObject
public Object retrieve(String field)
IObject
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)
public void putAt(String field, Object value)
IObject
field
which
match a field of this instance will be delegated to the accessors.
Otherwise, values will be stored in a lazy-loaded map.public boolean isLoaded()
IObject
protected void errorIfUnloaded()
public void unload()
IObject
public final GraphHolder getGraphHolder()
IObject
GraphHolder
for this entity. If the GraphHolder has
not been actively set, a new one will be instatiated.getGraphHolder
in interface IObject
protected void throwNullCollectionException(String propertyName)
Version: 5.1.3-ice35-b52
Copyright © 2015 The University of Dundee & Open Microscopy Environment. All Rights Reserved.