Package ome.model.screen

Class Screen

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

      • type

        protected java.lang.String type

      • protocolIdentifier

        protected java.lang.String protocolIdentifier

      • protocolDescription

        protected java.lang.String protocolDescription

      • reagentSetIdentifier

        protected java.lang.String reagentSetIdentifier

      • reagentSetDescription

        protected java.lang.String reagentSetDescription

      • OWNER_FILTER_PLATELINKS

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

      • GROUP_FILTER_PLATELINKS

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

      • EVENT_FILTER_PLATELINKS

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

      • PERMS_FILTER_PLATELINKS

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

      • reagents

        protected java.util.Set<Reagent> reagents

      • OWNER_FILTER_REAGENTS

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

      • GROUP_FILTER_REAGENTS

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

      • EVENT_FILTER_REAGENTS

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

      • PERMS_FILTER_REAGENTS

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

      • 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

      • name

        protected java.lang.String name

      • description

        protected java.lang.String description

      • details

        protected Details details

      • PROTOCOLIDENTIFIER

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

      • PROTOCOLDESCRIPTION

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

      • REAGENTSETIDENTIFIER

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

      • REAGENTSETDESCRIPTION

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

      • PLATELINKSCOUNTPEROWNER

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

      • Screen

        public Screen()

      • Screen

        protected Screen​(java.lang.Long id)

      • Screen

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

      • Screen

        public Screen​(java.lang.String _name)

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

      • getType

        @Field(index=TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields")
public java.lang.String getType()
        Simple field ome.model.screen.Screen.type (java.lang.String)

      • setType

        public void setType​(java.lang.String type)

      • getProtocolIdentifier

        @Field(index=TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields")
public java.lang.String getProtocolIdentifier()
        Simple field ome.model.screen.Screen.protocolIdentifier (java.lang.String)

      • setProtocolIdentifier

        public void setProtocolIdentifier​(java.lang.String protocolIdentifier)

      • getProtocolDescription

        @Field(index=TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields")
public java.lang.String getProtocolDescription()
        Simple field ome.model.screen.Screen.protocolDescription (java.lang.String)

      • setProtocolDescription

        public void setProtocolDescription​(java.lang.String protocolDescription)

      • getReagentSetIdentifier

        @Field(index=TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields")
public java.lang.String getReagentSetIdentifier()
        Simple field ome.model.screen.Screen.reagentSetIdentifier (java.lang.String)

      • setReagentSetIdentifier

        public void setReagentSetIdentifier​(java.lang.String reagentSetIdentifier)

      • getReagentSetDescription

        @Field(index=TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields")
public java.lang.String getReagentSetDescription()
        Simple field ome.model.screen.Screen.reagentSetDescription (java.lang.String)

      • setReagentSetDescription

        public void setReagentSetDescription​(java.lang.String reagentSetDescription)

      • getPlateLinks

        protected java.util.Set<ScreenPlateLink> getPlateLinks()
        returns plateLinks . You should not modify this collection unless you know what you are doing. Use the iterate method instead. one-to-many Set ome.model.screen.Screen.plateLinks (ome.model.screen.ScreenPlateLink)

      • setPlateLinks

        protected void setPlateLinks​(java.util.Set<ScreenPlateLink> plateLinks)
        setter for plateLinks should be avoided. Does not fulfill normal semantics.

      • sizeOfPlateLinks

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

      • iteratePlateLinks

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

      • unmodifiablePlateLinks

        public java.util.Collection<ScreenPlateLink> unmodifiablePlateLinks()
        Returns an unmodifiable collection-view

      • collectPlateLinks

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

      • addScreenPlateLink

        public void addScreenPlateLink​(ScreenPlateLink target)
        use instead of setPlateLinks . Makes the necessary call on ome.model.screen.ScreenPlateLink as well.

      • addScreenPlateLinkSet

        public void addScreenPlateLinkSet​(java.util.Collection<ScreenPlateLink> targets)
        use like addScreenPlateLink.

      • removeScreenPlateLink

        public void removeScreenPlateLink​(ScreenPlateLink target)
        removes a single element from this set and makes the inverse call on ome.model.screen.ScreenPlateLink

      • removeScreenPlateLinkSet

        public void removeScreenPlateLinkSet​(java.util.Collection<ScreenPlateLink> targets)
        use like removeScreenPlateLink

      • linkPlate

        public ScreenPlateLink linkPlate​(Plate addition)
        Adds a ome.model.screen.ScreenPlateLink to plateLinks . This entails changing our plateLinks Set, creating a new ome.model.screen.ScreenPlateLink and calling linkPlate on the ome.model.screen.Plate.

      • addScreenPlateLink

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

      • linkedPlateIterator

        public java.util.Iterator<Plate> linkedPlateIterator()
        provides an iterator over the parent values of the plateLinks. Like with most Collection iterators, modifications to the underlying collection while iterating will result in an ConcurrentModificationException. Use linkedPlateList() instead.

      • findScreenPlateLink

        public java.util.Set<ScreenPlateLink> findScreenPlateLink​(Plate target)
        find all ome.model.screen.ScreenPlateLink which have the argument as their child.

      • linkedPlateList

        public java.util.List<Plate> linkedPlateList()
        produces a List-copy of the underlying collection. Unlike, linkedPlateIterator(), while using the returned List, modifications can be made to the underlying collection without throwing ConcurrentModificationException.

      • eachLinkedPlate

        public <E> java.util.List<E> eachLinkedPlate​(CBlock<E> block)
        takes a CBlock and calls the block once for each ome.model.screen.Plate while collecting the results. If block == null, then the iterator values themselves are collected.

      • unlinkPlate

        public void unlinkPlate​(Plate removal)
        unlinks all ome.model.screen.Plate instances from this instance.

      • removeScreenPlateLink

        public void removeScreenPlateLink​(ScreenPlateLink link,
                                  boolean bothSides)
        removes the given ScreenPlateLink from plateLinks, allowing for recursion -- whether or not the removal will call unlinkScreen again if loaded.

      • clearPlateLinks

        public void clearPlateLinks()
        clears the set.

      • setPlateLinksCountPerOwner

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

      • getPlateLinksCountPerOwner

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

      • getReagents

        protected java.util.Set<Reagent> getReagents()
        returns reagents . You should not modify this collection unless you know what you are doing. Use the iterate method instead. one-to-many Set ome.model.screen.Screen.reagents (ome.model.screen.Reagent)

      • setReagents

        protected void setReagents​(java.util.Set<Reagent> reagents)
        setter for reagents should be avoided. Does not fulfill normal semantics.

      • sizeOfReagents

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

      • iterateReagents

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

      • unmodifiableReagents

        public java.util.Collection<Reagent> unmodifiableReagents()
        Returns an unmodifiable collection-view

      • collectReagents

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

      • addReagent

        public void addReagent​(Reagent target)
        use instead of setReagents . Makes the necessary call on ome.model.screen.Reagent as well.

      • addReagentSet

        public void addReagentSet​(java.util.Collection<Reagent> targets)
        use like addReagent.

      • removeReagent

        public void removeReagent​(Reagent target)
        removes a single element from this set and makes the inverse call on ome.model.screen.Reagent

      • removeReagentSet

        public void removeReagentSet​(java.util.Collection<Reagent> targets)
        use like removeReagent

      • clearReagents

        public void clearReagents()
        clears the set.

      • getAnnotationLinks

        protected java.util.Set<ScreenAnnotationLink> 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.screen.Screen.annotationLinks (ome.model.annotations.ScreenAnnotationLink)

      • setAnnotationLinks

        protected void setAnnotationLinks​(java.util.Set<ScreenAnnotationLink> 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.ScreenAnnotationLink 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

      • addScreenAnnotationLink

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

      • addScreenAnnotationLinkSet

        public void addScreenAnnotationLinkSet​(java.util.Collection<ScreenAnnotationLink> targets)
        use like addScreenAnnotationLink.

      • removeScreenAnnotationLink

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

      • removeScreenAnnotationLinkSet

        public void removeScreenAnnotationLinkSet​(java.util.Collection<ScreenAnnotationLink> targets)
        use like removeScreenAnnotationLink

      • linkAnnotation

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

      • addScreenAnnotationLink

        public void addScreenAnnotationLink​(ScreenAnnotationLink link,
                                    boolean bothSides)
        Adds a ome.model.annotations.ScreenAnnotationLink to annotationLinks, allowing for recursion -- whether or not addScreenAnnotationLink 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

      • findScreenAnnotationLink

        public java.util.Set<ScreenAnnotationLink> findScreenAnnotationLink​(Annotation target)
        find all ome.model.annotations.ScreenAnnotationLink 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

      • removeScreenAnnotationLink

        public void removeScreenAnnotationLink​(ScreenAnnotationLink link,
                                       boolean bothSides)
        removes the given ScreenAnnotationLink from annotationLinks, allowing for recursion -- whether or not the removal will call unlinkScreen 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.ScreenAnnotationLink that a user has. If unfetched, returns null. No entries in the collection should be null.

      • getName

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

      • setName

        public void setName​(java.lang.String name)

      • getDescription

        @Field(index=TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields")
public java.lang.String getDescription()
        Simple field ome.model.screen.Screen.description (java.lang.String)

      • setDescription

        public void setDescription​(java.lang.String description)

      • 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 Screen newInstance()

      • proxy

        public Screen proxy()

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