ome.model.enums

Class AcquisitionMode

java.lang.Object

ome.model.enums.AcquisitionMode

All Implemented Interfaces:

java.io.Serializable, IEnum, IGlobal, IObject, Filterable

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AcquisitionMode.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 Details	details
static java.lang.String	DETAILS
static java.util.Set<java.lang.String>	FIELDS
protected java.lang.Long	id
static java.lang.String	ID
protected java.lang.String	value
static java.lang.String	VALUE
static java.lang.String	VALUE_BRIGHT_FIELD
static java.lang.String	VALUE_FLUORESCENCE_CORRELATION_SPECTROSCOPY
static java.lang.String	VALUE_FLUORESCENCE_LIFETIME
static java.lang.String	VALUE_FSM
static java.lang.String	VALUE_LASER_SCANNING_CONFOCAL_MICROSCOPY
static java.lang.String	VALUE_LCM
static java.lang.String	VALUE_MULTI_PHOTON_MICROSCOPY
static java.lang.String	VALUE_NEAR_FIELD_SCANNING_OPTICAL_MICROSCOPY
static java.lang.String	VALUE_OTHER
static java.lang.String	VALUE_PALM
static java.lang.String	VALUE_SECOND_HARMONIC_GENERATION_IMAGING
static java.lang.String	VALUE_SINGLE_MOLECULE_IMAGING
static java.lang.String	VALUE_SLIT_SCAN_CONFOCAL
static java.lang.String	VALUE_SPECTRAL_IMAGING
static java.lang.String	VALUE_SPIM
static java.lang.String	VALUE_SPINNING_DISK_CONFOCAL
static java.lang.String	VALUE_STED
static java.lang.String	VALUE_STORM
static java.lang.String	VALUE_STRUCTURED_ILLUMINATION
static java.lang.String	VALUE_SWEPT_FIELD_CONFOCAL
static java.lang.String	VALUE_TIRF
static java.lang.String	VALUE_TOTAL_INTERNAL_REFLECTION
static java.lang.String	VALUE_UNKNOWN
static java.lang.String	VALUE_WIDE_FIELD

Constructor Summary

Constructors

Modifier	Constructor and Description
	AcquisitionMode()
protected	AcquisitionMode(java.lang.Long id)
	AcquisitionMode(java.lang.Long id, boolean loaded) Main constructor.
	AcquisitionMode(java.lang.String value)

Method Summary

Modifier and Type	Method and Description
boolean	acceptFilter(Filter __filter)
boolean	equals(java.lang.Object other)
protected void	errorIfUnloaded()
java.util.Set<java.lang.String>	fields() returns a Set of field names that belong to this class
Details	getDetails() The details of this object correspond to low-level system information.
GraphHolder	getGraphHolder() retrieves the GraphHolder for this entity.
java.lang.Long	getId() The DB unique identifier for this object.
java.lang.String	getValue() Simple field ome.model.enums.AcquisitionMode.value (java.lang.String)
int	hashCode()
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()
AcquisitionMode	newInstance()
AcquisitionMode	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.
protected void	setDetails(Details details) Use the Details.copy(ome.model.internal.Details) or Details.shallowCopy(ome.model.internal.Details) methods to set the AcquisitionMode.Details instance instead.
void	setId(java.lang.Long id) usually unneeded.
void	setValue(java.lang.String value)
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, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

VALUE_WIDE_FIELD

public static final java.lang.String VALUE_WIDE_FIELD

See Also:

Constant Field Values

VALUE_LASER_SCANNING_CONFOCAL_MICROSCOPY

public static final java.lang.String VALUE_LASER_SCANNING_CONFOCAL_MICROSCOPY

See Also:

Constant Field Values

VALUE_SPINNING_DISK_CONFOCAL

public static final java.lang.String VALUE_SPINNING_DISK_CONFOCAL

See Also:

Constant Field Values

