ome.model.acquisition

Class DetectorSettings

java.lang.Object

ome.model.acquisition.DetectorSettings

All Implemented Interfaces:

java.io.Serializable, IMutable, IObject, Filterable

@Entity
 @Indexed(index="FullText")
 @ClassBridge(name="details",
             impl=DetailsFieldBridge.class,
             index=UN_TOKENIZED,
             store=NO)
public class DetectorSettings
extends java.lang.Object
implements java.io.Serializable, IObject, IMutable

These filter definitions are used by the security system to eliminate non-readable objects from queries. The regular user does not need to worry about them, as they will be injected directly into the SQL (not HQL)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DetectorSettings.Details

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.Object>	_dynamicFields
protected boolean	_loaded
protected Binning	binning
static java.lang.String	BINNING
protected Details	details
static java.lang.String	DETAILS
protected Detector	detector
static java.lang.String	DETECTOR
static java.lang.String	EVENT_FILTER
static java.util.Set<java.lang.String>	FIELDS
protected java.lang.Double	gain
static java.lang.String	GAIN
static java.lang.String	GROUP_FILTER
protected java.lang.Long	id
static java.lang.String	ID
protected java.lang.Integer	integration
static java.lang.String	INTEGRATION
protected java.lang.Double	offsetValue
static java.lang.String	OFFSETVALUE
static java.lang.String	OWNER_FILTER
static java.lang.String	PERMS_FILTER
protected Frequency	readOutRate
static java.lang.String	READOUTRATE
protected java.lang.Integer	version
static java.lang.String	VERSION
protected ElectricPotential	voltage
static java.lang.String	VOLTAGE
protected java.lang.Double	zoom
static java.lang.String	ZOOM

Constructor Summary

Constructors

Modifier	Constructor and Description
	DetectorSettings()
	DetectorSettings(Detector _detector)
protected	DetectorSettings(java.lang.Long id)
	DetectorSettings(java.lang.Long id, boolean loaded) Main constructor.

Method Summary

Modifier and Type	Method and Description
boolean	acceptFilter(Filter __filter)
protected void	errorIfUnloaded()
java.util.Set<java.lang.String>	fields() returns a Set of field names that belong to this class
Binning	getBinning() Many-to-one field ome.model.acquisition.DetectorSettings.binning (ome.model.enums.Binning)
Details	getDetails() The details of this object correspond to low-level system information.
Detector	getDetector() Many-to-one field ome.model.acquisition.DetectorSettings.detector (ome.model.acquisition.Detector)
java.lang.Double	getGain() Simple field ome.model.acquisition.DetectorSettings.gain (java.lang.Double)
GraphHolder	getGraphHolder() retrieves the GraphHolder for this entity.
java.lang.Long	getId() The DB unique identifier for this object.
java.lang.Integer	getIntegration() Simple field ome.model.acquisition.DetectorSettings.integration (java.lang.Integer)
java.lang.Double	getOffsetValue() Simple field ome.model.acquisition.DetectorSettings.offsetValue (java.lang.Double)
Frequency	getReadOutRate() Enum-mapped unit-based field ome.model.acquisition.DetectorSettings.readOutRate (ome.model.units.Frequency)
java.lang.Integer	getVersion() This version number is controlled by the database for optimisitic locking.
ElectricPotential	getVoltage() Enum-mapped unit-based field ome.model.acquisition.DetectorSettings.voltage (ome.model.units.ElectricPotential)
java.lang.Double	getZoom() Simple field ome.model.acquisition.DetectorSettings.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()
DetectorSettings	newInstance()
DetectorSettings	proxy()
void	putAt(java.lang.String field, java.lang.Object value) stores a value in this instance.
java.lang.Object	retrieve(java.lang.String field) retrieves a value from this instance.
void	setBinning(Binning binning)
protected void	setDetails(Details details) Use the Details.copy(ome.model.internal.Details) or Details.shallowCopy(ome.model.internal.Details) methods to set the DetectorSettings.Details instance instead.
void	setDetector(Detector detector)
void	setGain(java.lang.Double gain)
void	setId(java.lang.Long id) usually unneeded.
void	setIntegration(java.lang.Integer integration)
void	setOffsetValue(java.lang.Double offsetValue)
void	setReadOutRate(Frequency readOutRate)
void	setVersion(java.lang.Integer version) use with caution.
void	setVoltage(ElectricPotential voltage)
void	setZoom(java.lang.Double zoom)
protected void	throwNullCollectionException(java.lang.String propertyName)
java.lang.String	toString()
void	unload() set the loaded field to false, and set all non-ID fields to null.
Validation	validate() calls the class-specific validator for this instance and returns the Validation object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

