ome.model.acquisition

Class Laser

java.lang.Object

ome.model.acquisition.LightSource

ome.model.acquisition.Laser

All Implemented Interfaces:

Serializable, IAnnotated, IMutable, IObject, Filterable

@Entity
 @Indexed(index="FullText")
 @ClassBridge(name="details",
             impl=DetailsFieldBridge.class,
             index=UN_TOKENIZED,
             store=NO)
public class Laser
extends LightSource
implements Serializable, IObject, IMutable

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class ome.model.acquisition.LightSource

LightSource.Details

Field Summary

Fields

Modifier and Type	Field and Description
static String	EVENT_FILTER
static Set<String>	FIELDS
protected Integer	frequencyMultiplication
static String	FREQUENCYMULTIPLICATION
static String	GROUP_FILTER
protected LaserMedium	laserMedium
static String	LASERMEDIUM
static String	OWNER_FILTER
static String	PERMS_FILTER
protected Boolean	pockelCell
static String	POCKELCELL
protected Pulse	pulse
static String	PULSE
protected LightSource	pump
static String	PUMP
protected Frequency	repetitionRate
static String	REPETITIONRATE
protected Boolean	tuneable
static String	TUNEABLE
protected LaserType	type
static String	TYPE
protected Length	wavelength
static String	WAVELENGTH

Fields inherited from class ome.model.acquisition.LightSource

_dynamicFields, _loaded, annotationLinks, ANNOTATIONLINKS, ANNOTATIONLINKSCOUNTPEROWNER, details, DETAILS, EVENT_FILTER_ANNOTATIONLINKS, GROUP_FILTER_ANNOTATIONLINKS, id, ID, instrument, INSTRUMENT, lotNumber, LOTNUMBER, manufacturer, MANUFACTURER, model, MODEL, OWNER_FILTER_ANNOTATIONLINKS, PERMS_FILTER_ANNOTATIONLINKS, power, POWER, serialNumber, SERIALNUMBER, version, VERSION

Constructor Summary

Constructors

Modifier	Constructor and Description
	Laser()
	Laser(LaserType _type, LaserMedium _laserMedium)
protected	Laser(Long id)
	Laser(Long id, boolean loaded) Main constructor.

Method Summary

Modifier and Type	Method and Description
boolean	acceptFilter(Filter __filter)
Set<String>	fields() returns a Set of field names that belong to this class
Integer	getFrequencyMultiplication() Simple field ome.model.acquisition.Laser.frequencyMultiplication (java.lang.Integer)
LaserMedium	getLaserMedium() Many-to-one field ome.model.acquisition.Laser.laserMedium (ome.model.enums.LaserMedium)
Boolean	getPockelCell() Simple field ome.model.acquisition.Laser.pockelCell (java.lang.Boolean)
Pulse	getPulse() Many-to-one field ome.model.acquisition.Laser.pulse (ome.model.enums.Pulse)
LightSource	getPump() Many-to-one field ome.model.acquisition.Laser.pump (ome.model.acquisition.LightSource)
Frequency	getRepetitionRate() Enum-mapped unit-based field ome.model.acquisition.Laser.repetitionRate (ome.model.units.Frequency)
Boolean	getTuneable() Simple field ome.model.acquisition.Laser.tuneable (java.lang.Boolean)
LaserType	getType() Many-to-one field ome.model.acquisition.Laser.type (ome.model.enums.LaserType)
Length	getWavelength() Enum-mapped unit-based field ome.model.acquisition.Laser.wavelength (ome.model.units.Length)
boolean	isValid() calls the class-specific validator for this instance and returns the value from Validation.isValid()
Laser	newInstance()
Laser	proxy()
void	putAt(String field, Object value) stores a value in this instance.
Object	retrieve(String field) retrieves a value from this instance.
void	setFrequencyMultiplication(Integer frequencyMultiplication)
void	setLaserMedium(LaserMedium laserMedium)
void	setPockelCell(Boolean pockelCell)
void	setPulse(Pulse pulse)
void	setPump(LightSource pump)
void	setRepetitionRate(Frequency repetitionRate)
void	setTuneable(Boolean tuneable)
void	setType(LaserType type)
void	setWavelength(Length wavelength)
protected void	throwNullCollectionException(String propertyName)
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 ome.model.acquisition.LightSource

addLightSourceAnnotationLink, addLightSourceAnnotationLink, addLightSourceAnnotationLinkSet, clearAnnotationLinks, collectAnnotationLinks, eachLinkedAnnotation, errorIfUnloaded, findLightSourceAnnotationLink, getAnnotationLinks, getAnnotationLinksCountPerOwner, getDetails, getGraphHolder, getId, getInstrument, getLotNumber, getManufacturer, getModel, getPower, getSerialNumber, getVersion, isLoaded, iterateAnnotationLinks, linkAnnotation, linkedAnnotationIterator, linkedAnnotationList, removeLightSourceAnnotationLink, removeLightSourceAnnotationLink, removeLightSourceAnnotationLinkSet, setAnnotationLinks, setAnnotationLinksCountPerOwner, setDetails, setId, setInstrument, setLotNumber, setManufacturer, setModel, setPower, setSerialNumber, setVersion, sizeOfAnnotationLinks, unlinkAnnotation, unmodifiableAnnotationLinks