VALUE_SLIT_SCAN_CONFOCAL

public static final java.lang.String VALUE_SLIT_SCAN_CONFOCAL

See Also:

Constant Field Values

VALUE_MULTI_PHOTON_MICROSCOPY

public static final java.lang.String VALUE_MULTI_PHOTON_MICROSCOPY

See Also:

Constant Field Values

VALUE_STRUCTURED_ILLUMINATION

public static final java.lang.String VALUE_STRUCTURED_ILLUMINATION

See Also:

Constant Field Values

VALUE_SINGLE_MOLECULE_IMAGING

public static final java.lang.String VALUE_SINGLE_MOLECULE_IMAGING

See Also:

Constant Field Values

VALUE_TOTAL_INTERNAL_REFLECTION

public static final java.lang.String VALUE_TOTAL_INTERNAL_REFLECTION

See Also:

Constant Field Values

VALUE_FLUORESCENCE_LIFETIME

public static final java.lang.String VALUE_FLUORESCENCE_LIFETIME

See Also:

Constant Field Values

VALUE_SPECTRAL_IMAGING

public static final java.lang.String VALUE_SPECTRAL_IMAGING

See Also:

Constant Field Values

VALUE_FLUORESCENCE_CORRELATION_SPECTROSCOPY

public static final java.lang.String VALUE_FLUORESCENCE_CORRELATION_SPECTROSCOPY

See Also:

Constant Field Values

VALUE_NEAR_FIELD_SCANNING_OPTICAL_MICROSCOPY

public static final java.lang.String VALUE_NEAR_FIELD_SCANNING_OPTICAL_MICROSCOPY

See Also:

Constant Field Values

VALUE_SECOND_HARMONIC_GENERATION_IMAGING

public static final java.lang.String VALUE_SECOND_HARMONIC_GENERATION_IMAGING

See Also:

Constant Field Values

VALUE_PALM

public static final java.lang.String VALUE_PALM

See Also:

Constant Field Values

VALUE_STORM

public static final java.lang.String VALUE_STORM

See Also:

Constant Field Values

VALUE_STED

public static final java.lang.String VALUE_STED

See Also:

Constant Field Values

VALUE_TIRF

public static final java.lang.String VALUE_TIRF

See Also:

Constant Field Values

VALUE_FSM

public static final java.lang.String VALUE_FSM

See Also:

Constant Field Values

VALUE_LCM

public static final java.lang.String VALUE_LCM

See Also:

Constant Field Values

VALUE_OTHER

public static final java.lang.String VALUE_OTHER

See Also:

Constant Field Values

VALUE_UNKNOWN

public static final java.lang.String VALUE_UNKNOWN

See Also:

Constant Field Values

VALUE_BRIGHT_FIELD

public static final java.lang.String VALUE_BRIGHT_FIELD

See Also:

Constant Field Values

VALUE_SWEPT_FIELD_CONFOCAL

public static final java.lang.String VALUE_SWEPT_FIELD_CONFOCAL

See Also:

Constant Field Values

VALUE_SPIM

public static final java.lang.String VALUE_SPIM

See Also:

Constant Field Values

ID

public static final java.lang.String ID

See Also:

Constant Field Values

id

protected java.lang.Long id

value

protected java.lang.String value

details

protected Details details

VALUE

public static final java.lang.String VALUE

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

AcquisitionMode

public AcquisitionMode()

AcquisitionMode

protected AcquisitionMode(java.lang.Long id)

AcquisitionMode

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

Main constructor.

AcquisitionMode

public AcquisitionMode(java.lang.String value)

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.

getValue

@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields")
public java.lang.String getValue()

Simple field ome.model.enums.AcquisitionMode.value (java.lang.String)

Specified by:

getValue in interface IEnum

setValue

public void setValue(java.lang.String value)

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 AcquisitionMode.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 AcquisitionMode newInstance()

proxy

public AcquisitionMode 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)

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object