ome.model.experiment

Class Experiment

java.lang.Object

ome.model.experiment.Experiment

All Implemented Interfaces:

java.io.Serializable, IMutable, IObject, Filterable

@Entity
 @Indexed(index="FullText")
 @ClassBridge(name="details",
             impl=DetailsFieldBridge.class,
             index=UN_TOKENIZED,
             store=NO)
public class Experiment
extends java.lang.Object
implements java.io.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	Experiment.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.lang.String	description
static java.lang.String	DESCRIPTION
protected Details	details
static java.lang.String	DETAILS
static java.lang.String	EVENT_FILTER
static java.lang.String	EVENT_FILTER_MICROBEAMMANIPULATION
static java.util.Set<java.lang.String>	FIELDS
static java.lang.String	GROUP_FILTER
static java.lang.String	GROUP_FILTER_MICROBEAMMANIPULATION
protected java.lang.Long	id
static java.lang.String	ID
protected java.util.Set<MicrobeamManipulation>	microbeamManipulation
static java.lang.String	MICROBEAMMANIPULATION
static java.lang.String	OWNER_FILTER
static java.lang.String	OWNER_FILTER_MICROBEAMMANIPULATION
static java.lang.String	PERMS_FILTER
static java.lang.String	PERMS_FILTER_MICROBEAMMANIPULATION
protected ExperimentType	type
static java.lang.String	TYPE
protected java.lang.Integer	version
static java.lang.String	VERSION

Constructor Summary

Constructors

Modifier	Constructor and Description
	Experiment()
	Experiment(ExperimentType _type)
protected	Experiment(java.lang.Long id)
	Experiment(java.lang.Long id, boolean loaded) Main constructor.

Method Summary

Modifier and Type	Method and Description
boolean	acceptFilter(Filter __filter)
void	addMicrobeamManipulation(MicrobeamManipulation target) use instead of setMicrobeamManipulation .
void	addMicrobeamManipulationSet(java.util.Collection<MicrobeamManipulation> targets) use like addMicrobeamManipulation.
void	clearMicrobeamManipulation() clears the set.
<E> java.util.List<E>	collectMicrobeamManipulation(CBlock<E> block) takes a CBlock and calls the block once for each ome.model.experiment.MicrobeamManipulation 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.lang.String	getDescription() Simple field ome.model.experiment.Experiment.description (java.lang.String)
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.
protected java.util.Set<MicrobeamManipulation>	getMicrobeamManipulation() returns microbeamManipulation .
ExperimentType	getType() Many-to-one field ome.model.experiment.Experiment.type (ome.model.enums.ExperimentType)
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<MicrobeamManipulation>	iterateMicrobeamManipulation() should be used rather than accessing the microbeamManipulation set directly.
Experiment	newInstance()
Experiment	proxy()
void	putAt(java.lang.String field, java.lang.Object value) stores a value in this instance.
void	removeMicrobeamManipulation(MicrobeamManipulation target) removes a single element from this set and makes the inverse call on ome.model.experiment.MicrobeamManipulation
void	removeMicrobeamManipulationSet(java.util.Collection<MicrobeamManipulation> targets) use like removeMicrobeamManipulation
java.lang.Object	retrieve(java.lang.String field) retrieves a value from this instance.
void	setDescription(java.lang.String description)
protected void	setDetails(Details details) Use the Details.copy(ome.model.internal.Details) or Details.shallowCopy(ome.model.internal.Details) methods to set the Experiment.Details instance instead.
void	setId(java.lang.Long id) usually unneeded.
protected void	setMicrobeamManipulation(java.util.Set<MicrobeamManipulation> microbeamManipulation) setter for microbeamManipulation should be avoided.
void	setType(ExperimentType type)
void	setVersion(java.lang.Integer version) use with caution.
int	sizeOfMicrobeamManipulation() returns the size of microbeamManipulation.
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.
java.util.Collection<MicrobeamManipulation>	unmodifiableMicrobeamManipulation() 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

type

protected ExperimentType type

microbeamManipulation

protected java.util.Set<MicrobeamManipulation> microbeamManipulation

OWNER_FILTER_MICROBEAMMANIPULATION

public static final java.lang.String OWNER_FILTER_MICROBEAMMANIPULATION

See Also:

Constant Field Values

GROUP_FILTER_MICROBEAMMANIPULATION

public static final java.lang.String GROUP_FILTER_MICROBEAMMANIPULATION

See Also:

Constant Field Values

EVENT_FILTER_MICROBEAMMANIPULATION

public static final java.lang.String EVENT_FILTER_MICROBEAMMANIPULATION

See Also:

Constant Field Values

PERMS_FILTER_MICROBEAMMANIPULATION

public static final java.lang.String PERMS_FILTER_MICROBEAMMANIPULATION

See Also:

Constant Field Values

description

protected java.lang.String description

details

protected Details details

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

MICROBEAMMANIPULATION

public static final java.lang.String MICROBEAMMANIPULATION

See Also:

Constant Field Values

DESCRIPTION

public static final java.lang.String DESCRIPTION

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

Experiment

public Experiment()

Experiment

protected Experiment(java.lang.Long id)

Experiment

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

Main constructor.

Experiment

public Experiment(ExperimentType _type)

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.

getType

public ExperimentType getType()

Many-to-one field ome.model.experiment.Experiment.type (ome.model.enums.ExperimentType)

setType

public void setType(ExperimentType type)

getMicrobeamManipulation

protected java.util.Set<MicrobeamManipulation> getMicrobeamManipulation()

returns microbeamManipulation . You should not modify this collection unless you know what you are doing. Use the iterate method instead. one-to-many Set ome.model.experiment.Experiment.microbeamManipulation (ome.model.experiment.MicrobeamManipulation)

setMicrobeamManipulation

protected void setMicrobeamManipulation(java.util.Set<MicrobeamManipulation> microbeamManipulation)

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

sizeOfMicrobeamManipulation

public int sizeOfMicrobeamManipulation()

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

iterateMicrobeamManipulation

public java.util.Iterator<MicrobeamManipulation> iterateMicrobeamManipulation()

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

unmodifiableMicrobeamManipulation

public java.util.Collection<MicrobeamManipulation> unmodifiableMicrobeamManipulation()

Returns an unmodifiable collection-view

collectMicrobeamManipulation

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

takes a CBlock and calls the block once for each ome.model.experiment.MicrobeamManipulation while collecting the results. If block == null, then the iterator values themselves are collected. This method uses iterateMicrobeamManipulation() internally and so will return a value even if the underlying collection is null.

addMicrobeamManipulation

public void addMicrobeamManipulation(MicrobeamManipulation target)

use instead of setMicrobeamManipulation . Makes the necessary call on ome.model.experiment.MicrobeamManipulation as well.

addMicrobeamManipulationSet

public void addMicrobeamManipulationSet(java.util.Collection<MicrobeamManipulation> targets)

use like addMicrobeamManipulation.

removeMicrobeamManipulation

public void removeMicrobeamManipulation(MicrobeamManipulation target)

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

removeMicrobeamManipulationSet

public void removeMicrobeamManipulationSet(java.util.Collection<MicrobeamManipulation> targets)

use like removeMicrobeamManipulation

clearMicrobeamManipulation

public void clearMicrobeamManipulation()

clears the set.

getDescription

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

Simple field ome.model.experiment.Experiment.description (java.lang.String)

setDescription

public void setDescription(java.lang.String description)

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

proxy

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