ome.model.acquisition

Class LightSource

java.lang.Object

ome.model.acquisition.LightSource

All Implemented Interfaces:

java.io.Serializable, IAnnotated, IMutable, IObject, Filterable

Direct Known Subclasses:

Arc, Filament, GenericExcitationSource, Laser, LightEmittingDiode

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

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	LightSource.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 java.util.Set<LightSourceAnnotationLink>	annotationLinks
static java.lang.String	ANNOTATIONLINKS
static java.lang.String	ANNOTATIONLINKSCOUNTPEROWNER
protected Details	details
static java.lang.String	DETAILS
static java.lang.String	EVENT_FILTER
static java.lang.String	EVENT_FILTER_ANNOTATIONLINKS
static java.util.Set<java.lang.String>	FIELDS
static java.lang.String	GROUP_FILTER
static java.lang.String	GROUP_FILTER_ANNOTATIONLINKS
protected java.lang.Long	id
static java.lang.String	ID
protected Instrument	instrument
static java.lang.String	INSTRUMENT
protected java.lang.String	lotNumber
static java.lang.String	LOTNUMBER
protected java.lang.String	manufacturer
static java.lang.String	MANUFACTURER
protected java.lang.String	model
static java.lang.String	MODEL
static java.lang.String	OWNER_FILTER
static java.lang.String	OWNER_FILTER_ANNOTATIONLINKS
static java.lang.String	PERMS_FILTER
static java.lang.String	PERMS_FILTER_ANNOTATIONLINKS
protected Power	power
static java.lang.String	POWER
protected java.lang.String	serialNumber
static java.lang.String	SERIALNUMBER
protected java.lang.Integer	version
static java.lang.String	VERSION

Constructor Summary

Constructors

Modifier	Constructor and Description
	LightSource()
	LightSource(Instrument _instrument)
protected	LightSource(java.lang.Long id)
	LightSource(java.lang.Long id, boolean loaded) Main constructor.

Method Summary

