ome.model.acquisition

Class OTF

java.lang.Object

ome.model.acquisition.OTF

All Implemented Interfaces:

Serializable, IMutable, IObject, Filterable

@Entity
 @Indexed(index="FullText")
 @ClassBridge(name="details",
             impl=DetailsFieldBridge.class,
             index=UN_TOKENIZED,
             store=NO)
public class OTF
extends Object
implements 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	OTF.Details

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>	_dynamicFields
protected boolean	_loaded
protected Details	details
static String	DETAILS
static String	EVENT_FILTER
static Set<String>	FIELDS
protected FilterSet	filterSet
static String	FILTERSET
static String	GROUP_FILTER
protected Long	id
static String	ID
protected Instrument	instrument
static String	INSTRUMENT
protected Objective	objective
static String	OBJECTIVE
protected Boolean	opticalAxisAveraged
static String	OPTICALAXISAVERAGED
static String	OWNER_FILTER
protected String	path
static String	PATH
static String	PERMS_FILTER
protected PixelsType	pixelsType
static String	PIXELSTYPE
protected Integer	sizeX
static String	SIZEX
protected Integer	sizeY
static String	SIZEY
protected Integer	version
static String	VERSION

Constructor Summary

Constructors

Modifier	Constructor and Description
	OTF()
	OTF(Integer _sizeX, Integer _sizeY, Boolean _opticalAxisAveraged, PixelsType _pixelsType, String _path, Objective _objective, Instrument _instrument)
protected	OTF(Long id)
	OTF(Long id, boolean loaded) Main constructor.

Method Summary

Modifier and Type	Method and Description
boolean	acceptFilter(Filter __filter)
protected void	errorIfUnloaded()
Set<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.
FilterSet	getFilterSet() Many-to-one field ome.model.acquisition.OTF.filterSet (ome.model.acquisition.FilterSet)
GraphHolder	getGraphHolder() retrieves the GraphHolder for this entity.
Long	getId() The DB unique identifier for this object.
Instrument	getInstrument() Many-to-one field ome.model.acquisition.OTF.instrument (ome.model.acquisition.Instrument)
Objective	getObjective() Many-to-one field ome.model.acquisition.OTF.objective (ome.model.acquisition.Objective)
Boolean	getOpticalAxisAveraged() Simple field ome.model.acquisition.OTF.opticalAxisAveraged (java.lang.Boolean)
String	getPath() Simple field ome.model.acquisition.OTF.path (java.lang.String)
PixelsType	getPixelsType() Many-to-one field ome.model.acquisition.OTF.pixelsType (ome.model.enums.PixelsType)
Integer	getSizeX() Simple field ome.model.acquisition.OTF.sizeX (java.lang.Integer)
Integer	getSizeY() Simple field ome.model.acquisition.OTF.sizeY (java.lang.Integer)
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()
OTF	newInstance()
OTF	proxy()
void	putAt(String field, Object value) stores a value in this instance.
Object	retrieve(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 OTF.Details instance instead.
void	setFilterSet(FilterSet filterSet)
void	setId(Long id) usually unneeded.
void	setInstrument(Instrument instrument)
void	setObjective(Objective objective)
void	setOpticalAxisAveraged(Boolean opticalAxisAveraged)
void	setPath(String path)
void	setPixelsType(PixelsType pixelsType)
void	setSizeX(Integer sizeX)
void	setSizeY(Integer sizeY)
void	setVersion(Integer version) use with caution.
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 java.lang.Object

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

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

ID

public static final String ID

See Also:

Constant Field Values

id

protected Long id

VERSION

public static final String VERSION

See Also:

Constant Field Values

version

protected Integer version

sizeX

protected Integer sizeX

sizeY

protected Integer sizeY

opticalAxisAveraged

protected Boolean opticalAxisAveraged

pixelsType

protected PixelsType pixelsType

path

protected String path

filterSet

protected FilterSet filterSet

objective

protected Objective objective

instrument

protected Instrument instrument

details

protected Details details

SIZEX

public static final String SIZEX

See Also:

Constant Field Values

SIZEY

public static final String SIZEY

See Also:

Constant Field Values

OPTICALAXISAVERAGED

public static final String OPTICALAXISAVERAGED

See Also:

Constant Field Values

PIXELSTYPE

public static final String PIXELSTYPE

See Also:

Constant Field Values

PATH

public static final String PATH

See Also:

Constant Field Values

FILTERSET

public static final String FILTERSET

See Also:

Constant Field Values

OBJECTIVE

public static final String OBJECTIVE

See Also:

Constant Field Values

INSTRUMENT

public static final String INSTRUMENT

See Also:

Constant Field Values

DETAILS

public static final String DETAILS

See Also:

Constant Field Values

FIELDS

public static final Set<String> FIELDS

_dynamicFields

protected Map<String,Object> _dynamicFields

_loaded

protected boolean _loaded

Constructor Detail

OTF

public OTF()

OTF

protected OTF(Long id)

OTF

public OTF(Long id,
           boolean loaded)

Main constructor.

OTF

public OTF(Integer _sizeX,
           Integer _sizeY,
           Boolean _opticalAxisAveraged,
           PixelsType _pixelsType,
           String _path,
           Objective _objective,
           Instrument _instrument)

Method Detail

getId

@DocumentId
public 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(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 Integer getVersion()

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

Specified by:

getVersion in interface IMutable

setVersion

public void setVersion(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.

getSizeX

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

Simple field ome.model.acquisition.OTF.sizeX (java.lang.Integer)

setSizeX

public void setSizeX(Integer sizeX)

getSizeY

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

Simple field ome.model.acquisition.OTF.sizeY (java.lang.Integer)

setSizeY

public void setSizeY(Integer sizeY)

getOpticalAxisAveraged

public Boolean getOpticalAxisAveraged()

Simple field ome.model.acquisition.OTF.opticalAxisAveraged (java.lang.Boolean)

setOpticalAxisAveraged

public void setOpticalAxisAveraged(Boolean opticalAxisAveraged)

getPixelsType

public PixelsType getPixelsType()

Many-to-one field ome.model.acquisition.OTF.pixelsType (ome.model.enums.PixelsType)

setPixelsType

public void setPixelsType(PixelsType pixelsType)

getPath

@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields")
public String getPath()

Simple field ome.model.acquisition.OTF.path (java.lang.String)

setPath

public void setPath(String path)

getFilterSet

public FilterSet getFilterSet()

Many-to-one field ome.model.acquisition.OTF.filterSet (ome.model.acquisition.FilterSet)

setFilterSet

public void setFilterSet(FilterSet filterSet)

getObjective

public Objective getObjective()

Many-to-one field ome.model.acquisition.OTF.objective (ome.model.acquisition.Objective)

setObjective

public void setObjective(Objective objective)

getInstrument

public Instrument getInstrument()

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

setInstrument

public void setInstrument(Instrument instrument)

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

proxy

public OTF proxy()

acceptFilter

public boolean acceptFilter(Filter __filter)

Specified by:

acceptFilter in interface Filterable

toString

public String toString()

Overrides:

toString in class Object

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

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

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

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(String propertyName)