@Entity @Indexed(index="FullText") @ClassBridge(name="details", impl=DetailsFieldBridge.class, index=UN_TOKENIZED, store=NO) public class PlateAcquisition extends Object implements Serializable, IObject, IMutable, IAnnotated
Modifier and Type | Class and Description |
---|---|
static class |
PlateAcquisition.Details |
Modifier | Constructor and Description |
---|---|
|
PlateAcquisition() |
protected |
PlateAcquisition(Long id) |
|
PlateAcquisition(Long id,
boolean loaded)
Main constructor.
|
|
PlateAcquisition(Plate _plate) |
Modifier and Type | Method and Description |
---|---|
boolean |
acceptFilter(Filter __filter) |
void |
addPlateAcquisitionAnnotationLink(PlateAcquisitionAnnotationLink target)
use instead of setAnnotationLinks .
|
void |
addPlateAcquisitionAnnotationLink(PlateAcquisitionAnnotationLink link,
boolean bothSides)
Adds a ome.model.annotations.PlateAcquisitionAnnotationLink to annotationLinks, allowing for recursion -- whether
or not addPlateAcquisitionAnnotationLink will be called on the addition if it is loaded
|
void |
addPlateAcquisitionAnnotationLinkSet(Collection<PlateAcquisitionAnnotationLink> targets)
use like addPlateAcquisitionAnnotationLink.
|
void |
addWellSample(WellSample target)
use instead of setWellSample .
|
void |
addWellSampleSet(Collection<WellSample> targets)
use like addWellSample.
|
void |
clearAnnotationLinks()
clears the set.
|
void |
clearWellSample()
clears the set.
|
<E> List<E> |
collectAnnotationLinks(CBlock<E> block)
takes a CBlock and calls the block once for each ome.model.annotations.PlateAcquisitionAnnotationLink while
collecting the results.
|
<E> List<E> |
collectWellSample(CBlock<E> block)
takes a CBlock and calls the block once for each ome.model.screen.WellSample 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.
|
protected void |
errorIfUnloaded() |
Set<String> |
fields()
returns a Set of field names that belong to this class
|
Set<PlateAcquisitionAnnotationLink> |
findPlateAcquisitionAnnotationLink(Annotation target)
find all ome.model.annotations.PlateAcquisitionAnnotationLink which have the argument as their child.
|
protected Set<PlateAcquisitionAnnotationLink> |
getAnnotationLinks()
returns annotationLinks .
|
Map<Long,Long> |
getAnnotationLinksCountPerOwner()
If fetched, returns the count(*) of ome.model.annotations.PlateAcquisitionAnnotationLink that a user has.
|
String |
getDescription()
Simple field ome.model.screen.PlateAcquisition.description (java.lang.String)
|
Details |
getDetails()
The details of this object correspond to low-level system
information.
|
Timestamp |
getEndTime()
Simple field ome.model.screen.PlateAcquisition.endTime (java.sql.Timestamp)
|
GraphHolder |
getGraphHolder()
retrieves the
GraphHolder for this entity. |
Long |
getId()
The DB unique identifier for this object.
|
Integer |
getMaximumFieldCount()
Simple field ome.model.screen.PlateAcquisition.maximumFieldCount (java.lang.Integer)
|
String |
getName()
Simple field ome.model.screen.PlateAcquisition.name (java.lang.String)
|
Plate |
getPlate()
Many-to-one field ome.model.screen.PlateAcquisition.plate (ome.model.screen.Plate)
|
Timestamp |
getStartTime()
Simple field ome.model.screen.PlateAcquisition.startTime (java.sql.Timestamp)
|
Integer |
getVersion()
This version number is controlled by the database for optimisitic
locking.
|
protected Set<WellSample> |
getWellSample()
returns wellSample .
|
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<PlateAcquisitionAnnotationLink> |
iterateAnnotationLinks()
should be used rather than accessing the annotationLinks set directly.
|
Iterator<WellSample> |
iterateWellSample()
should be used rather than accessing the wellSample set directly.
|
PlateAcquisitionAnnotationLink |
linkAnnotation(Annotation addition)
Adds a ome.model.annotations.PlateAcquisitionAnnotationLink 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. |
PlateAcquisition |
newInstance() |
PlateAcquisition |
proxy() |
void |
putAt(String field,
Object value)
stores a value in this instance.
|
void |
removePlateAcquisitionAnnotationLink(PlateAcquisitionAnnotationLink target)
removes a single element from this set and makes the inverse call on ome.model.annotations.PlateAcquisitionAnnotationLink
|
void |
removePlateAcquisitionAnnotationLink(PlateAcquisitionAnnotationLink link,
boolean bothSides)
removes the given PlateAcquisitionAnnotationLink from annotationLinks, allowing for recursion -- whether
or not the removal will call unlinkPlateAcquisition again if loaded.
|
void |
removePlateAcquisitionAnnotationLinkSet(Collection<PlateAcquisitionAnnotationLink> targets)
use like removePlateAcquisitionAnnotationLink
|
void |
removeWellSample(WellSample target)
removes a single element from this set and makes the inverse call on ome.model.screen.WellSample
|
void |
removeWellSampleSet(Collection<WellSample> targets)
use like removeWellSample
|
Object |
retrieve(String field)
retrieves a value from this instance.
|
protected void |
setAnnotationLinks(Set<PlateAcquisitionAnnotationLink> annotationLinks)
setter for annotationLinks should be avoided.
|
protected void |
setAnnotationLinksCountPerOwner(Map<Long,Long> map) |
void |
setDescription(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 PlateAcquisition.Details instance instead. |
void |
setEndTime(Timestamp endTime) |
void |
setId(Long id)
usually unneeded.
|
void |
setMaximumFieldCount(Integer maximumFieldCount) |
void |
setName(String name) |
void |
setPlate(Plate plate) |
void |
setStartTime(Timestamp startTime) |
void |
setVersion(Integer version)
use with caution.
|
protected void |
setWellSample(Set<WellSample> wellSample)
setter for wellSample should be avoided.
|
int |
sizeOfAnnotationLinks()
returns the size of annotationLinks.
|
int |
sizeOfWellSample()
returns the size of wellSample.
|
protected void |
throwNullCollectionException(String propertyName) |
String |
toString() |
void |
unlinkAnnotation(Annotation removal)
unlinks all ome.model.annotations.Annotation instances from this instance.
|
void |
unload()
set the loaded field to false, and set all non-ID fields to null.
|
Collection<PlateAcquisitionAnnotationLink> |
unmodifiableAnnotationLinks()
Returns an unmodifiable collection-view
|
Collection<WellSample> |
unmodifiableWellSample()
Returns an unmodifiable collection-view
|
Validation |
validate()
calls the class-specific validator for this instance and returns the
Validation object. |
public static final String OWNER_FILTER
public static final String GROUP_FILTER
public static final String EVENT_FILTER
public static final String PERMS_FILTER
public static final String ID
protected Long id
public static final String VERSION
protected Integer version
protected String name
protected Timestamp startTime
protected Timestamp endTime
protected Integer maximumFieldCount
protected Plate plate
protected Set<WellSample> wellSample
public static final String OWNER_FILTER_WELLSAMPLE
public static final String GROUP_FILTER_WELLSAMPLE
public static final String EVENT_FILTER_WELLSAMPLE
public static final String PERMS_FILTER_WELLSAMPLE
protected Set<PlateAcquisitionAnnotationLink> 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 String description
protected Details details
public static final String NAME
public static final String STARTTIME
public static final String ENDTIME
public static final String MAXIMUMFIELDCOUNT
public static final String PLATE
public static final String WELLSAMPLE
public static final String ANNOTATIONLINKSCOUNTPEROWNER
public static final String ANNOTATIONLINKS
public static final String DESCRIPTION
public static final String DETAILS
protected boolean _loaded
public PlateAcquisition()
protected PlateAcquisition(Long id)
public PlateAcquisition(Long id, boolean loaded)
public PlateAcquisition(Plate _plate)
@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.@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields") public String getName()
public void setName(String name)
@DateBridge(resolution=MINUTE) @Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields") public Timestamp getStartTime()
public void setStartTime(Timestamp startTime)
@DateBridge(resolution=MINUTE) @Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields") public Timestamp getEndTime()
public void setEndTime(Timestamp endTime)
@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields") public Integer getMaximumFieldCount()
public void setMaximumFieldCount(Integer maximumFieldCount)
public Plate getPlate()
public void setPlate(Plate plate)
protected Set<WellSample> getWellSample()
protected void setWellSample(Set<WellSample> wellSample)
public int sizeOfWellSample()
public Iterator<WellSample> iterateWellSample()
EmptyIterator
. To test for a null collection,
see of sizeOfWellSample()
is less than zero.public Collection<WellSample> unmodifiableWellSample()
public <E> List<E> collectWellSample(CBlock<E> block)
block == null
, then the
iterator values themselves are collected. This method uses
iterateWellSample()
internally and so will return a value
even if the underlying collection is null.public void addWellSample(WellSample target)
public void addWellSampleSet(Collection<WellSample> targets)
public void removeWellSample(WellSample target)
public void removeWellSampleSet(Collection<WellSample> targets)
public void clearWellSample()
protected Set<PlateAcquisitionAnnotationLink> getAnnotationLinks()
protected void setAnnotationLinks(Set<PlateAcquisitionAnnotationLink> annotationLinks)
public int sizeOfAnnotationLinks()
sizeOfAnnotationLinks
in interface IAnnotated
public Iterator<PlateAcquisitionAnnotationLink> iterateAnnotationLinks()
EmptyIterator
. To test for a null collection,
see of sizeOfAnnotationLinks()
is less than zero.iterateAnnotationLinks
in interface IAnnotated
public Collection<PlateAcquisitionAnnotationLink> 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 addPlateAcquisitionAnnotationLink(PlateAcquisitionAnnotationLink target)
public void addPlateAcquisitionAnnotationLinkSet(Collection<PlateAcquisitionAnnotationLink> targets)
public void removePlateAcquisitionAnnotationLink(PlateAcquisitionAnnotationLink target)
public void removePlateAcquisitionAnnotationLinkSet(Collection<PlateAcquisitionAnnotationLink> targets)
public PlateAcquisitionAnnotationLink linkAnnotation(Annotation addition)
linkAnnotation
in interface IAnnotated
public void addPlateAcquisitionAnnotationLink(PlateAcquisitionAnnotationLink link, boolean bothSides)
public Iterator<Annotation> linkedAnnotationIterator()
ConcurrentModificationException
.
Use linkedAnnotationList()
instead.linkedAnnotationIterator
in interface IAnnotated
public Set<PlateAcquisitionAnnotationLink> findPlateAcquisitionAnnotationLink(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 removePlateAcquisitionAnnotationLink(PlateAcquisitionAnnotationLink link, boolean bothSides)
public void clearAnnotationLinks()
clearAnnotationLinks
in interface IAnnotated
public Map<Long,Long> getAnnotationLinksCountPerOwner()
@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields") public String getDescription()
public void setDescription(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 PlateAcquisition.Details
instance instead.public boolean isValid()
IObject
Validation.isValid()
public Validation validate()
IObject
Validation
object.public PlateAcquisition newInstance()
public PlateAcquisition 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.5-ice35-b73
Copyright © 2017 The University of Dundee & Open Microscopy Environment. All Rights Reserved.