Experimenter (OMERO API)

java.lang.Object
- ome.model.meta.Experimenter

All Implemented Interfaces:: Serializable, IAnnotated, IGlobal, IMutable, IObject, Filterable

@Entity
 @Indexed(index="FullText")
 @ClassBridge(name="details",
             impl=DetailsFieldBridge.class,
             index=UN_TOKENIZED,
             store=NO)
public class Experimenter
extends Object
implements Serializable, IObject, IGlobal, IMutable, IAnnotated

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Experimenter.Details

Nested Classes
Modifier and Type	Class and Description
`static class`	`Experimenter.Details`

Field Summary

Fields
Modifier and Type	Field and Description
`protected Map<String,Object>`	`_dynamicFields`
`protected boolean`	`_loaded`
`protected Set<ExperimenterAnnotationLink>`	`annotationLinks`
`static String`	`ANNOTATIONLINKS`
`static String`	`ANNOTATIONLINKSCOUNTPEROWNER`
`protected Details`	`details`
`static String`	`DETAILS`
`protected String`	`email`
`static String`	`EMAIL`
`static String`	`EVENT_FILTER_ANNOTATIONLINKS`
`static Set<String>`	`FIELDS`
`protected String`	`firstName`
`static String`	`FIRSTNAME`
`static String`	`GROUP_FILTER_ANNOTATIONLINKS`
`protected List<GroupExperimenterMap>`	`groupExperimenterMap`
`static String`	`GROUPEXPERIMENTERMAP`
`protected Long`	`id`
`static String`	`ID`
`protected String`	`institution`
`static String`	`INSTITUTION`
`protected String`	`lastName`
`static String`	`LASTNAME`
`protected Boolean`	`ldap`
`static String`	`LDAP`
`protected String`	`middleName`
`static String`	`MIDDLENAME`
`protected String`	`omeName`
`static String`	`OMENAME`
`static String`	`OWNER_FILTER_ANNOTATIONLINKS`
`static String`	`PERMS_FILTER_ANNOTATIONLINKS`
`protected Integer`	`version`
`static String`	`VERSION`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`Experimenter()`
`protected`	`Experimenter(Long id)`
	`Experimenter(Long id, boolean loaded)` Main constructor.
	`Experimenter(String _omeName, String _firstName, String _lastName, Boolean _ldap)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`acceptFilter(Filter __filter)`
`void`	`addExperimenterAnnotationLink(ExperimenterAnnotationLink target)` use instead of setAnnotationLinks .
`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
`void`	`addExperimenterAnnotationLinkSet(Collection<ExperimenterAnnotationLink> targets)` use like addExperimenterAnnotationLink.
`void`	`addGroupExperimenterMap(GroupExperimenterMap target)` use instead of setGroupExperimenterMap .
`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
`void`	`addGroupExperimenterMapSet(Collection<GroupExperimenterMap> targets)` use like addGroupExperimenterMap.
`void`	`clearAnnotationLinks()` clears the set.
`void`	`clearExperimenterGroupLinks()` clears the set.
`<E> List<E>`	`collectAnnotationLinks(CBlock<E> block)` takes a CBlock and calls the block once for each ome.model.annotations.ExperimenterAnnotationLink while collecting the results.
`<E> List<E>`	`collectGroupExperimenterMap(CBlock<E> block)` takes a CBlock and calls the block once for each ome.model.meta.GroupExperimenterMap while collecting the results.
`<E> List<E>`	`eachLinkedAnnotation(CBlock<E> block)` takes a CBlock and calls the block once for each ome.model.annotations.Annotation while collecting the results.
`<E> List<E>`	`eachLinkedExperimenterGroup(CBlock<E> block)` takes a CBlock and calls the block once for each ome.model.meta.ExperimenterGroup while collecting the results.
`protected void`	`errorIfUnloaded()`
`Set<String>`	`fields()` returns a Set of field names that belong to this class
`Set<ExperimenterAnnotationLink>`	`findExperimenterAnnotationLink(Annotation target)` find all ome.model.annotations.ExperimenterAnnotationLink which have the argument as their child.
`Set<GroupExperimenterMap>`	`findGroupExperimenterMap(ExperimenterGroup target)` find all ome.model.meta.GroupExperimenterMap which have the argument as their parent.
`protected Set<ExperimenterAnnotationLink>`	`getAnnotationLinks()` returns annotationLinks .
`Map<Long,Long>`	`getAnnotationLinksCountPerOwner()` If fetched, returns the count(*) of ome.model.annotations.ExperimenterAnnotationLink that a user has.
`Details`	`getDetails()` The details of this object correspond to low-level system information.
`String`	`getEmail()` Simple field ome.model.meta.Experimenter.email (java.lang.String)
`String`	`getFirstName()` Simple field ome.model.meta.Experimenter.firstName (java.lang.String)
`GraphHolder`	`getGraphHolder()` retrieves the `GraphHolder` for this entity.
`protected List<GroupExperimenterMap>`	`getGroupExperimenterMap()` returns groupExperimenterMap .
`GroupExperimenterMap`	`getGroupExperimenterMap(int index)` Gets the ome.model.meta.GroupExperimenterMap at the given index.
`Long`	`getId()` The DB unique identifier for this object.
`String`	`getInstitution()` Simple field ome.model.meta.Experimenter.institution (java.lang.String)
`String`	`getLastName()` Simple field ome.model.meta.Experimenter.lastName (java.lang.String)
`Boolean`	`getLdap()` Simple field ome.model.meta.Experimenter.ldap (java.lang.Boolean)
`String`	`getMiddleName()` Simple field ome.model.meta.Experimenter.middleName (java.lang.String)
`String`	`getOmeName()` Simple field ome.model.meta.Experimenter.omeName (java.lang.String)
`GroupExperimenterMap`	`getPrimaryGroupExperimenterMap()` Gets the first element of groupExperimenterMap which can be interpreted as the primary or default element in some situations.
`Integer`	`getVersion()` This version number is controlled by the database for optimisitic locking.
`boolean`	`isLoaded()` 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.
`boolean`	`isValid()` calls the class-specific validator for this instance and returns the value from `Validation.isValid()`
`Iterator<ExperimenterAnnotationLink>`	`iterateAnnotationLinks()` should be used rather than accessing the annotationLinks set directly.
`Iterator<GroupExperimenterMap>`	`iterateGroupExperimenterMap()` should be used rather than accessing the groupExperimenterMap set directly.
`ExperimenterAnnotationLink`	`linkAnnotation(Annotation addition)` Adds a ome.model.annotations.ExperimenterAnnotationLink to annotationLinks .
`Iterator<Annotation>`	`linkedAnnotationIterator()` provides an iterator over the parent values of the annotationLinks.
`List<Annotation>`	`linkedAnnotationList()` produces a `List`-copy of the underlying collection.
`Iterator<ExperimenterGroup>`	`linkedExperimenterGroupIterator()` provides an iterator over the child values of the groupExperimenterMap.
`List<ExperimenterGroup>`	`linkedExperimenterGroupList()` produces a `List`-copy of the underlying collection.
`GroupExperimenterMap`	`linkExperimenterGroup(ExperimenterGroup addition)` Adds a ome.model.meta.GroupExperimenterMap to groupExperimenterMap .
`Experimenter`	`newInstance()`
`Experimenter`	`proxy()`
`void`	`putAt(String field, Object value)` stores a value in this instance.
`void`	`removeExperimenterAnnotationLink(ExperimenterAnnotationLink target)` removes a single element from this set and makes the inverse call on ome.model.annotations.ExperimenterAnnotationLink
`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.
`void`	`removeExperimenterAnnotationLinkSet(Collection<ExperimenterAnnotationLink> targets)` use like removeExperimenterAnnotationLink
`void`	`removeGroupExperimenterMap(GroupExperimenterMap target)` removes a single element from this set and makes the inverse call on ome.model.meta.GroupExperimenterMap
`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.
`void`	`removeGroupExperimenterMapSet(Collection<GroupExperimenterMap> targets)` use like removeGroupExperimenterMap
`Object`	`retrieve(String field)` retrieves a value from this instance.
`protected void`	`setAnnotationLinks(Set<ExperimenterAnnotationLink> annotationLinks)` setter for annotationLinks should be avoided.
`protected void`	`setAnnotationLinksCountPerOwner(Map<Long,Long> map)`
`protected void`	`setDetails(Details details)` Use the `Details.copy(ome.model.internal.Details)` or `Details.shallowCopy(ome.model.internal.Details)` methods to set the `Experimenter.Details` instance instead.
`void`	`setEmail(String email)`
`void`	`setFirstName(String firstName)`
`GroupExperimenterMap`	`setGroupExperimenterMap(int index, GroupExperimenterMap element)` Sets the ome.model.meta.GroupExperimenterMap at the given index.
`protected void`	`setGroupExperimenterMap(List<GroupExperimenterMap> groupExperimenterMap)` setter for groupExperimenterMap should be avoided.
`void`	`setId(Long id)` usually unneeded.
`void`	`setInstitution(String institution)`
`void`	`setLastName(String lastName)`
`void`	`setLdap(Boolean ldap)`
`void`	`setMiddleName(String middleName)`
`void`	`setOmeName(String omeName)`
`GroupExperimenterMap`	`setPrimaryGroupExperimenterMap(GroupExperimenterMap element)` Swaps the first element of groupExperimenterMap with the first instance of the given element.
`void`	`setVersion(Integer version)` use with caution.
`int`	`sizeOfAnnotationLinks()` returns the size of annotationLinks.
`int`	`sizeOfGroupExperimenterMap()` returns the size of groupExperimenterMap.
`protected void`	`throwNullCollectionException(String propertyName)`
`String`	`toString()`
`void`	`unlinkAnnotation(Annotation removal)` unlinks all ome.model.annotations.Annotation instances from this instance.
`void`	`unlinkExperimenterGroup(ExperimenterGroup removal)` unlinks all ome.model.meta.ExperimenterGroup instances from this instance.
`void`	`unload()` set the loaded field to false, and set all non-ID fields to null.
`Collection<ExperimenterAnnotationLink>`	`unmodifiableAnnotationLinks()` Returns an unmodifiable collection-view
`Collection<GroupExperimenterMap>`	`unmodifiableGroupExperimenterMap()` Returns an unmodifiable collection-view
`Validation`	`validate()` calls the class-specific validator for this instance and returns the `Validation` object.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - ID
```
public static final String ID
```
    See Also:
    
    Constant Field Values
  - id
```
protected Long id
```
  - VERSION
```
public static final String VERSION
```
    See Also:
    
    Constant Field Values
  - version
```
protected Integer version
```
  - groupExperimenterMap
```
protected List<GroupExperimenterMap> groupExperimenterMap
```
  - omeName
```
protected String omeName
```
  - firstName
```
protected String firstName
```
  - middleName
```
protected String middleName
```
  - lastName
```
protected String lastName
```
  - institution
```
protected String institution
```
  - ldap
```
protected Boolean ldap
```
  - email
```
protected String email
```
  - annotationLinks
```
protected Set<ExperimenterAnnotationLink> annotationLinks
```
  - OWNER_FILTER_ANNOTATIONLINKS
```
public static final String OWNER_FILTER_ANNOTATIONLINKS
```
    See Also:
    
    Constant Field Values
  - GROUP_FILTER_ANNOTATIONLINKS
```
public static final String GROUP_FILTER_ANNOTATIONLINKS
```
    See Also:
    
    Constant Field Values
  - EVENT_FILTER_ANNOTATIONLINKS
```
public static final String EVENT_FILTER_ANNOTATIONLINKS
```
    See Also:
    
    Constant Field Values
  - PERMS_FILTER_ANNOTATIONLINKS
```
public static final String PERMS_FILTER_ANNOTATIONLINKS
```
    See Also:
    
    Constant Field Values
  - details
```
protected Details details
```
  - GROUPEXPERIMENTERMAP
```
public static final String GROUPEXPERIMENTERMAP
```
    See Also:
    
    Constant Field Values
  - OMENAME
```
public static final String OMENAME
```
    See Also:
    
    Constant Field Values
  - FIRSTNAME
```
public static final String FIRSTNAME
```
    See Also:
    
    Constant Field Values
  - MIDDLENAME
```
public static final String MIDDLENAME
```
    See Also:
    
    Constant Field Values
  - LASTNAME
```
public static final String LASTNAME
```
    See Also:
    
    Constant Field Values
  - INSTITUTION
```
public static final String INSTITUTION
```
    See Also:
    
    Constant Field Values
  - LDAP
```
public static final String LDAP
```
    See Also:
    
    Constant Field Values
  - EMAIL
```
public static final String EMAIL
```
    See Also:
    
    Constant Field Values
  - ANNOTATIONLINKSCOUNTPEROWNER
```
public static final String ANNOTATIONLINKSCOUNTPEROWNER
```
    See Also:
    
    Constant Field Values
  - ANNOTATIONLINKS
```
public static final String ANNOTATIONLINKS
```
    See Also:
    
    Constant Field Values
  - DETAILS
```
public static final String DETAILS
```
    See Also:
    
    Constant Field Values
  - FIELDS
```
public static final Set<String> FIELDS
```
  - _dynamicFields
```
protected Map<String,Object> _dynamicFields
```
  - _loaded
```
protected boolean _loaded
```
- Constructor Detail
  - Experimenter
```
public Experimenter()
```
  - Experimenter
```
protected Experimenter(Long id)
```
  - Experimenter
```
public Experimenter(Long id,
                    boolean loaded)
