Package ome.model.acquisition

Class Objective

  • All Implemented Interfaces:
    java.io.Serializable, IAnnotated, IMutable, IObject, Filterable
    @Entity
@Indexed(index="FullText")
@ClassBridge(name="details",
             impl=DetailsFieldBridge.class,
             index=UN_TOKENIZED,
             store=NO)
public class Objective
extends java.lang.Object
implements java.io.Serializable, IObject, IMutable, IAnnotated
    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

      • manufacturer

        protected java.lang.String manufacturer

      • model

        protected java.lang.String model

      • lotNumber

        protected java.lang.String lotNumber

      • serialNumber

        protected java.lang.String serialNumber

      • nominalMagnification

        protected java.lang.Double nominalMagnification

      • calibratedMagnification

        protected java.lang.Double calibratedMagnification

      • lensNA

        protected java.lang.Double lensNA

      • workingDistance

        protected Length workingDistance

      • iris

        protected java.lang.Boolean iris

      • OWNER_FILTER_ANNOTATIONLINKS

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

      • GROUP_FILTER_ANNOTATIONLINKS

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

      • EVENT_FILTER_ANNOTATIONLINKS

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

      • PERMS_FILTER_ANNOTATIONLINKS

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

      • details

        protected Details details

      • NOMINALMAGNIFICATION

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

      • CALIBRATEDMAGNIFICATION

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

      • ANNOTATIONLINKSCOUNTPEROWNER

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

      • Objective

        public Objective()

      • Objective

        protected Objective​(java.lang.Long id)

      • Objective

        public Objective​(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.

      • getManufacturer

        @Field(index=TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields")
public java.lang.String getManufacturer()
        Simple field ome.model.acquisition.Objective.manufacturer (java.lang.String)

      • setManufacturer

        public void setManufacturer​(java.lang.String manufacturer)

      • getModel

        @Field(index=TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields")
public java.lang.String getModel()
        Simple field ome.model.acquisition.Objective.model (java.lang.String)

      • setModel

        public void setModel​(java.lang.String model)

      • getLotNumber

        @Field(index=TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields")
public java.lang.String getLotNumber()
        Simple field ome.model.acquisition.Objective.lotNumber (java.lang.String)

      • setLotNumber

        public void setLotNumber​(java.lang.String lotNumber)

      • getSerialNumber

        @Field(index=TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields")
public java.lang.String getSerialNumber()
        Simple field ome.model.acquisition.Objective.serialNumber (java.lang.String)

      • setSerialNumber

        public void setSerialNumber​(java.lang.String serialNumber)

      • getNominalMagnification

        @Field(index=UN_TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields")
public java.lang.Double getNominalMagnification()
        Simple field ome.model.acquisition.Objective.nominalMagnification (java.lang.Double)

      • setNominalMagnification

        public void setNominalMagnification​(java.lang.Double nominalMagnification)

      • getCalibratedMagnification

        @Field(index=UN_TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields")
public java.lang.Double getCalibratedMagnification()
        Simple field ome.model.acquisition.Objective.calibratedMagnification (java.lang.Double)

      • setCalibratedMagnification

        public void setCalibratedMagnification​(java.lang.Double calibratedMagnification)

      • getLensNA

        @Field(index=UN_TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields")
public java.lang.Double getLensNA()
        Simple field ome.model.acquisition.Objective.lensNA (java.lang.Double)

      • setLensNA

        public void setLensNA​(java.lang.Double lensNA)

      • getImmersion

        public Immersion getImmersion()
        Many-to-one field ome.model.acquisition.Objective.immersion (ome.model.enums.Immersion)

      • setImmersion

        public void setImmersion​(Immersion immersion)

      • getCorrection

        public Correction getCorrection()
        Many-to-one field ome.model.acquisition.Objective.correction (ome.model.enums.Correction)

      • setCorrection

        public void setCorrection​(Correction correction)

      • getWorkingDistance

        public Length getWorkingDistance()
        Enum-mapped unit-based field ome.model.acquisition.Objective.workingDistance (ome.model.units.Length)

      • setWorkingDistance

        public void setWorkingDistance​(Length workingDistance)

      • getIris

        public java.lang.Boolean getIris()
        Simple field ome.model.acquisition.Objective.iris (java.lang.Boolean)

      • setIris

        public void setIris​(java.lang.Boolean iris)

      • getInstrument

        public Instrument getInstrument()
        Many-to-one field ome.model.acquisition.Objective.instrument (ome.model.acquisition.Instrument)

      • setInstrument

        public void setInstrument​(Instrument instrument)

      • getAnnotationLinks

        protected java.util.Set<ObjectiveAnnotationLink> getAnnotationLinks()
        returns annotationLinks . You should not modify this collection unless you know what you are doing. Use the iterate method instead. one-to-many Set ome.model.acquisition.Objective.annotationLinks (ome.model.annotations.ObjectiveAnnotationLink)

      • setAnnotationLinks

        protected void setAnnotationLinks​(java.util.Set<ObjectiveAnnotationLink> annotationLinks)
        setter for annotationLinks should be avoided. Does not fulfill normal semantics.

      • sizeOfAnnotationLinks

        public int sizeOfAnnotationLinks()
        returns the size of annotationLinks. If less than zero, the Set was null.
        Specified by:
        sizeOfAnnotationLinks in interface IAnnotated

      • collectAnnotationLinks

        public <E> java.util.List<E> collectAnnotationLinks​(CBlock<E> block)
        takes a CBlock and calls the block once for each ome.model.annotations.ObjectiveAnnotationLink while collecting the results. If block == null, then the iterator values themselves are collected. This method uses iterateAnnotationLinks() internally and so will return a value even if the underlying collection is null.
        Specified by:
        collectAnnotationLinks in interface IAnnotated

      • addObjectiveAnnotationLink

        public void addObjectiveAnnotationLink​(ObjectiveAnnotationLink target)
        use instead of setAnnotationLinks . Makes the necessary call on ome.model.annotations.ObjectiveAnnotationLink as well.

      • addObjectiveAnnotationLinkSet

        public void addObjectiveAnnotationLinkSet​(java.util.Collection<ObjectiveAnnotationLink> targets)
        use like addObjectiveAnnotationLink.

      • removeObjectiveAnnotationLink

        public void removeObjectiveAnnotationLink​(ObjectiveAnnotationLink target)
        removes a single element from this set and makes the inverse call on ome.model.annotations.ObjectiveAnnotationLink

      • removeObjectiveAnnotationLinkSet

        public void removeObjectiveAnnotationLinkSet​(java.util.Collection<ObjectiveAnnotationLink> targets)
        use like removeObjectiveAnnotationLink

      • linkAnnotation

        public ObjectiveAnnotationLink linkAnnotation​(Annotation addition)
        Adds a ome.model.annotations.ObjectiveAnnotationLink to annotationLinks . This entails changing our annotationLinks Set, creating a new ome.model.annotations.ObjectiveAnnotationLink and calling linkAnnotation on the ome.model.annotations.Annotation.
        Specified by:
        linkAnnotation in interface IAnnotated

      • addObjectiveAnnotationLink

        public void addObjectiveAnnotationLink​(ObjectiveAnnotationLink link,
                                       boolean bothSides)
        Adds a ome.model.annotations.ObjectiveAnnotationLink to annotationLinks, allowing for recursion -- whether or not addObjectiveAnnotationLink will be called on the addition if it is loaded

      • linkedAnnotationIterator

        public java.util.Iterator<Annotation> linkedAnnotationIterator()
        provides an iterator over the parent values of the annotationLinks. Like with most Collection iterators, modifications to the underlying collection while iterating will result in an ConcurrentModificationException. Use linkedAnnotationList() instead.
        Specified by:
        linkedAnnotationIterator in interface IAnnotated

      • findObjectiveAnnotationLink

        public java.util.Set<ObjectiveAnnotationLink> findObjectiveAnnotationLink​(Annotation target)
        find all ome.model.annotations.ObjectiveAnnotationLink which have the argument as their child.

      • linkedAnnotationList

        public java.util.List<Annotation> linkedAnnotationList()
        produces a List-copy of the underlying collection. Unlike, linkedAnnotationIterator(), while using the returned List, modifications can be made to the underlying collection without throwing ConcurrentModificationException.
        Specified by:
        linkedAnnotationList in interface IAnnotated

      • eachLinkedAnnotation

        public <E> java.util.List<E> eachLinkedAnnotation​(CBlock<E> block)
        takes a CBlock and calls the block once for each ome.model.annotations.Annotation while collecting the results. If block == null, then the iterator values themselves are collected.
        Specified by:
        eachLinkedAnnotation in interface IAnnotated

      • unlinkAnnotation

        public void unlinkAnnotation​(Annotation removal)
        unlinks all ome.model.annotations.Annotation instances from this instance.
        Specified by:
        unlinkAnnotation in interface IAnnotated

      • removeObjectiveAnnotationLink

        public void removeObjectiveAnnotationLink​(ObjectiveAnnotationLink link,
                                          boolean bothSides)
        removes the given ObjectiveAnnotationLink from annotationLinks, allowing for recursion -- whether or not the removal will call unlinkObjective again if loaded.

      • setAnnotationLinksCountPerOwner

        protected void setAnnotationLinksCountPerOwner​(java.util.Map<java.lang.Long,​java.lang.Long> map)

      • getAnnotationLinksCountPerOwner

        public java.util.Map<java.lang.Long,​java.lang.Long> getAnnotationLinksCountPerOwner()
        If fetched, returns the count(*) of ome.model.annotations.ObjectiveAnnotationLink that a user has. If unfetched, returns null. No entries in the collection should be null.

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

      • newInstance

        public Objective newInstance()

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