@Entity @Indexed(index="FullText") @ClassBridge(name="details", impl=DetailsFieldBridge.class, index=UN_TOKENIZED, store=NO) public class ExperimenterGroup extends java.lang.Object implements java.io.Serializable, IObject, IGlobal, IMutable, IAnnotated
Modifier and Type | Class and Description |
---|---|
static class |
ExperimenterGroup.Details |
Modifier and Type | Field and Description |
---|---|
protected java.util.Map<java.lang.String,java.lang.Object> |
_dynamicFields |
protected boolean |
_loaded |
protected java.util.Set<ExperimenterGroupAnnotationLink> |
annotationLinks |
static java.lang.String |
ANNOTATIONLINKS |
static java.lang.String |
ANNOTATIONLINKSCOUNTPEROWNER |
protected java.util.List<NamedValue> |
config |
static java.lang.String |
CONFIG |
protected java.lang.String |
description |
static java.lang.String |
DESCRIPTION |
protected Details |
details |
static java.lang.String |
DETAILS |
static java.lang.String |
EVENT_FILTER_ANNOTATIONLINKS |
static java.util.Set<java.lang.String> |
FIELDS |
static java.lang.String |
GROUP_FILTER_ANNOTATIONLINKS |
protected java.util.Set<GroupExperimenterMap> |
groupExperimenterMap |
static java.lang.String |
GROUPEXPERIMENTERMAP |
protected java.lang.Long |
id |
static java.lang.String |
ID |
protected java.lang.Boolean |
ldap |
static java.lang.String |
LDAP |
protected java.lang.String |
name |
static java.lang.String |
NAME |
static java.lang.String |
OWNER_FILTER_ANNOTATIONLINKS |
static java.lang.String |
PERMS_FILTER_ANNOTATIONLINKS |
protected java.lang.Integer |
version |
static java.lang.String |
VERSION |
Modifier | Constructor and Description |
---|---|
|
ExperimenterGroup() |
protected |
ExperimenterGroup(java.lang.Long id) |
|
ExperimenterGroup(java.lang.Long id,
boolean loaded)
Main constructor.
|
|
ExperimenterGroup(java.lang.String _name,
java.lang.Boolean _ldap) |
Modifier and Type | Method and Description |
---|---|
boolean |
acceptFilter(Filter __filter) |
void |
addExperimenterGroupAnnotationLink(ExperimenterGroupAnnotationLink target)
use instead of setAnnotationLinks .
|
void |
addExperimenterGroupAnnotationLink(ExperimenterGroupAnnotationLink link,
boolean bothSides)
Adds a ome.model.annotations.ExperimenterGroupAnnotationLink to annotationLinks, allowing for recursion -- whether
or not addExperimenterGroupAnnotationLink will be called on the addition if it is loaded
|
void |
addExperimenterGroupAnnotationLinkSet(java.util.Collection<ExperimenterGroupAnnotationLink> targets)
use like addExperimenterGroupAnnotationLink.
|
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(java.util.Collection<GroupExperimenterMap> targets)
use like addGroupExperimenterMap.
|
void |
clearAnnotationLinks()
clears the set.
|
void |
clearExperimenterLinks()
clears the set.
|
<E> java.util.List<E> |
collectAnnotationLinks(CBlock<E> block)
takes a CBlock and calls the block once for each ome.model.annotations.ExperimenterGroupAnnotationLink while
collecting the results.
|
<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.
|
<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.
|
<E> java.util.List<E> |
eachLinkedExperimenter(CBlock<E> block)
takes a CBlock and calls the block once for each ome.model.meta.Experimenter while
collecting the results.
|
protected void |
errorIfUnloaded() |
java.util.Set<java.lang.String> |
fields()
returns a Set of field names that belong to this class
|
java.util.Set<ExperimenterGroupAnnotationLink> |
findExperimenterGroupAnnotationLink(Annotation target)
find all ome.model.annotations.ExperimenterGroupAnnotationLink which have the argument as their child.
|
java.util.Set<GroupExperimenterMap> |
findGroupExperimenterMap(Experimenter target)
find all ome.model.meta.GroupExperimenterMap which have the argument as their child.
|
protected java.util.Set<ExperimenterGroupAnnotationLink> |
getAnnotationLinks()
returns annotationLinks .
|
java.util.Map<java.lang.Long,java.lang.Long> |
getAnnotationLinksCountPerOwner()
If fetched, returns the count(*) of ome.model.annotations.ExperimenterGroupAnnotationLink that a user has.
|
java.util.List<NamedValue> |
getConfig() |
java.lang.String |
getDescription()
Simple field ome.model.meta.ExperimenterGroup.description (java.lang.String)
|
Details |
getDetails()
The details of this object correspond to low-level system
information.
|
GraphHolder |
getGraphHolder()
retrieves the
GraphHolder for this entity. |
protected java.util.Set<GroupExperimenterMap> |
getGroupExperimenterMap()
returns groupExperimenterMap .
|
java.lang.Long |
getId()
The DB unique identifier for this object.
|
java.lang.Boolean |
getLdap()
Simple field ome.model.meta.ExperimenterGroup.ldap (java.lang.Boolean)
|
java.lang.String |
getName()
Simple field ome.model.meta.ExperimenterGroup.name (java.lang.String)
|
java.lang.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() |
java.util.Iterator<ExperimenterGroupAnnotationLink> |
iterateAnnotationLinks()
should be used rather than accessing the annotationLinks set directly.
|
java.util.Iterator<GroupExperimenterMap> |
iterateGroupExperimenterMap()
should be used rather than accessing the groupExperimenterMap set directly.
|
ExperimenterGroupAnnotationLink |
linkAnnotation(Annotation addition)
Adds a ome.model.annotations.ExperimenterGroupAnnotationLink to annotationLinks .
|
java.util.Iterator<Annotation> |
linkedAnnotationIterator()
provides an iterator over the parent values of the annotationLinks.
|
java.util.List<Annotation> |
linkedAnnotationList()
produces a
List -copy of the underlying collection. |
java.util.Iterator<Experimenter> |
linkedExperimenterIterator()
provides an iterator over the parent values of the groupExperimenterMap.
|
java.util.List<Experimenter> |
linkedExperimenterList()
produces a
List -copy of the underlying collection. |
GroupExperimenterMap |
linkExperimenter(Experimenter addition)
Adds a ome.model.meta.GroupExperimenterMap to groupExperimenterMap .
|
ExperimenterGroup |
newInstance() |
ExperimenterGroup |
proxy() |
void |
putAt(java.lang.String field,
java.lang.Object value)
stores a value in this instance.
|
void |
removeExperimenterGroupAnnotationLink(ExperimenterGroupAnnotationLink target)
removes a single element from this set and makes the inverse call on ome.model.annotations.ExperimenterGroupAnnotationLink
|
void |
removeExperimenterGroupAnnotationLink(ExperimenterGroupAnnotationLink link,
boolean bothSides)
removes the given ExperimenterGroupAnnotationLink from annotationLinks, allowing for recursion -- whether
or not the removal will call unlinkExperimenterGroup again if loaded.
|
void |
removeExperimenterGroupAnnotationLinkSet(java.util.Collection<ExperimenterGroupAnnotationLink> targets)
use like removeExperimenterGroupAnnotationLink
|
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 unlinkExperimenterGroup again if loaded.
|
void |
removeGroupExperimenterMapSet(java.util.Collection<GroupExperimenterMap> targets)
use like removeGroupExperimenterMap
|
java.lang.Object |
retrieve(java.lang.String field)
retrieves a value from this instance.
|
protected void |
setAnnotationLinks(java.util.Set<ExperimenterGroupAnnotationLink> annotationLinks)
setter for annotationLinks should be avoided.
|
protected void |
setAnnotationLinksCountPerOwner(java.util.Map<java.lang.Long,java.lang.Long> map) |
void |
setConfig(java.util.List<NamedValue> map) |
void |
setDescription(java.lang.String description) |
protected void |
setDetails(Details details)
Use the
Details.copy(ome.model.internal.Details)
or Details.shallowCopy(ome.model.internal.Details)
methods to set the ExperimenterGroup.Details instance instead. |
protected void |
setGroupExperimenterMap(java.util.Set<GroupExperimenterMap> groupExperimenterMap)
setter for groupExperimenterMap should be avoided.
|
void |
setId(java.lang.Long id)
usually unneeded.
|
void |
setLdap(java.lang.Boolean ldap) |
void |
setName(java.lang.String name) |
void |
setVersion(java.lang.Integer version)
use with caution.
|
int |
sizeOfAnnotationLinks()
returns the size of annotationLinks.
|
int |
sizeOfGroupExperimenterMap()
returns the size of groupExperimenterMap.
|
protected void |
throwNullCollectionException(java.lang.String propertyName) |
java.lang.String |
toString() |
void |
unlinkAnnotation(Annotation removal)
unlinks all ome.model.annotations.Annotation instances from this instance.
|
void |
unlinkExperimenter(Experimenter removal)
unlinks all ome.model.meta.Experimenter instances from this instance.
|
void |
unload()
set the loaded field to false, and set all non-ID fields to null.
|
java.util.Collection<ExperimenterGroupAnnotationLink> |
unmodifiableAnnotationLinks()
Returns an unmodifiable collection-view
|
java.util.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 java.lang.String ID
protected java.lang.Long id
public static final java.lang.String VERSION
protected java.lang.Integer version
protected java.lang.String name
protected java.lang.Boolean ldap
protected java.util.Set<GroupExperimenterMap> groupExperimenterMap
protected java.util.List<NamedValue> config
protected java.util.Set<ExperimenterGroupAnnotationLink> annotationLinks
public static final java.lang.String OWNER_FILTER_ANNOTATIONLINKS
public static final java.lang.String GROUP_FILTER_ANNOTATIONLINKS
public static final java.lang.String EVENT_FILTER_ANNOTATIONLINKS
public static final java.lang.String PERMS_FILTER_ANNOTATIONLINKS
protected java.lang.String description
protected Details details
public static final java.lang.String NAME
public static final java.lang.String LDAP
public static final java.lang.String GROUPEXPERIMENTERMAP
public static final java.lang.String CONFIG
public static final java.lang.String ANNOTATIONLINKSCOUNTPEROWNER
public static final java.lang.String ANNOTATIONLINKS
public static final java.lang.String DESCRIPTION
public static final java.lang.String DETAILS
public static final java.util.Set<java.lang.String> FIELDS
protected java.util.Map<java.lang.String,java.lang.Object> _dynamicFields
protected boolean _loaded
public ExperimenterGroup()
protected ExperimenterGroup(java.lang.Long id)
public ExperimenterGroup(java.lang.Long id, boolean loaded)
public ExperimenterGroup(java.lang.String _name, java.lang.Boolean _ldap)
@DocumentId public java.lang.Long getId()
public void setId(java.lang.Long id)
IObject
public java.lang.Integer getVersion()
getVersion
in interface IMutable
public void setVersion(java.lang.Integer version)
IMutable
setVersion
in interface IMutable
version
- Value for this objects version.@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields") public java.lang.String getName()
public void setName(java.lang.String name)
public java.lang.Boolean getLdap()
public void setLdap(java.lang.Boolean ldap)
protected java.util.Set<GroupExperimenterMap> getGroupExperimenterMap()
protected void setGroupExperimenterMap(java.util.Set<GroupExperimenterMap> groupExperimenterMap)
public int sizeOfGroupExperimenterMap()
public java.util.Iterator<GroupExperimenterMap> iterateGroupExperimenterMap()
EmptyIterator
. To test for a null collection,
see of sizeOfGroupExperimenterMap()
is less than zero.public java.util.Collection<GroupExperimenterMap> unmodifiableGroupExperimenterMap()
public <E> java.util.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(java.util.Collection<GroupExperimenterMap> targets)
public void removeGroupExperimenterMap(GroupExperimenterMap target)
public void removeGroupExperimenterMapSet(java.util.Collection<GroupExperimenterMap> targets)
public GroupExperimenterMap linkExperimenter(Experimenter addition)
public void addGroupExperimenterMap(GroupExperimenterMap link, boolean bothSides)
public java.util.Iterator<Experimenter> linkedExperimenterIterator()
ConcurrentModificationException
.
Use linkedExperimenterList()
instead.public java.util.Set<GroupExperimenterMap> findGroupExperimenterMap(Experimenter target)
public java.util.List<Experimenter> linkedExperimenterList()
List
-copy of the underlying collection. Unlike,
linkedExperimenterIterator()
, while using the returned List
,
modifications can be made to the underlying collection without throwing
ConcurrentModificationException
.public <E> java.util.List<E> eachLinkedExperimenter(CBlock<E> block)
block == null
, then the
iterator values themselves are collected.public void unlinkExperimenter(Experimenter removal)
public void removeGroupExperimenterMap(GroupExperimenterMap link, boolean bothSides)
public void clearExperimenterLinks()
public void setConfig(java.util.List<NamedValue> map)
public java.util.List<NamedValue> getConfig()
protected java.util.Set<ExperimenterGroupAnnotationLink> getAnnotationLinks()
protected void setAnnotationLinks(java.util.Set<ExperimenterGroupAnnotationLink> annotationLinks)
public int sizeOfAnnotationLinks()
sizeOfAnnotationLinks
in interface IAnnotated
public java.util.Iterator<ExperimenterGroupAnnotationLink> iterateAnnotationLinks()
EmptyIterator
. To test for a null collection,
see of sizeOfAnnotationLinks()
is less than zero.iterateAnnotationLinks
in interface IAnnotated
public java.util.Collection<ExperimenterGroupAnnotationLink> unmodifiableAnnotationLinks()
unmodifiableAnnotationLinks
in interface IAnnotated
public <E> java.util.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 addExperimenterGroupAnnotationLink(ExperimenterGroupAnnotationLink target)
public void addExperimenterGroupAnnotationLinkSet(java.util.Collection<ExperimenterGroupAnnotationLink> targets)
public void removeExperimenterGroupAnnotationLink(ExperimenterGroupAnnotationLink target)
public void removeExperimenterGroupAnnotationLinkSet(java.util.Collection<ExperimenterGroupAnnotationLink> targets)
public ExperimenterGroupAnnotationLink linkAnnotation(Annotation addition)
linkAnnotation
in interface IAnnotated
public void addExperimenterGroupAnnotationLink(ExperimenterGroupAnnotationLink link, boolean bothSides)
public java.util.Iterator<Annotation> linkedAnnotationIterator()
ConcurrentModificationException
.
Use linkedAnnotationList()
instead.linkedAnnotationIterator
in interface IAnnotated
public java.util.Set<ExperimenterGroupAnnotationLink> findExperimenterGroupAnnotationLink(Annotation target)
public java.util.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> java.util.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 removeExperimenterGroupAnnotationLink(ExperimenterGroupAnnotationLink link, boolean bothSides)
public void clearAnnotationLinks()
clearAnnotationLinks
in interface IAnnotated
protected void setAnnotationLinksCountPerOwner(java.util.Map<java.lang.Long,java.lang.Long> map)
public java.util.Map<java.lang.Long,java.lang.Long> getAnnotationLinksCountPerOwner()
@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields") public java.lang.String getDescription()
public void setDescription(java.lang.String description)
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 ExperimenterGroup.Details
instance instead.public boolean isValid()
IObject
Validation.isValid()
public Validation validate()
IObject
Validation
object.public ExperimenterGroup newInstance()
public ExperimenterGroup proxy()
public boolean acceptFilter(Filter __filter)
acceptFilter
in interface Filterable
public java.lang.String toString()
toString
in class java.lang.Object
public java.util.Set<java.lang.String> fields()
IObject
public java.lang.Object retrieve(java.lang.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(java.lang.String field, java.lang.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(java.lang.String propertyName)
Version: 5.4.10-ice35-b105
Copyright © 2019 The University of Dundee & Open Microscopy Environment. All Rights Reserved.