@Entity @Indexed(index="FullText") @ClassBridge(name="details", impl=DetailsFieldBridge.class, index=UN_TOKENIZED, store=NO) public class PlaneInfo extends Object implements Serializable, IObject, IMutable, IAnnotated
Modifier and Type | Class and Description |
---|---|
static class |
PlaneInfo.Details |
Modifier | Constructor and Description |
---|---|
|
PlaneInfo() |
protected |
PlaneInfo(Long id) |
|
PlaneInfo(Long id,
boolean loaded)
Main constructor.
|
|
PlaneInfo(Pixels _pixels,
Integer _theZ,
Integer _theC,
Integer _theT) |
Modifier and Type | Method and Description |
---|---|
boolean |
acceptFilter(Filter __filter) |
void |
addPlaneInfoAnnotationLink(PlaneInfoAnnotationLink target)
use instead of setAnnotationLinks .
|
void |
addPlaneInfoAnnotationLink(PlaneInfoAnnotationLink link,
boolean bothSides)
Adds a ome.model.annotations.PlaneInfoAnnotationLink to annotationLinks, allowing for recursion -- whether
or not addPlaneInfoAnnotationLink will be called on the addition if it is loaded
|
void |
addPlaneInfoAnnotationLinkSet(Collection<PlaneInfoAnnotationLink> targets)
use like addPlaneInfoAnnotationLink.
|
void |
clearAnnotationLinks()
clears the set.
|
<E> List<E> |
collectAnnotationLinks(CBlock<E> block)
takes a CBlock and calls the block once for each ome.model.annotations.PlaneInfoAnnotationLink 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<PlaneInfoAnnotationLink> |
findPlaneInfoAnnotationLink(Annotation target)
find all ome.model.annotations.PlaneInfoAnnotationLink which have the argument as their child.
|
protected Set<PlaneInfoAnnotationLink> |
getAnnotationLinks()
returns annotationLinks .
|
Map<Long,Long> |
getAnnotationLinksCountPerOwner()
If fetched, returns the count(*) of ome.model.annotations.PlaneInfoAnnotationLink that a user has.
|
Time |
getDeltaT()
Enum-mapped unit-based field ome.model.core.PlaneInfo.deltaT (ome.model.units.Time)
|
Details |
getDetails()
The details of this object correspond to low-level system
information.
|
Time |
getExposureTime()
Enum-mapped unit-based field ome.model.core.PlaneInfo.exposureTime (ome.model.units.Time)
|
GraphHolder |
getGraphHolder()
retrieves the
GraphHolder for this entity. |
Long |
getId()
The DB unique identifier for this object.
|
Pixels |
getPixels()
Many-to-one field ome.model.core.PlaneInfo.pixels (ome.model.core.Pixels)
|
Length |
getPositionX()
Enum-mapped unit-based field ome.model.core.PlaneInfo.positionX (ome.model.units.Length)
|
Length |
getPositionY()
Enum-mapped unit-based field ome.model.core.PlaneInfo.positionY (ome.model.units.Length)
|
Length |
getPositionZ()
Enum-mapped unit-based field ome.model.core.PlaneInfo.positionZ (ome.model.units.Length)
|
Integer |
getTheC()
Simple field ome.model.core.PlaneInfo.theC (java.lang.Integer)
|
Integer |
getTheT()
Simple field ome.model.core.PlaneInfo.theT (java.lang.Integer)
|
Integer |
getTheZ()
Simple field ome.model.core.PlaneInfo.theZ (java.lang.Integer)
|
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<PlaneInfoAnnotationLink> |
iterateAnnotationLinks()
should be used rather than accessing the annotationLinks set directly.
|
PlaneInfoAnnotationLink |
linkAnnotation(Annotation addition)
Adds a ome.model.annotations.PlaneInfoAnnotationLink 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. |
PlaneInfo |
newInstance() |
PlaneInfo |
proxy() |
void |
putAt(String field,
Object value)
stores a value in this instance.
|
void |
removePlaneInfoAnnotationLink(PlaneInfoAnnotationLink target)
removes a single element from this set and makes the inverse call on ome.model.annotations.PlaneInfoAnnotationLink
|
void |
removePlaneInfoAnnotationLink(PlaneInfoAnnotationLink link,
boolean bothSides)
removes the given PlaneInfoAnnotationLink from annotationLinks, allowing for recursion -- whether
or not the removal will call unlinkPlaneInfo again if loaded.
|
void |
removePlaneInfoAnnotationLinkSet(Collection<PlaneInfoAnnotationLink> targets)
use like removePlaneInfoAnnotationLink
|
Object |
retrieve(String field)
retrieves a value from this instance.
|
protected void |
setAnnotationLinks(Set<PlaneInfoAnnotationLink> annotationLinks)
setter for annotationLinks should be avoided.
|
protected void |
setAnnotationLinksCountPerOwner(Map<Long,Long> map) |
void |
setDeltaT(Time deltaT) |
protected void |
setDetails(Details details)
Use the
Details.copy(ome.model.internal.Details)
or Details.shallowCopy(ome.model.internal.Details)
methods to set the PlaneInfo.Details instance instead. |
void |
setExposureTime(Time exposureTime) |
void |
setId(Long id)
usually unneeded.
|
void |
setPixels(Pixels pixels) |
void |
setPositionX(Length positionX) |
void |
setPositionY(Length positionY) |
void |
setPositionZ(Length positionZ) |
void |
setTheC(Integer theC) |
void |
setTheT(Integer theT) |
void |
setTheZ(Integer theZ) |
void |
setVersion(Integer version)
use with caution.
|
int |
sizeOfAnnotationLinks()
returns the size of annotationLinks.
|
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<PlaneInfoAnnotationLink> |
unmodifiableAnnotationLinks()
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 Pixels pixels
protected Integer theZ
protected Integer theC
protected Integer theT
protected Time deltaT
protected Length positionX
protected Length positionY
protected Length positionZ
protected Time exposureTime
protected Set<PlaneInfoAnnotationLink> 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 PIXELS
public static final String THEZ
public static final String THEC
public static final String THET
public static final String DELTAT
public static final String POSITIONX
public static final String POSITIONY
public static final String POSITIONZ
public static final String EXPOSURETIME
public static final String ANNOTATIONLINKSCOUNTPEROWNER
public static final String ANNOTATIONLINKS
public static final String DETAILS
protected boolean _loaded
public PlaneInfo()
protected PlaneInfo(Long id)
public PlaneInfo(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.public Pixels getPixels()
public void setPixels(Pixels pixels)
@Fields(value={@Field(index=UN_TOKENIZED),@Field(index=UN_TOKENIZED,name="combined_fields")}) public Integer getTheZ()
public void setTheZ(Integer theZ)
@Fields(value={@Field(index=UN_TOKENIZED),@Field(index=UN_TOKENIZED,name="combined_fields")}) public Integer getTheC()
public void setTheC(Integer theC)
@Fields(value={@Field(index=UN_TOKENIZED),@Field(index=UN_TOKENIZED,name="combined_fields")}) public Integer getTheT()
public void setTheT(Integer theT)
public Time getDeltaT()
public void setDeltaT(Time deltaT)
public Length getPositionX()
public void setPositionX(Length positionX)
public Length getPositionY()
public void setPositionY(Length positionY)
public Length getPositionZ()
public void setPositionZ(Length positionZ)
public Time getExposureTime()
public void setExposureTime(Time exposureTime)
protected Set<PlaneInfoAnnotationLink> getAnnotationLinks()
protected void setAnnotationLinks(Set<PlaneInfoAnnotationLink> annotationLinks)
public int sizeOfAnnotationLinks()
sizeOfAnnotationLinks
in interface IAnnotated
public Iterator<PlaneInfoAnnotationLink> iterateAnnotationLinks()
EmptyIterator
. To test for a null collection,
see of sizeOfAnnotationLinks()
is less than zero.iterateAnnotationLinks
in interface IAnnotated
public Collection<PlaneInfoAnnotationLink> 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 addPlaneInfoAnnotationLink(PlaneInfoAnnotationLink target)
public void addPlaneInfoAnnotationLinkSet(Collection<PlaneInfoAnnotationLink> targets)
public void removePlaneInfoAnnotationLink(PlaneInfoAnnotationLink target)
public void removePlaneInfoAnnotationLinkSet(Collection<PlaneInfoAnnotationLink> targets)
public PlaneInfoAnnotationLink linkAnnotation(Annotation addition)
linkAnnotation
in interface IAnnotated
public void addPlaneInfoAnnotationLink(PlaneInfoAnnotationLink link, boolean bothSides)
public Iterator<Annotation> linkedAnnotationIterator()
ConcurrentModificationException
.
Use linkedAnnotationList()
instead.linkedAnnotationIterator
in interface IAnnotated
public Set<PlaneInfoAnnotationLink> findPlaneInfoAnnotationLink(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 removePlaneInfoAnnotationLink(PlaneInfoAnnotationLink 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 PlaneInfo.Details
instance instead.public boolean isValid()
IObject
Validation.isValid()
public Validation validate()
IObject
Validation
object.public PlaneInfo newInstance()
public PlaneInfo 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.1.4-ice35-b55
Copyright © 2015 The University of Dundee & Open Microscopy Environment. All Rights Reserved.