@Entity @Indexed(index="FullText") @ClassBridge(name="details", impl=DetailsFieldBridge.class, index=UN_TOKENIZED, store=NO) public class Detector extends Object implements Serializable, IObject, IMutable, IAnnotated
Modifier and Type | Class and Description |
---|---|
static class |
Detector.Details |
Modifier | Constructor and Description |
---|---|
|
Detector() |
|
Detector(DetectorType _type,
Instrument _instrument) |
protected |
Detector(Long id) |
|
Detector(Long id,
boolean loaded)
Main constructor.
|
Modifier and Type | Method and Description |
---|---|
boolean |
acceptFilter(Filter __filter) |
void |
addDetectorAnnotationLink(DetectorAnnotationLink target)
use instead of setAnnotationLinks .
|
void |
addDetectorAnnotationLink(DetectorAnnotationLink link,
boolean bothSides)
Adds a ome.model.annotations.DetectorAnnotationLink to annotationLinks, allowing for recursion -- whether
or not addDetectorAnnotationLink will be called on the addition if it is loaded
|
void |
addDetectorAnnotationLinkSet(Collection<DetectorAnnotationLink> targets)
use like addDetectorAnnotationLink.
|
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.DetectorAnnotationLink 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<DetectorAnnotationLink> |
findDetectorAnnotationLink(Annotation target)
find all ome.model.annotations.DetectorAnnotationLink which have the argument as their child.
|
Double |
getAmplificationGain()
Simple field ome.model.acquisition.Detector.amplificationGain (java.lang.Double)
|
protected Set<DetectorAnnotationLink> |
getAnnotationLinks()
returns annotationLinks .
|
Map<Long,Long> |
getAnnotationLinksCountPerOwner()
If fetched, returns the count(*) of ome.model.annotations.DetectorAnnotationLink that a user has.
|
Details |
getDetails()
The details of this object correspond to low-level system
information.
|
Double |
getGain()
Simple field ome.model.acquisition.Detector.gain (java.lang.Double)
|
GraphHolder |
getGraphHolder()
retrieves the
GraphHolder for this entity. |
Long |
getId()
The DB unique identifier for this object.
|
Instrument |
getInstrument()
Many-to-one field ome.model.acquisition.Detector.instrument (ome.model.acquisition.Instrument)
|
String |
getLotNumber()
Simple field ome.model.acquisition.Detector.lotNumber (java.lang.String)
|
String |
getManufacturer()
Simple field ome.model.acquisition.Detector.manufacturer (java.lang.String)
|
String |
getModel()
Simple field ome.model.acquisition.Detector.model (java.lang.String)
|
Double |
getOffsetValue()
Simple field ome.model.acquisition.Detector.offsetValue (java.lang.Double)
|
String |
getSerialNumber()
Simple field ome.model.acquisition.Detector.serialNumber (java.lang.String)
|
DetectorType |
getType()
Many-to-one field ome.model.acquisition.Detector.type (ome.model.enums.DetectorType)
|
Integer |
getVersion()
This version number is controlled by the database for optimisitic
locking.
|
ElectricPotential |
getVoltage()
Enum-mapped unit-based field ome.model.acquisition.Detector.voltage (ome.model.units.ElectricPotential)
|
Double |
getZoom()
Simple field ome.model.acquisition.Detector.zoom (java.lang.Double)
|
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<DetectorAnnotationLink> |
iterateAnnotationLinks()
should be used rather than accessing the annotationLinks set directly.
|
DetectorAnnotationLink |
linkAnnotation(Annotation addition)
Adds a ome.model.annotations.DetectorAnnotationLink 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. |
Detector |
newInstance() |
Detector |
proxy() |
void |
putAt(String field,
Object value)
stores a value in this instance.
|
void |
removeDetectorAnnotationLink(DetectorAnnotationLink target)
removes a single element from this set and makes the inverse call on ome.model.annotations.DetectorAnnotationLink
|
void |
removeDetectorAnnotationLink(DetectorAnnotationLink link,
boolean bothSides)
removes the given DetectorAnnotationLink from annotationLinks, allowing for recursion -- whether
or not the removal will call unlinkDetector again if loaded.
|
void |
removeDetectorAnnotationLinkSet(Collection<DetectorAnnotationLink> targets)
use like removeDetectorAnnotationLink
|
Object |
retrieve(String field)
retrieves a value from this instance.
|
void |
setAmplificationGain(Double amplificationGain) |
protected void |
setAnnotationLinks(Set<DetectorAnnotationLink> 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 Detector.Details instance instead. |
void |
setGain(Double gain) |
void |
setId(Long id)
usually unneeded.
|
void |
setInstrument(Instrument instrument) |
void |
setLotNumber(String lotNumber) |
void |
setManufacturer(String manufacturer) |
void |
setModel(String model) |
void |
setOffsetValue(Double offsetValue) |
void |
setSerialNumber(String serialNumber) |
void |
setType(DetectorType type) |
void |
setVersion(Integer version)
use with caution.
|
void |
setVoltage(ElectricPotential voltage) |
void |
setZoom(Double zoom) |
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<DetectorAnnotationLink> |
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 String manufacturer
protected String model
protected String lotNumber
protected String serialNumber
protected ElectricPotential voltage
protected Double gain
protected Double offsetValue
protected Double zoom
protected Double amplificationGain
protected DetectorType type
protected Instrument instrument
protected Set<DetectorAnnotationLink> 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 MANUFACTURER
public static final String MODEL
public static final String LOTNUMBER
public static final String SERIALNUMBER
public static final String VOLTAGE
public static final String GAIN
public static final String OFFSETVALUE
public static final String ZOOM
public static final String AMPLIFICATIONGAIN
public static final String TYPE
public static final String INSTRUMENT
public static final String ANNOTATIONLINKSCOUNTPEROWNER
public static final String ANNOTATIONLINKS
public static final String DETAILS
protected boolean _loaded
public Detector()
protected Detector(Long id)
public Detector(Long id, boolean loaded)
public Detector(DetectorType _type, Instrument _instrument)
@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 getManufacturer()
public void setManufacturer(String manufacturer)
@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields") public String getModel()
public void setModel(String model)
@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields") public String getLotNumber()
public void setLotNumber(String lotNumber)
@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields") public String getSerialNumber()
public void setSerialNumber(String serialNumber)
public ElectricPotential getVoltage()
public void setVoltage(ElectricPotential voltage)
@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields") public Double getGain()
public void setGain(Double gain)
@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields") public Double getOffsetValue()
public void setOffsetValue(Double offsetValue)
@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields") public Double getZoom()
public void setZoom(Double zoom)
@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields") public Double getAmplificationGain()
public void setAmplificationGain(Double amplificationGain)
public DetectorType getType()
public void setType(DetectorType type)
public Instrument getInstrument()
public void setInstrument(Instrument instrument)
protected Set<DetectorAnnotationLink> getAnnotationLinks()
protected void setAnnotationLinks(Set<DetectorAnnotationLink> annotationLinks)
public int sizeOfAnnotationLinks()
sizeOfAnnotationLinks
in interface IAnnotated
public Iterator<DetectorAnnotationLink> iterateAnnotationLinks()
EmptyIterator
. To test for a null collection,
see of sizeOfAnnotationLinks()
is less than zero.iterateAnnotationLinks
in interface IAnnotated
public Collection<DetectorAnnotationLink> 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 addDetectorAnnotationLink(DetectorAnnotationLink target)
public void addDetectorAnnotationLinkSet(Collection<DetectorAnnotationLink> targets)
public void removeDetectorAnnotationLink(DetectorAnnotationLink target)
public void removeDetectorAnnotationLinkSet(Collection<DetectorAnnotationLink> targets)
public DetectorAnnotationLink linkAnnotation(Annotation addition)
linkAnnotation
in interface IAnnotated
public void addDetectorAnnotationLink(DetectorAnnotationLink link, boolean bothSides)
public Iterator<Annotation> linkedAnnotationIterator()
ConcurrentModificationException
.
Use linkedAnnotationList()
instead.linkedAnnotationIterator
in interface IAnnotated
public Set<DetectorAnnotationLink> findDetectorAnnotationLink(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 removeDetectorAnnotationLink(DetectorAnnotationLink 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 Detector.Details
instance instead.public boolean isValid()
IObject
Validation.isValid()
public Validation validate()
IObject
Validation
object.public Detector newInstance()
public Detector 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.