Package ome.model.core

Class 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

    • 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,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),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,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),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=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),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=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),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)

      • getPockelCellSetting

        @Field(index=UN_TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),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)

      • 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.

      • 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)