Package ome.model.meta

Class Experimenter

    • Field Detail

      • id

        protected java.lang.Long id

      • version

        protected java.lang.Integer version

      • omeName

        protected java.lang.String omeName

      • firstName

        protected java.lang.String firstName

      • middleName

        protected java.lang.String middleName

      • lastName

        protected java.lang.String lastName

      • institution

        protected java.lang.String institution

      • ldap

        protected java.lang.Boolean ldap

      • email

        protected java.lang.String email

      • config

        protected java.util.List<NamedValue> config

      • 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

      • GROUPEXPERIMENTERMAP

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

      • Experimenter

        public Experimenter()

      • Experimenter

        protected Experimenter​(java.lang.Long id)

      • Experimenter

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

      • Experimenter

        public Experimenter​(java.lang.String _omeName,
                    java.lang.String _firstName,
                    java.lang.String _lastName,
                    java.lang.Boolean _ldap)

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

      • getGroupExperimenterMap

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

      • setGroupExperimenterMap

        protected void setGroupExperimenterMap​(java.util.List<GroupExperimenterMap> groupExperimenterMap)
        setter for groupExperimenterMap should be avoided. Does not fulfill normal semantics.

      • sizeOfGroupExperimenterMap

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

      • iterateGroupExperimenterMap

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

      • unmodifiableGroupExperimenterMap

        public java.util.Collection<GroupExperimenterMap> unmodifiableGroupExperimenterMap()
        Returns an unmodifiable collection-view

      • collectGroupExperimenterMap

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

      • addGroupExperimenterMap

        public void addGroupExperimenterMap​(GroupExperimenterMap target)
        use instead of setGroupExperimenterMap . Makes the necessary call on ome.model.meta.GroupExperimenterMap as well.

      • addGroupExperimenterMapSet

        public void addGroupExperimenterMapSet​(java.util.Collection<GroupExperimenterMap> targets)
        use like addGroupExperimenterMap.

      • removeGroupExperimenterMap

        public void removeGroupExperimenterMap​(GroupExperimenterMap target)
        removes a single element from this set and makes the inverse call on ome.model.meta.GroupExperimenterMap

      • removeGroupExperimenterMapSet

        public void removeGroupExperimenterMapSet​(java.util.Collection<GroupExperimenterMap> targets)
        use like removeGroupExperimenterMap

      • getGroupExperimenterMap

        public GroupExperimenterMap getGroupExperimenterMap​(int index)
                                             throws java.lang.IndexOutOfBoundsException
        Gets the ome.model.meta.GroupExperimenterMap at the given index.
        Throws:
        java.lang.IndexOutOfBoundsException

      • setGroupExperimenterMap

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

      • getPrimaryGroupExperimenterMap

        public GroupExperimenterMap getPrimaryGroupExperimenterMap()
                                                    throws java.lang.IndexOutOfBoundsException
        Gets the first element of groupExperimenterMap 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 sizeOfGroupExperimenterMap() for more information.
        Throws:
        java.lang.IndexOutOfBoundsException

      • setPrimaryGroupExperimenterMap

        public GroupExperimenterMap setPrimaryGroupExperimenterMap​(GroupExperimenterMap element)
                                                    throws java.lang.IndexOutOfBoundsException
        Swaps the first element of groupExperimenterMap 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 sizeOfGroupExperimenterMap() for more information.
        Throws:
        java.lang.IndexOutOfBoundsException

      • linkExperimenterGroup

        public GroupExperimenterMap linkExperimenterGroup​(ExperimenterGroup addition)
        Adds a ome.model.meta.GroupExperimenterMap to groupExperimenterMap . This entails changing our groupExperimenterMap Set, creating a new ome.model.meta.GroupExperimenterMap and calling linkExperimenterGroup on the ome.model.meta.ExperimenterGroup.

      • addGroupExperimenterMap

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

      • linkedExperimenterGroupIterator

        public java.util.Iterator<ExperimenterGroup> linkedExperimenterGroupIterator()
        provides an iterator over the child values of the groupExperimenterMap. Like with most Collection iterators, modifications to the underlying collection while iterating will result in an ConcurrentModificationException. Use linkedExperimenterGroupList() instead.

      • findGroupExperimenterMap

        public java.util.Set<GroupExperimenterMap> findGroupExperimenterMap​(ExperimenterGroup target)
        find all ome.model.meta.GroupExperimenterMap which have the argument as their parent.

      • linkedExperimenterGroupList

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

      • eachLinkedExperimenterGroup

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

      • unlinkExperimenterGroup

        public void unlinkExperimenterGroup​(ExperimenterGroup removal)
        unlinks all ome.model.meta.ExperimenterGroup instances from this instance.

      • removeGroupExperimenterMap

        public void removeGroupExperimenterMap​(GroupExperimenterMap link,
                                       boolean bothSides)
        removes the given GroupExperimenterMap from groupExperimenterMap, allowing for recursion -- whether or not the removal will call unlinkExperimenter again if loaded.

      • clearExperimenterGroupLinks

        public void clearExperimenterGroupLinks()
        clears the set.

      • getOmeName

        @Field(index=TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields")
public java.lang.String getOmeName()
        Simple field ome.model.meta.Experimenter.omeName (java.lang.String)

      • setOmeName

        public void setOmeName​(java.lang.String omeName)

      • getFirstName

        @Field(index=TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields")
public java.lang.String getFirstName()
        Simple field ome.model.meta.Experimenter.firstName (java.lang.String)

      • setFirstName

        public void setFirstName​(java.lang.String firstName)

      • getMiddleName

        @Field(index=TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields")
public java.lang.String getMiddleName()
        Simple field ome.model.meta.Experimenter.middleName (java.lang.String)

      • setMiddleName

        public void setMiddleName​(java.lang.String middleName)

      • getLastName

        @Field(index=TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields")
public java.lang.String getLastName()
        Simple field ome.model.meta.Experimenter.lastName (java.lang.String)

      • setLastName

        public void setLastName​(java.lang.String lastName)

      • getInstitution

        @Field(index=TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields")
public java.lang.String getInstitution()
        Simple field ome.model.meta.Experimenter.institution (java.lang.String)

      • setInstitution

        public void setInstitution​(java.lang.String institution)

      • getLdap

        public java.lang.Boolean getLdap()
        Simple field ome.model.meta.Experimenter.ldap (java.lang.Boolean)

      • setLdap

        public void setLdap​(java.lang.Boolean ldap)

      • getEmail

        @Field(index=TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields")
public java.lang.String getEmail()
        Simple field ome.model.meta.Experimenter.email (java.lang.String)

      • setEmail

        public void setEmail​(java.lang.String email)

      • setConfig

        public void setConfig​(java.util.List<NamedValue> map)

      • getConfig

        public java.util.List<NamedValue> getConfig()

      • getAnnotationLinks

        protected java.util.Set<ExperimenterAnnotationLink> 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.meta.Experimenter.annotationLinks (ome.model.annotations.ExperimenterAnnotationLink)

      • setAnnotationLinks

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

      • addExperimenterAnnotationLink

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

      • addExperimenterAnnotationLinkSet

        public void addExperimenterAnnotationLinkSet​(java.util.Collection<ExperimenterAnnotationLink> targets)
        use like addExperimenterAnnotationLink.

      • removeExperimenterAnnotationLink

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

      • removeExperimenterAnnotationLinkSet

        public void removeExperimenterAnnotationLinkSet​(java.util.Collection<ExperimenterAnnotationLink> targets)
        use like removeExperimenterAnnotationLink

      • linkAnnotation

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

      • addExperimenterAnnotationLink

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

      • findExperimenterAnnotationLink

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

      • removeExperimenterAnnotationLink

        public void removeExperimenterAnnotationLink​(ExperimenterAnnotationLink link,
                                             boolean bothSides)
        removes the given ExperimenterAnnotationLink from annotationLinks, allowing for recursion -- whether or not the removal will call unlinkExperimenter 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.ExperimenterAnnotationLink 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.

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