Modifier and Type	Method and Description
boolean	acceptFilter(Filter __filter)
void	addLightSourceAnnotationLink(LightSourceAnnotationLink target) use instead of setAnnotationLinks .
void	addLightSourceAnnotationLink(LightSourceAnnotationLink link, boolean bothSides) Adds a ome.model.annotations.LightSourceAnnotationLink to annotationLinks, allowing for recursion -- whether or not addLightSourceAnnotationLink will be called on the addition if it is loaded
void	addLightSourceAnnotationLinkSet(java.util.Collection<LightSourceAnnotationLink> targets) use like addLightSourceAnnotationLink.
void	clearAnnotationLinks() clears the set.
<E> java.util.List<E>	collectAnnotationLinks(CBlock<E> block) takes a CBlock and calls the block once for each ome.model.annotations.LightSourceAnnotationLink while collecting the results.
<E> java.util.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()
java.util.Set<java.lang.String>	fields() returns a Set of field names that belong to this class
java.util.Set<LightSourceAnnotationLink>	findLightSourceAnnotationLink(Annotation target) find all ome.model.annotations.LightSourceAnnotationLink which have the argument as their child.
protected java.util.Set<LightSourceAnnotationLink>	getAnnotationLinks() returns annotationLinks .
java.util.Map<java.lang.Long,java.lang.Long>	getAnnotationLinksCountPerOwner() If fetched, returns the count(*) of ome.model.annotations.LightSourceAnnotationLink that a user has.
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.
Instrument	getInstrument() Many-to-one field ome.model.acquisition.LightSource.instrument (ome.model.acquisition.Instrument)
java.lang.String	getLotNumber() Simple field ome.model.acquisition.LightSource.lotNumber (java.lang.String)
java.lang.String	getManufacturer() Simple field ome.model.acquisition.LightSource.manufacturer (java.lang.String)
java.lang.String	getModel() Simple field ome.model.acquisition.LightSource.model (java.lang.String)
Power	getPower() Enum-mapped unit-based field ome.model.acquisition.LightSource.power (ome.model.units.Power)
java.lang.String	getSerialNumber() Simple field ome.model.acquisition.LightSource.serialNumber (java.lang.String)
java.lang.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()
java.util.Iterator<LightSourceAnnotationLink>	iterateAnnotationLinks() should be used rather than accessing the annotationLinks set directly.
LightSourceAnnotationLink	linkAnnotation(Annotation addition) Adds a ome.model.annotations.LightSourceAnnotationLink to annotationLinks .
java.util.Iterator<Annotation>	linkedAnnotationIterator() provides an iterator over the parent values of the annotationLinks.
java.util.List<Annotation>	linkedAnnotationList() produces a List-copy of the underlying collection.
void	putAt(java.lang.String field, java.lang.Object value) stores a value in this instance.
void	removeLightSourceAnnotationLink(LightSourceAnnotationLink target) removes a single element from this set and makes the inverse call on ome.model.annotations.LightSourceAnnotationLink
void	removeLightSourceAnnotationLink(LightSourceAnnotationLink link, boolean bothSides) removes the given LightSourceAnnotationLink from annotationLinks, allowing for recursion -- whether or not the removal will call unlinkLightSource again if loaded.
void	removeLightSourceAnnotationLinkSet(java.util.Collection<LightSourceAnnotationLink> targets) use like removeLightSourceAnnotationLink
java.lang.Object	retrieve(java.lang.String field) retrieves a value from this instance.
protected void	setAnnotationLinks(java.util.Set<LightSourceAnnotationLink> annotationLinks) setter for annotationLinks should be avoided.
protected void	setAnnotationLinksCountPerOwner(java.util.Map<java.lang.Long,java.lang.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 LightSource.Details instance instead.
void	setId(java.lang.Long id) usually unneeded.
void	setInstrument(Instrument instrument)
void	setLotNumber(java.lang.String lotNumber)
void	setManufacturer(java.lang.String manufacturer)
void	setModel(java.lang.String model)
void	setPower(Power power)
void	setSerialNumber(java.lang.String serialNumber)
void	setVersion(java.lang.Integer version) use with caution.
int	sizeOfAnnotationLinks() returns the size of annotationLinks.
protected void	throwNullCollectionException(java.lang.String propertyName)
java.lang.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.
java.util.Collection<LightSourceAnnotationLink>	unmodifiableAnnotationLinks() Returns an unmodifiable collection-view
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

manufacturer

protected java.lang.String manufacturer

model

protected java.lang.String model

power

protected Power power

lotNumber

protected java.lang.String lotNumber

serialNumber

protected java.lang.String serialNumber

instrument

protected Instrument instrument

annotationLinks

protected java.util.Set<LightSourceAnnotationLink> annotationLinks

OWNER_FILTER_ANNOTATIONLINKS

public static final java.lang.String OWNER_FILTER_ANNOTATIONLINKS

See Also:

Constant Field Values

GROUP_FILTER_ANNOTATIONLINKS

public static final java.lang.String GROUP_FILTER_ANNOTATIONLINKS

See Also:

Constant Field Values

EVENT_FILTER_ANNOTATIONLINKS

public static final java.lang.String EVENT_FILTER_ANNOTATIONLINKS

See Also:

Constant Field Values

PERMS_FILTER_ANNOTATIONLINKS

public static final java.lang.String PERMS_FILTER_ANNOTATIONLINKS

See Also:

Constant Field Values

details

protected Details details

MANUFACTURER

public static final java.lang.String MANUFACTURER

See Also:

Constant Field Values

MODEL

public static final java.lang.String MODEL

See Also:

Constant Field Values

POWER

public static final java.lang.String POWER

See Also:

Constant Field Values

LOTNUMBER

public static final java.lang.String LOTNUMBER

See Also:

Constant Field Values

SERIALNUMBER

public static final java.lang.String SERIALNUMBER

See Also:

Constant Field Values

INSTRUMENT

public static final java.lang.String INSTRUMENT

See Also:

Constant Field Values

ANNOTATIONLINKSCOUNTPEROWNER

public static final java.lang.String ANNOTATIONLINKSCOUNTPEROWNER

See Also:

Constant Field Values

ANNOTATIONLINKS

public static final java.lang.String ANNOTATIONLINKS

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

LightSource

public LightSource()

LightSource

protected LightSource(java.lang.Long id)

LightSource

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

Main constructor.

LightSource

public LightSource(Instrument _instrument)

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.

getManufacturer

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

Simple field ome.model.acquisition.LightSource.manufacturer (java.lang.String)

setManufacturer

public void setManufacturer(java.lang.String manufacturer)

getModel

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

Simple field ome.model.acquisition.LightSource.model (java.lang.String)

setModel

public void setModel(java.lang.String model)

getPower

public Power getPower()

Enum-mapped unit-based field ome.model.acquisition.LightSource.power (ome.model.units.Power)

setPower

public void setPower(Power power)

getLotNumber

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

Simple field ome.model.acquisition.LightSource.lotNumber (java.lang.String)

setLotNumber

public void setLotNumber(java.lang.String lotNumber)

getSerialNumber

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

Simple field ome.model.acquisition.LightSource.serialNumber (java.lang.String)

setSerialNumber

public void setSerialNumber(java.lang.String serialNumber)

getInstrument

public Instrument getInstrument()

Many-to-one field ome.model.acquisition.LightSource.instrument (ome.model.acquisition.Instrument)

setInstrument

public void setInstrument(Instrument instrument)

getAnnotationLinks

protected java.util.Set<LightSourceAnnotationLink> getAnnotationLinks()

returns annotationLinks . You should not modify this collection unless you know what you are doing. Use the iterate method instead. one-to-many Set ome.model.acquisition.LightSource.annotationLinks (ome.model.annotations.LightSourceAnnotationLink)

setAnnotationLinks

protected void setAnnotationLinks(java.util.Set<LightSourceAnnotationLink> annotationLinks)

setter for annotationLinks should be avoided. Does not fulfill normal semantics.

sizeOfAnnotationLinks

public int sizeOfAnnotationLinks()

returns the size of annotationLinks. If less than zero, the Set was null.

Specified by:

sizeOfAnnotationLinks in interface IAnnotated

iterateAnnotationLinks

public java.util.Iterator<LightSourceAnnotationLink> iterateAnnotationLinks()

should be used rather than accessing the annotationLinks set directly. This method will never return null, but rather will return an instance of EmptyIterator. To test for a null collection, see of sizeOfAnnotationLinks() is less than zero.

Specified by:

iterateAnnotationLinks in interface IAnnotated

unmodifiableAnnotationLinks

public java.util.Collection<LightSourceAnnotationLink> unmodifiableAnnotationLinks()

Returns an unmodifiable collection-view

Specified by:

unmodifiableAnnotationLinks in interface IAnnotated

collectAnnotationLinks

public <E> java.util.List<E> collectAnnotationLinks(CBlock<E> block)

takes a CBlock and calls the block once for each ome.model.annotations.LightSourceAnnotationLink while collecting the results. If 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.

Specified by:

collectAnnotationLinks in interface IAnnotated

addLightSourceAnnotationLink

public void addLightSourceAnnotationLink(LightSourceAnnotationLink target)

use instead of setAnnotationLinks . Makes the necessary call on ome.model.annotations.LightSourceAnnotationLink as well.

addLightSourceAnnotationLinkSet

public void addLightSourceAnnotationLinkSet(java.util.Collection<LightSourceAnnotationLink> targets)

use like addLightSourceAnnotationLink.

removeLightSourceAnnotationLink

public void removeLightSourceAnnotationLink(LightSourceAnnotationLink target)

removes a single element from this set and makes the inverse call on ome.model.annotations.LightSourceAnnotationLink

removeLightSourceAnnotationLinkSet

public void removeLightSourceAnnotationLinkSet(java.util.Collection<LightSourceAnnotationLink> targets)

use like removeLightSourceAnnotationLink

linkAnnotation

public LightSourceAnnotationLink linkAnnotation(Annotation addition)

Adds a ome.model.annotations.LightSourceAnnotationLink to annotationLinks . This entails changing our annotationLinks Set, creating a new ome.model.annotations.LightSourceAnnotationLink and calling linkAnnotation on the ome.model.annotations.Annotation.

Specified by:

linkAnnotation in interface IAnnotated

addLightSourceAnnotationLink

public void addLightSourceAnnotationLink(LightSourceAnnotationLink link,
                                         boolean bothSides)

Adds a ome.model.annotations.LightSourceAnnotationLink to annotationLinks, allowing for recursion -- whether or not addLightSourceAnnotationLink will be called on the addition if it is loaded

linkedAnnotationIterator

public java.util.Iterator<Annotation> linkedAnnotationIterator()

provides an iterator over the parent values of the annotationLinks. Like with most Collection iterators, modifications to the underlying collection while iterating will result in an ConcurrentModificationException. Use linkedAnnotationList() instead.

Specified by:

linkedAnnotationIterator in interface IAnnotated

findLightSourceAnnotationLink

public java.util.Set<LightSourceAnnotationLink> findLightSourceAnnotationLink(Annotation target)

find all ome.model.annotations.LightSourceAnnotationLink which have the argument as their child.

linkedAnnotationList

public java.util.List<Annotation> linkedAnnotationList()

produces a List-copy of the underlying collection. Unlike, linkedAnnotationIterator(), while using the returned List, modifications can be made to the underlying collection without throwing ConcurrentModificationException.

Specified by:

linkedAnnotationList in interface IAnnotated

eachLinkedAnnotation

public <E> java.util.List<E> eachLinkedAnnotation(CBlock<E> block)

takes a CBlock and calls the block once for each ome.model.annotations.Annotation while collecting the results. If block == null, then the iterator values themselves are collected.

Specified by:

eachLinkedAnnotation in interface IAnnotated

unlinkAnnotation

public void unlinkAnnotation(Annotation removal)

unlinks all ome.model.annotations.Annotation instances from this instance.

Specified by:

unlinkAnnotation in interface IAnnotated

removeLightSourceAnnotationLink

public void removeLightSourceAnnotationLink(LightSourceAnnotationLink link,
                                            boolean bothSides)

removes the given LightSourceAnnotationLink from annotationLinks, allowing for recursion -- whether or not the removal will call unlinkLightSource again if loaded.

clearAnnotationLinks

public void clearAnnotationLinks()

clears the set.

Specified by:

clearAnnotationLinks in interface IAnnotated

setAnnotationLinksCountPerOwner

protected void setAnnotationLinksCountPerOwner(java.util.Map<java.lang.Long,java.lang.Long> map)

getAnnotationLinksCountPerOwner

public java.util.Map<java.lang.Long,java.lang.Long> getAnnotationLinksCountPerOwner()

If fetched, returns the count(*) of ome.model.annotations.LightSourceAnnotationLink that a user has. If unfetched, returns null. No entries in the collection should be null.

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 LightSource.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.

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)