Package ome.model.display

Class ChannelBinding

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

    • Field Detail

      • id

        protected java.lang.Long id

      • version

        protected java.lang.Integer version

      • family

        protected Family family

      • coefficient

        protected java.lang.Double coefficient

      • inputStart

        protected java.lang.Double inputStart

      • inputEnd

        protected java.lang.Double inputEnd

      • active

        protected java.lang.Boolean active

      • noiseReduction

        protected java.lang.Boolean noiseReduction

      • red

        protected java.lang.Integer red

      • green

        protected java.lang.Integer green

      • blue

        protected java.lang.Integer blue

      • alpha

        protected java.lang.Integer alpha

      • lookupTable

        protected java.lang.String lookupTable

      • spatialDomainEnhancement

        protected java.util.List<CodomainMapContext> spatialDomainEnhancement

      • OWNER_FILTER_SPATIALDOMAINENHANCEMENT

        public static final java.lang.String OWNER_FILTER_SPATIALDOMAINENHANCEMENT
        See Also:
        Constant Field Values

      • GROUP_FILTER_SPATIALDOMAINENHANCEMENT

        public static final java.lang.String GROUP_FILTER_SPATIALDOMAINENHANCEMENT
        See Also:
        Constant Field Values

      • EVENT_FILTER_SPATIALDOMAINENHANCEMENT

        public static final java.lang.String EVENT_FILTER_SPATIALDOMAINENHANCEMENT
        See Also:
        Constant Field Values

      • PERMS_FILTER_SPATIALDOMAINENHANCEMENT

        public static final java.lang.String PERMS_FILTER_SPATIALDOMAINENHANCEMENT
        See Also:
        Constant Field Values

      • details

        protected Details details

      • SPATIALDOMAINENHANCEMENT

        public static final java.lang.String SPATIALDOMAINENHANCEMENT
        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

      • ChannelBinding

        public ChannelBinding()

      • ChannelBinding

        protected ChannelBinding​(java.lang.Long id)

      • ChannelBinding

        public ChannelBinding​(java.lang.Long id,
                      boolean loaded)
        Main constructor.

      • ChannelBinding

        public ChannelBinding​(RenderingDef _renderingDef,
                      Family _family,
                      java.lang.Double _coefficient,
                      java.lang.Double _inputStart,
                      java.lang.Double _inputEnd,
                      java.lang.Boolean _active,
                      java.lang.Boolean _noiseReduction,
                      java.lang.Integer _red,
                      java.lang.Integer _green,
                      java.lang.Integer _blue,
                      java.lang.Integer _alpha)

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

      • getRenderingDef

        public RenderingDef getRenderingDef()
        Many-to-one field ome.model.display.ChannelBinding.renderingDef (ome.model.display.RenderingDef)

      • setRenderingDef

        public void setRenderingDef​(RenderingDef renderingDef)

      • getFamily

        public Family getFamily()
        Many-to-one field ome.model.display.ChannelBinding.family (ome.model.enums.Family)

      • setFamily

        public void setFamily​(Family family)

      • getCoefficient

        @Field(index=UN_TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields")
public java.lang.Double getCoefficient()
        Simple field ome.model.display.ChannelBinding.coefficient (java.lang.Double)

      • setCoefficient

        public void setCoefficient​(java.lang.Double coefficient)

      • getInputStart

        @Field(index=UN_TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields")
public java.lang.Double getInputStart()
        Simple field ome.model.display.ChannelBinding.inputStart (java.lang.Double)

      • setInputStart

        public void setInputStart​(java.lang.Double inputStart)

      • getInputEnd

        @Field(index=UN_TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields")
public java.lang.Double getInputEnd()
        Simple field ome.model.display.ChannelBinding.inputEnd (java.lang.Double)

      • setInputEnd

        public void setInputEnd​(java.lang.Double inputEnd)

      • getActive

        public java.lang.Boolean getActive()
        Simple field ome.model.display.ChannelBinding.active (java.lang.Boolean)

      • setActive

        public void setActive​(java.lang.Boolean active)

      • getNoiseReduction

        public java.lang.Boolean getNoiseReduction()
        Simple field ome.model.display.ChannelBinding.noiseReduction (java.lang.Boolean)

      • setNoiseReduction

        public void setNoiseReduction​(java.lang.Boolean noiseReduction)

      • getRed

        @Field(index=UN_TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields")
public java.lang.Integer getRed()
        Simple field ome.model.display.ChannelBinding.red (java.lang.Integer)

      • setRed

        public void setRed​(java.lang.Integer red)

      • getGreen

        @Field(index=UN_TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields")
public java.lang.Integer getGreen()
        Simple field ome.model.display.ChannelBinding.green (java.lang.Integer)

      • setGreen

        public void setGreen​(java.lang.Integer green)

      • getBlue

        @Field(index=UN_TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields")
public java.lang.Integer getBlue()
        Simple field ome.model.display.ChannelBinding.blue (java.lang.Integer)

      • setBlue

        public void setBlue​(java.lang.Integer blue)

      • getAlpha

        @Field(index=UN_TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields")
public java.lang.Integer getAlpha()
        Simple field ome.model.display.ChannelBinding.alpha (java.lang.Integer)

      • setAlpha

        public void setAlpha​(java.lang.Integer alpha)

      • getLookupTable

        @Field(index=TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields")
public java.lang.String getLookupTable()
        Simple field ome.model.display.ChannelBinding.lookupTable (java.lang.String)

      • setLookupTable

        public void setLookupTable​(java.lang.String lookupTable)

      • getSpatialDomainEnhancement

        protected java.util.List<CodomainMapContext> getSpatialDomainEnhancement()
        returns spatialDomainEnhancement . You should not modify this collection unless you know what you are doing. Use the iterate method instead. one-to-many List ome.model.display.ChannelBinding.spatialDomainEnhancement (ome.model.display.CodomainMapContext) Values are indexed by the column "index" on ome.model.display.CodomainMapContext

      • setSpatialDomainEnhancement

        protected void setSpatialDomainEnhancement​(java.util.List<CodomainMapContext> spatialDomainEnhancement)
        setter for spatialDomainEnhancement should be avoided. Does not fulfill normal semantics.

      • sizeOfSpatialDomainEnhancement

        public int sizeOfSpatialDomainEnhancement()
        returns the size of spatialDomainEnhancement. If less than zero, the Set was null.

      • iterateSpatialDomainEnhancement

        public java.util.Iterator<CodomainMapContext> iterateSpatialDomainEnhancement()
        should be used rather than accessing the spatialDomainEnhancement set directly. This method will never return null, but rather will return an instance of EmptyIterator. To test for a null collection, see of sizeOfSpatialDomainEnhancement() is less than zero.

      • unmodifiableSpatialDomainEnhancement

        public java.util.Collection<CodomainMapContext> unmodifiableSpatialDomainEnhancement()
        Returns an unmodifiable collection-view

      • collectSpatialDomainEnhancement

        public <E> java.util.List<E> collectSpatialDomainEnhancement​(CBlock<E> block)
        takes a CBlock and calls the block once for each ome.model.display.CodomainMapContext while collecting the results. If block == null, then the iterator values themselves are collected. This method uses iterateSpatialDomainEnhancement() internally and so will return a value even if the underlying collection is null.

      • addCodomainMapContext

        public void addCodomainMapContext​(CodomainMapContext target)
        use instead of setSpatialDomainEnhancement . Makes the necessary call on ome.model.display.CodomainMapContext as well.

      • addCodomainMapContextSet

        public void addCodomainMapContextSet​(java.util.Collection<CodomainMapContext> targets)
        use like addCodomainMapContext.

      • removeCodomainMapContext

        public void removeCodomainMapContext​(CodomainMapContext target)
        removes a single element from this set and makes the inverse call on ome.model.display.CodomainMapContext

      • removeCodomainMapContextSet

        public void removeCodomainMapContextSet​(java.util.Collection<CodomainMapContext> targets)
        use like removeCodomainMapContext

      • clearSpatialDomainEnhancement

        public void clearSpatialDomainEnhancement()
        clears the set.

      • getCodomainMapContext

        public CodomainMapContext getCodomainMapContext​(int index)
                                         throws java.lang.IndexOutOfBoundsException
        Gets the ome.model.display.CodomainMapContext at the given index.
        Throws:
        java.lang.IndexOutOfBoundsException

      • setCodomainMapContext

        public CodomainMapContext setCodomainMapContext​(int index,
                                                CodomainMapContext element)
                                         throws java.lang.IndexOutOfBoundsException
        Sets the ome.model.display.CodomainMapContext at the given index. Adheres to the List.set(int, Object) contract. To extend the list, use addCodomainMapContext(CodomainMapContext).
        Throws:
        java.lang.IndexOutOfBoundsException
        See Also:
        List.set(int, Object)

      • getPrimaryCodomainMapContext

        public CodomainMapContext getPrimaryCodomainMapContext()
                                                throws java.lang.IndexOutOfBoundsException
        Gets the first element of spatialDomainEnhancement which can be interpreted as the primary or default element in some situations. If there is not first element, an IndexOutOfBoundsException is throws. This method will also throw an ApiUsageException if the collection is unloaded. See sizeOfSpatialDomainEnhancement() for more information.
        Throws:
        java.lang.IndexOutOfBoundsException

      • setPrimaryCodomainMapContext

        public CodomainMapContext setPrimaryCodomainMapContext​(CodomainMapContext element)
                                                throws java.lang.IndexOutOfBoundsException
        Swaps the first element of spatialDomainEnhancement with the first instance of the given element. If the given element is not in the list, an IndexOutOfBoundsException will be thrown. Returns the swapped element. This method will also throw an ApiUsageException if the collection is unloaded. See sizeOfSpatialDomainEnhancement() for more information.
        Throws:
        java.lang.IndexOutOfBoundsException

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