```
    Main constructor.
  - Experimenter
```
public Experimenter(String _omeName,
                    String _firstName,
                    String _lastName,
                    Boolean _ldap)
```
- Method Detail
  - getId
```
@DocumentId
public 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(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 Integer getVersion()
```
    This version number is controlled by the database for optimisitic locking.
    
    Specified by:
    
    getVersion in interface IMutable
  - setVersion
```
public void setVersion(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 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(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 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 Collection<GroupExperimenterMap> unmodifiableGroupExperimenterMap()
```
    Returns an unmodifiable collection-view
  - collectGroupExperimenterMap
```
public <E> 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(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(Collection<GroupExperimenterMap> targets)
```
    use like removeGroupExperimenterMap
  - getGroupExperimenterMap
```
public GroupExperimenterMap getGroupExperimenterMap(int index)
                                             throws IndexOutOfBoundsException
```
    Gets the ome.model.meta.GroupExperimenterMap at the given index.
    
    Throws:
    
    IndexOutOfBoundsException
  - setGroupExperimenterMap
```
public GroupExperimenterMap setGroupExperimenterMap(int index,
                                                    GroupExperimenterMap element)
                                             throws 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:
    
    IndexOutOfBoundsException
    
    See Also:
    
    List.set(int, Object)
  - getPrimaryGroupExperimenterMap
```
public GroupExperimenterMap getPrimaryGroupExperimenterMap()
                                                    throws 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:
    
    IndexOutOfBoundsException
  - setPrimaryGroupExperimenterMap
```
public GroupExperimenterMap setPrimaryGroupExperimenterMap(GroupExperimenterMap element)
                                                    throws 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:
    
    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 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 Set<GroupExperimenterMap> findGroupExperimenterMap(ExperimenterGroup target)
```
    find all ome.model.meta.GroupExperimenterMap which have the argument as their parent.
  - linkedExperimenterGroupList
```
public 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> 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,name="combined_fields")
public String getOmeName()
```
    Simple field ome.model.meta.Experimenter.omeName (java.lang.String)
  - setOmeName
```
public void setOmeName(String omeName)
```
  - getFirstName
```
@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields")
public String getFirstName()
```
    Simple field ome.model.meta.Experimenter.firstName (java.lang.String)
  - setFirstName
```
public void setFirstName(String firstName)
```
  - getMiddleName
```
@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields")
public String getMiddleName()
```
    Simple field ome.model.meta.Experimenter.middleName (java.lang.String)
  - setMiddleName
```
public void setMiddleName(String middleName)
```
  - getLastName
```
@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields")
public String getLastName()
```
    Simple field ome.model.meta.Experimenter.lastName (java.lang.String)
  - setLastName
```
public void setLastName(String lastName)
```
  - getInstitution
```
@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields")
public String getInstitution()
```
    Simple field ome.model.meta.Experimenter.institution (java.lang.String)
  - setInstitution
```
public void setInstitution(String institution)
```
  - getLdap
```
public Boolean getLdap()
```
    Simple field ome.model.meta.Experimenter.ldap (java.lang.Boolean)
  - setLdap
```
public void setLdap(Boolean ldap)
```
  - getEmail
```
@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields")
public String getEmail()
```
    Simple field ome.model.meta.Experimenter.email (java.lang.String)
  - setEmail
```
public void setEmail(String email)
```
  - getAnnotationLinks
```
protected 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(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
  - iterateAnnotationLinks
```
public Iterator<ExperimenterAnnotationLink> iterateAnnotationLinks()
```
    should be used rather than accessing the annotationLinks set directly. This method will never return null, but rather will return an instance of EmptyIterator. To test for a null collection, see of sizeOfAnnotationLinks() is less than zero.
    
    Specified by:
    
    iterateAnnotationLinks in interface IAnnotated
  - unmodifiableAnnotationLinks
```
public Collection<ExperimenterAnnotationLink> unmodifiableAnnotationLinks()
```
    Returns an unmodifiable collection-view
    
    Specified by:
    
    unmodifiableAnnotationLinks in interface IAnnotated
  - collectAnnotationLinks
```
public <E> 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(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(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 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 Set<ExperimenterAnnotationLink> findExperimenterAnnotationLink(Annotation target)
```
    find all ome.model.annotations.ExperimenterAnnotationLink which have the argument as their child.
  - linkedAnnotationList
```
public 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> 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.
  - clearAnnotationLinks
```
public void clearAnnotationLinks()
```
    clears the set.
    
    Specified by:
    
    clearAnnotationLinks in interface IAnnotated
  - setAnnotationLinksCountPerOwner
```
protected void setAnnotationLinksCountPerOwner(Map<Long,Long> map)
```
  - getAnnotationLinksCountPerOwner
```
public Map<Long,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 subclasse of the Details type.
    
    Specified by:
    
    getDetails in interface IObject
  - setDetails
```
protected void setDetails(Details details)
```
    Use the Details.copy(ome.model.internal.Details) or Details.shallowCopy(ome.model.internal.Details) methods to set the Experimenter.Details instance instead.
  - 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 Experimenter newInstance()
```
  - proxy
```
public Experimenter proxy()
```
  - acceptFilter
```
public boolean acceptFilter(Filter __filter)
```
    Specified by:
    
    acceptFilter in interface Filterable
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - fields
```
public Set<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 Object retrieve(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(String field,
                  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(String propertyName)
```

Class Experimenter

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ID

id

VERSION

version

groupExperimenterMap

omeName

firstName

middleName

lastName

institution

ldap

email

annotationLinks

OWNER_FILTER_ANNOTATIONLINKS

GROUP_FILTER_ANNOTATIONLINKS

EVENT_FILTER_ANNOTATIONLINKS

PERMS_FILTER_ANNOTATIONLINKS

details

GROUPEXPERIMENTERMAP

OMENAME

FIRSTNAME

MIDDLENAME

LASTNAME

INSTITUTION

LDAP

EMAIL

ANNOTATIONLINKSCOUNTPEROWNER

ANNOTATIONLINKS

DETAILS

FIELDS

_dynamicFields

_loaded

Constructor Detail

Experimenter

Experimenter

Experimenter

Experimenter

Method Detail

getId

setId

getVersion

setVersion

getGroupExperimenterMap

setGroupExperimenterMap

sizeOfGroupExperimenterMap

iterateGroupExperimenterMap

unmodifiableGroupExperimenterMap

collectGroupExperimenterMap

addGroupExperimenterMap

addGroupExperimenterMapSet

removeGroupExperimenterMap

removeGroupExperimenterMapSet

getGroupExperimenterMap

setGroupExperimenterMap

getPrimaryGroupExperimenterMap

setPrimaryGroupExperimenterMap

linkExperimenterGroup

addGroupExperimenterMap

linkedExperimenterGroupIterator

findGroupExperimenterMap

linkedExperimenterGroupList

eachLinkedExperimenterGroup

unlinkExperimenterGroup

removeGroupExperimenterMap

clearExperimenterGroupLinks

getOmeName

setOmeName

getFirstName

setFirstName

getMiddleName

setMiddleName

getLastName

setLastName