@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
Modifier and Type | Class and Description |
---|---|
static class |
Experimenter.Details |
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) |
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.
|
List<NamedValue> |
getConfig() |
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) |
void |
setConfig(List<NamedValue> 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. |
public static final String ID
protected Long id
public static final String VERSION
protected Integer version
protected List<GroupExperimenterMap> groupExperimenterMap
protected String omeName
protected String firstName
protected String middleName
protected String lastName
protected String institution
protected Boolean ldap
protected String email
protected List<NamedValue> config
protected Set<ExperimenterAnnotationLink> annotationLinks
public static final String OWNER_FILTER_ANNOTATIONLINKS
public static final String GROUP_FILTER_ANNOTATIONLINKS
public static final String EVENT_FILTER_ANNOTATIONLINKS
public static final String PERMS_FILTER_ANNOTATIONLINKS
protected Details details
public static final String GROUPEXPERIMENTERMAP
public static final String OMENAME
public static final String FIRSTNAME
public static final String MIDDLENAME
public static final String LASTNAME
public static final String INSTITUTION
public static final String LDAP
public static final String EMAIL
public static final String CONFIG
public static final String ANNOTATIONLINKSCOUNTPEROWNER
public static final String ANNOTATIONLINKS
public static final String DETAILS
protected boolean _loaded
public Experimenter()
protected Experimenter(Long id)
public Experimenter(Long id, boolean loaded)
@DocumentId public Long getId()
public void setId(Long id)
IObject
public Integer getVersion()
getVersion
in interface IMutable
public void setVersion(Integer version)
IMutable
setVersion
in interface IMutable
version
- Value for this objects version.protected List<GroupExperimenterMap> getGroupExperimenterMap()
protected void setGroupExperimenterMap(List<GroupExperimenterMap> groupExperimenterMap)
public int sizeOfGroupExperimenterMap()
public Iterator<GroupExperimenterMap> iterateGroupExperimenterMap()
EmptyIterator
. To test for a null collection,
see of sizeOfGroupExperimenterMap()
is less than zero.public Collection<GroupExperimenterMap> unmodifiableGroupExperimenterMap()
public <E> List<E> collectGroupExperimenterMap(CBlock<E> block)
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.public void addGroupExperimenterMap(GroupExperimenterMap target)
public void addGroupExperimenterMapSet(Collection<GroupExperimenterMap> targets)
public void removeGroupExperimenterMap(GroupExperimenterMap target)
public void removeGroupExperimenterMapSet(Collection<GroupExperimenterMap> targets)
public GroupExperimenterMap getGroupExperimenterMap(int index) throws IndexOutOfBoundsException
IndexOutOfBoundsException
public GroupExperimenterMap setGroupExperimenterMap(int index, GroupExperimenterMap element) throws IndexOutOfBoundsException
List.set(int, Object)
contract. To extend the list, use addGroupExperimenterMap(GroupExperimenterMap)
.IndexOutOfBoundsException
List.set(int, Object)
public GroupExperimenterMap getPrimaryGroupExperimenterMap() throws IndexOutOfBoundsException
IndexOutOfBoundsException
is throws. This method
will also throw an ApiUsageException
if the collection is
unloaded. See sizeOfGroupExperimenterMap()
for more information.IndexOutOfBoundsException
public GroupExperimenterMap setPrimaryGroupExperimenterMap(GroupExperimenterMap element) throws IndexOutOfBoundsException
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.IndexOutOfBoundsException
public GroupExperimenterMap linkExperimenterGroup(ExperimenterGroup addition)
public void addGroupExperimenterMap(GroupExperimenterMap link, boolean bothSides)
public Iterator<ExperimenterGroup> linkedExperimenterGroupIterator()
ConcurrentModificationException
.
Use linkedExperimenterGroupList()
instead.public Set<GroupExperimenterMap> findGroupExperimenterMap(ExperimenterGroup target)
public List<ExperimenterGroup> linkedExperimenterGroupList()
List
-copy of the underlying collection. Unlike,
linkedExperimenterGroupIterator()
, while using the returned List
,
modifications can be made to the underlying collection without throwing
ConcurrentModificationException
.public <E> List<E> eachLinkedExperimenterGroup(CBlock<E> block)
block == null
, then the
iterator values themselves are collected.public void unlinkExperimenterGroup(ExperimenterGroup removal)
public void removeGroupExperimenterMap(GroupExperimenterMap link, boolean bothSides)
public void clearExperimenterGroupLinks()
@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields") public String getOmeName()
public void setOmeName(String omeName)
@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields") public String getFirstName()
public void setFirstName(String firstName)
@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields") public String getMiddleName()
public void setMiddleName(String middleName)
@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields") public String getLastName()
public void setLastName(String lastName)
@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields") public String getInstitution()
public void setInstitution(String institution)
public Boolean getLdap()
public void setLdap(Boolean ldap)
@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields") public String getEmail()
public void setEmail(String email)
public void setConfig(List<NamedValue> map)
public List<NamedValue> getConfig()
protected Set<ExperimenterAnnotationLink> getAnnotationLinks()
protected void setAnnotationLinks(Set<ExperimenterAnnotationLink> annotationLinks)
public int sizeOfAnnotationLinks()
sizeOfAnnotationLinks
in interface IAnnotated
public Iterator<ExperimenterAnnotationLink> iterateAnnotationLinks()
EmptyIterator
. To test for a null collection,
see of sizeOfAnnotationLinks()
is less than zero.iterateAnnotationLinks
in interface IAnnotated
public Collection<ExperimenterAnnotationLink> unmodifiableAnnotationLinks()
unmodifiableAnnotationLinks
in interface IAnnotated
public <E> List<E> collectAnnotationLinks(CBlock<E> block)
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.collectAnnotationLinks
in interface IAnnotated
public void addExperimenterAnnotationLink(ExperimenterAnnotationLink target)
public void addExperimenterAnnotationLinkSet(Collection<ExperimenterAnnotationLink> targets)
public void removeExperimenterAnnotationLink(ExperimenterAnnotationLink target)
public void removeExperimenterAnnotationLinkSet(Collection<ExperimenterAnnotationLink> targets)
public ExperimenterAnnotationLink linkAnnotation(Annotation addition)
linkAnnotation
in interface IAnnotated
public void addExperimenterAnnotationLink(ExperimenterAnnotationLink link, boolean bothSides)
public Iterator<Annotation> linkedAnnotationIterator()
ConcurrentModificationException
.
Use linkedAnnotationList()
instead.linkedAnnotationIterator
in interface IAnnotated
public Set<ExperimenterAnnotationLink> findExperimenterAnnotationLink(Annotation target)
public List<Annotation> linkedAnnotationList()
List
-copy of the underlying collection. Unlike,
linkedAnnotationIterator()
, while using the returned List
,
modifications can be made to the underlying collection without throwing
ConcurrentModificationException
.linkedAnnotationList
in interface IAnnotated
public <E> List<E> eachLinkedAnnotation(CBlock<E> block)
block == null
, then the
iterator values themselves are collected.eachLinkedAnnotation
in interface IAnnotated
public void unlinkAnnotation(Annotation removal)
unlinkAnnotation
in interface IAnnotated
public void removeExperimenterAnnotationLink(ExperimenterAnnotationLink link, boolean bothSides)
public void clearAnnotationLinks()
clearAnnotationLinks
in interface IAnnotated
public Map<Long,Long> getAnnotationLinksCountPerOwner()
public Details getDetails()
Details
type.getDetails
in interface IObject
protected void setDetails(Details details)
Details.copy(ome.model.internal.Details)
or Details.shallowCopy(ome.model.internal.Details)
methods to set the Experimenter.Details
instance instead.public boolean isValid()
IObject
Validation.isValid()
public Validation validate()
IObject
Validation
object.public Experimenter newInstance()
public Experimenter proxy()
public boolean acceptFilter(Filter __filter)
acceptFilter
in interface Filterable
public Set<String> fields()
IObject
public Object retrieve(String field)
IObject
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)
public void putAt(String field, Object value)
IObject
field
which
match a field of this instance will be delegated to the accessors.
Otherwise, values will be stored in a lazy-loaded map.public boolean isLoaded()
IObject
protected void errorIfUnloaded()
public void unload()
IObject
public final GraphHolder getGraphHolder()
IObject
GraphHolder
for this entity. If the GraphHolder has
not been actively set, a new one will be instatiated.getGraphHolder
in interface IObject
protected void throwNullCollectionException(String propertyName)
Version: 5.3.3-ice35-b63
Copyright © 2017 The University of Dundee & Open Microscopy Environment. All Rights Reserved.