OWNER_FILTER

public static final java.lang.String OWNER_FILTER

See Also:

Constant Field Values

GROUP_FILTER

public static final java.lang.String GROUP_FILTER

See Also:

Constant Field Values

EVENT_FILTER

public static final java.lang.String EVENT_FILTER

See Also:

Constant Field Values

PERMS_FILTER

public static final java.lang.String PERMS_FILTER

See Also:

Constant Field Values

ID

public static final java.lang.String ID

See Also:

Constant Field Values

id

protected java.lang.Long id

VERSION

public static final java.lang.String VERSION

See Also:

Constant Field Values

version

protected java.lang.Integer version

voltage

protected ElectricPotential voltage

gain

protected java.lang.Double gain

offsetValue

protected java.lang.Double offsetValue

readOutRate

protected Frequency readOutRate

binning

protected Binning binning

integration

protected java.lang.Integer integration

zoom

protected java.lang.Double zoom

detector

protected Detector detector

details

protected Details details

VOLTAGE

public static final java.lang.String VOLTAGE

See Also:

Constant Field Values

GAIN

public static final java.lang.String GAIN

See Also:

Constant Field Values

OFFSETVALUE

public static final java.lang.String OFFSETVALUE

See Also:

Constant Field Values

READOUTRATE

public static final java.lang.String READOUTRATE

See Also:

Constant Field Values

BINNING

public static final java.lang.String BINNING

See Also:

Constant Field Values

INTEGRATION

public static final java.lang.String INTEGRATION

See Also:

Constant Field Values

ZOOM

public static final java.lang.String ZOOM

See Also:

Constant Field Values

DETECTOR

public static final java.lang.String DETECTOR

See Also:

Constant Field Values

DETAILS

public static final java.lang.String DETAILS

See Also:

Constant Field Values

FIELDS

public static final java.util.Set<java.lang.String> FIELDS

_dynamicFields

protected java.util.Map<java.lang.String,java.lang.Object> _dynamicFields

_loaded

protected boolean _loaded

Constructor Detail

DetectorSettings

public DetectorSettings()

DetectorSettings

protected DetectorSettings(java.lang.Long id)

DetectorSettings

public DetectorSettings(java.lang.Long id,
                        boolean loaded)

Main constructor.

DetectorSettings

public DetectorSettings(Detector _detector)

Method Detail

getId

@DocumentId
public java.lang.Long getId()

The DB unique identifier for this object. You are not responsible for setting the id; however, it can be useful for creating "unloaded" versions of your objects. Each top-level entity contains an id field of type long. For all objects returned from the server, this value will be non-null, which doesn't necessarily hold for the other fields.

Specified by:

getId in interface IObject

Returns:

Long primary key. May be null.

setId

public void setId(java.lang.Long id)

Description copied from interface: IObject

usually unneeded. Ids are managed by the backend.

Specified by:

setId in interface IObject

Parameters:

id - Long value for this id.

getVersion

public java.lang.Integer getVersion()

This version number is controlled by the database for optimisitic locking.

Specified by:

getVersion in interface IMutable

setVersion

public void setVersion(java.lang.Integer version)

Description copied from interface: IMutable

use with caution. In general, the version should only be altered by the backend. In the best case, an exception will be thrown for a version not equal to the current DB value. In the worst (though rare) case, the new version could match the database, and override optimistic lock checks that are supposed to prevent data loss.

Specified by:

setVersion in interface IMutable

Parameters:

version - Value for this objects version.

getVoltage

public ElectricPotential getVoltage()

Enum-mapped unit-based field ome.model.acquisition.DetectorSettings.voltage (ome.model.units.ElectricPotential)

setVoltage

public void setVoltage(ElectricPotential voltage)

getGain

@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields")
public java.lang.Double getGain()

Simple field ome.model.acquisition.DetectorSettings.gain (java.lang.Double)

setGain

public void setGain(java.lang.Double gain)

getOffsetValue

