ome.model.acquisition

Class Filament

java.lang.Object

ome.model.acquisition.LightSource

ome.model.acquisition.Filament

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 Filament
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
static String	GROUP_FILTER
static String	OWNER_FILTER
static String	PERMS_FILTER
protected FilamentType	type
static String	TYPE

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
	Filament()
	Filament(FilamentType _type)
protected	Filament(Long id)
	Filament(Long id, boolean loaded) Main constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	acceptFilter(Filter __filter)
Set<String>	fields() returns a Set of field names that belong to this class
FilamentType	getType() Many-to-one field ome.model.acquisition.Filament.type (ome.model.enums.FilamentType)
boolean	isValid() calls the class-specific validator for this instance and returns the value from Validation.isValid()
Filament	newInstance()
Filament	proxy()
void	putAt(String field, Object value) stores a value in this instance.
Object	retrieve(String field) retrieves a value from this instance.
void	setType(FilamentType type)
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 FilamentType type

TYPE

public static final String TYPE

See Also:

Constant Field Values

FIELDS

public static final Set<String> FIELDS

Constructor Detail

Filament

public Filament()

Filament

protected Filament(Long id)

Filament

public Filament(Long id,
        boolean loaded)

Main constructor.

Filament

public Filament(FilamentType _type)

Method Detail

getType

public FilamentType getType()

Many-to-one field ome.model.acquisition.Filament.type (ome.model.enums.FilamentType)

setType

public void setType(FilamentType type)

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 Filament newInstance()

proxy

public Filament 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