Methods inherited from class java.lang.Object

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

Methods inherited from interface ome.model.IMutable

getVersion, setVersion

Methods inherited from interface ome.model.IObject

getDetails, getGraphHolder, getId, isLoaded, setId

Field Detail

OWNER_FILTER

public static final String OWNER_FILTER

See Also:

Constant Field Values

GROUP_FILTER

public static final String GROUP_FILTER

See Also:

Constant Field Values

EVENT_FILTER

public static final String EVENT_FILTER

See Also:

Constant Field Values

PERMS_FILTER

public static final String PERMS_FILTER

See Also:

Constant Field Values

type

protected LaserType type

laserMedium

protected LaserMedium laserMedium

frequencyMultiplication

protected Integer frequencyMultiplication

tuneable

protected Boolean tuneable

pulse

protected Pulse pulse

wavelength

protected Length wavelength

pockelCell

protected Boolean pockelCell

pump

protected LightSource pump

repetitionRate

protected Frequency repetitionRate

TYPE

public static final String TYPE

See Also:

Constant Field Values

LASERMEDIUM

public static final String LASERMEDIUM

See Also:

Constant Field Values

FREQUENCYMULTIPLICATION

public static final String FREQUENCYMULTIPLICATION

See Also:

Constant Field Values

TUNEABLE

public static final String TUNEABLE

See Also:

Constant Field Values

PULSE

public static final String PULSE

See Also:

Constant Field Values

WAVELENGTH

public static final String WAVELENGTH

See Also:

Constant Field Values

POCKELCELL

public static final String POCKELCELL

See Also:

Constant Field Values

PUMP

public static final String PUMP

See Also:

Constant Field Values

REPETITIONRATE

public static final String REPETITIONRATE

See Also:

Constant Field Values

FIELDS

public static final Set<String> FIELDS

Constructor Detail

Laser

public Laser()

Laser

protected Laser(Long id)

Laser

public Laser(Long id,
             boolean loaded)

Main constructor.

Laser

public Laser(LaserType _type,
             LaserMedium _laserMedium)

Method Detail

getType

public LaserType getType()

Many-to-one field ome.model.acquisition.Laser.type (ome.model.enums.LaserType)

setType

public void setType(LaserType type)

getLaserMedium

public LaserMedium getLaserMedium()

Many-to-one field ome.model.acquisition.Laser.laserMedium (ome.model.enums.LaserMedium)

setLaserMedium

public void setLaserMedium(LaserMedium laserMedium)

getFrequencyMultiplication

@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields")
public Integer getFrequencyMultiplication()

Simple field ome.model.acquisition.Laser.frequencyMultiplication (java.lang.Integer)

setFrequencyMultiplication

public void setFrequencyMultiplication(Integer frequencyMultiplication)

getTuneable

public Boolean getTuneable()

Simple field ome.model.acquisition.Laser.tuneable (java.lang.Boolean)

setTuneable

public void setTuneable(Boolean tuneable)

getPulse

public Pulse getPulse()

Many-to-one field ome.model.acquisition.Laser.pulse (ome.model.enums.Pulse)

setPulse

public void setPulse(Pulse pulse)

getWavelength

public Length getWavelength()

Enum-mapped unit-based field ome.model.acquisition.Laser.wavelength (ome.model.units.Length)

setWavelength

public void setWavelength(Length wavelength)

getPockelCell

public Boolean getPockelCell()

Simple field ome.model.acquisition.Laser.pockelCell (java.lang.Boolean)

setPockelCell

public void setPockelCell(Boolean pockelCell)

getPump

public LightSource getPump()

Many-to-one field ome.model.acquisition.Laser.pump (ome.model.acquisition.LightSource)

setPump

public void setPump(LightSource pump)

getRepetitionRate

public Frequency getRepetitionRate()

Enum-mapped unit-based field ome.model.acquisition.Laser.repetitionRate (ome.model.units.Frequency)

setRepetitionRate

public void setRepetitionRate(Frequency repetitionRate)

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

Overrides:

isValid in class LightSource

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

Overrides:

validate in class LightSource

Returns:

Validation collecting parameter.

newInstance

public Laser newInstance()

proxy

public Laser proxy()

acceptFilter

public boolean acceptFilter(Filter __filter)

Specified by:

acceptFilter in interface Filterable

Overrides:

acceptFilter in class LightSource

toString

public String toString()

Overrides:

toString in class LightSource

fields

public Set<String> fields()

Description copied from interface: IObject

returns a Set of field names that belong to this class

Specified by:

fields in interface IObject

Overrides:

fields in class LightSource

retrieve

public Object retrieve(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

Overrides:

retrieve in class LightSource

putAt

public void putAt(String field,
                  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

Overrides:

putAt in class LightSource

Parameters:

field - Field name

value - Any object to be stored.

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

Overrides:

unload in class LightSource

throwNullCollectionException

protected void throwNullCollectionException(String propertyName)

Overrides:

throwNullCollectionException in class LightSource