@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields")
public java.lang.Double getOffsetValue()

Simple field ome.model.acquisition.DetectorSettings.offsetValue (java.lang.Double)

setOffsetValue

public void setOffsetValue(java.lang.Double offsetValue)

getReadOutRate

public Frequency getReadOutRate()

Enum-mapped unit-based field ome.model.acquisition.DetectorSettings.readOutRate (ome.model.units.Frequency)

setReadOutRate

public void setReadOutRate(Frequency readOutRate)

getBinning

public Binning getBinning()

Many-to-one field ome.model.acquisition.DetectorSettings.binning (ome.model.enums.Binning)

setBinning

public void setBinning(Binning binning)

getIntegration

@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields")
public java.lang.Integer getIntegration()

Simple field ome.model.acquisition.DetectorSettings.integration (java.lang.Integer)

setIntegration

public void setIntegration(java.lang.Integer integration)

getZoom

@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields")
public java.lang.Double getZoom()

Simple field ome.model.acquisition.DetectorSettings.zoom (java.lang.Double)

setZoom

public void setZoom(java.lang.Double zoom)

getDetector

public Detector getDetector()

Many-to-one field ome.model.acquisition.DetectorSettings.detector (ome.model.acquisition.Detector)

setDetector

public void setDetector(Detector detector)

getDetails

public Details getDetails()

The details of this object correspond to low-level system information. Owner, permissions, Details is always guaranteed to be non-null, unless the user actively nulls it. Every entity also contains a Detail reference, which doesn't refer to a separate table but rather to a collection of fields collected into a Hibernate "component" which is embedded in the object. HQL queries which refer to the Details component cannot directly fetch the entity like this: select o from Object join fetch o.details but rather each field of the Details instance must be explicitly joined: select o from Object join fetch o.details.owner It should also be noted that not all types have all the fields which are present on Details. For example, select e from Experimenter e join fetch e.details.owner will fail. Experimenter has no owner, for obvious reasons. Note: subclasses of this class will return a subclass of the Details type.

Specified by:

getDetails in interface IObject

setDetails

protected void setDetails(Details details)

Use the Details.copy(ome.model.internal.Details) or Details.shallowCopy(ome.model.internal.Details) methods to set the DetectorSettings.Details instance instead.

isValid

public boolean isValid()

Description copied from interface: IObject

calls the class-specific validator for this instance and returns the value from Validation.isValid()

Specified by:

isValid in interface IObject

validate

public Validation validate()

Description copied from interface: IObject

calls the class-specific validator for this instance and returns the Validation object.

Specified by:

validate in interface IObject

Returns:

Validation collecting parameter.

newInstance

public DetectorSettings newInstance()

proxy

public DetectorSettings proxy()

acceptFilter

public boolean acceptFilter(Filter __filter)

Specified by:

acceptFilter in interface Filterable

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

fields

public java.util.Set<java.lang.String> fields()

Description copied from interface: IObject

returns a Set of field names that belong to this class

Specified by:

fields in interface IObject

retrieve

public java.lang.Object retrieve(java.lang.String field)

Description copied from interface: IObject

retrieves a value from this instance. Values for 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)

Specified by:

retrieve in interface IObject

putAt

public void putAt(java.lang.String field,
                  java.lang.Object value)

Description copied from interface: IObject

stores a value in this instance. Values for field which match a field of this instance will be delegated to the accessors. Otherwise, values will be stored in a lazy-loaded map.

Specified by:

putAt in interface IObject

Parameters:

field - Field name

value - Any object to be stored.

isLoaded

public boolean isLoaded()

Description copied from interface: IObject

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.

Specified by:

isLoaded in interface IObject

errorIfUnloaded

protected void errorIfUnloaded()

unload

public void unload()

Description copied from interface: IObject

set the loaded field to false, and set all non-ID fields to null. Subsequent calls to all accessors other than getId/setId will throw an ApiUsageException

Specified by:

unload in interface IObject

getGraphHolder

public final GraphHolder getGraphHolder()

Description copied from interface: IObject

retrieves the GraphHolder for this entity. If the GraphHolder has not been actively set, a new one will be instatiated.

Specified by:

getGraphHolder in interface IObject

Returns:

Non-null GraphHolder

throwNullCollectionException

protected void throwNullCollectionException(java.lang.String propertyName)