ome.model.meta

Class Event

java.lang.Object

ome.model.meta.Event

All Implemented Interfaces:

Serializable, IGlobal, IObject, Filterable

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Event.Details

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>	_dynamicFields
protected boolean	_loaded
protected Event	containingEvent
static String	CONTAININGEVENT
protected Details	details
static String	DETAILS
protected Experimenter	experimenter
static String	EXPERIMENTER
protected ExperimenterGroup	experimenterGroup
static String	EXPERIMENTERGROUP
static Set<String>	FIELDS
protected Long	id
static String	ID
protected Set<EventLog>	logs
static String	LOGS
protected Session	session
static String	SESSION
protected String	status
static String	STATUS
protected Timestamp	time
static String	TIME
protected EventType	type
static String	TYPE

Constructor Summary

Constructors

Modifier	Constructor and Description
	Event()
protected	Event(Long id)
	Event(Long id, boolean loaded) Main constructor.
	Event(Timestamp _time, Experimenter _experimenter, ExperimenterGroup _experimenterGroup, EventType _type, Session _session)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	acceptFilter(Filter __filter)
void	addEventLog(EventLog target) use instead of setLogs .
void	addEventLogSet(Collection<EventLog> targets) use like addEventLog.
void	clearLogs() clears the set.
<E> List<E>	collectLogs(CBlock<E> block) takes a CBlock and calls the block once for each ome.model.meta.EventLog while collecting the results.
protected void	errorIfUnloaded()
Set<String>	fields() returns a Set of field names that belong to this class
Event	getContainingEvent() Many-to-one field ome.model.meta.Event.containingEvent (ome.model.meta.Event)
Details	getDetails() The details of this object correspond to low-level system information.
Experimenter	getExperimenter() Many-to-one field ome.model.meta.Event.experimenter (ome.model.meta.Experimenter)
ExperimenterGroup	getExperimenterGroup() Many-to-one field ome.model.meta.Event.experimenterGroup (ome.model.meta.ExperimenterGroup)
GraphHolder	getGraphHolder() retrieves the GraphHolder for this entity.
Long	getId() The DB unique identifier for this object.
protected Set<EventLog>	getLogs() returns logs .
Session	getSession() Many-to-one field ome.model.meta.Event.session (ome.model.meta.Session)
String	getStatus() Simple field ome.model.meta.Event.status (java.lang.String)
Timestamp	getTime() Simple field ome.model.meta.Event.time (java.sql.Timestamp)
EventType	getType() Many-to-one field ome.model.meta.Event.type (ome.model.enums.EventType)
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()
Iterator<EventLog>	iterateLogs() should be used rather than accessing the logs set directly.
Event	newInstance()
Event	proxy()
void	putAt(String field, Object value) stores a value in this instance.
void	removeEventLog(EventLog target) removes a single element from this set and makes the inverse call on ome.model.meta.EventLog
void	removeEventLogSet(Collection<EventLog> targets) use like removeEventLog
Object	retrieve(String field) retrieves a value from this instance.
void	setContainingEvent(Event containingEvent)
protected void	setDetails(Details details) Use the Details.copy(ome.model.internal.Details) or Details.shallowCopy(ome.model.internal.Details) methods to set the Event.Details instance instead.
void	setExperimenter(Experimenter experimenter)
void	setExperimenterGroup(ExperimenterGroup experimenterGroup)
void	setId(Long id) usually unneeded.
protected void	setLogs(Set<EventLog> logs) setter for logs should be avoided.
void	setSession(Session session)
void	setStatus(String status)
void	setTime(Timestamp time)
void	setType(EventType type)
int	sizeOfLogs() returns the size of logs.
protected void	throwNullCollectionException(String propertyName)
String	toString()
void	unload() set the loaded field to false, and set all non-ID fields to null.
Collection<EventLog>	unmodifiableLogs() 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

ID

public static final String ID

See Also:

Constant Field Values

id

protected Long id

status

protected String status

time

protected Timestamp time

experimenter

protected Experimenter experimenter

experimenterGroup

protected ExperimenterGroup experimenterGroup

type

protected EventType type

containingEvent

protected Event containingEvent

logs

protected Set<EventLog> logs

session

protected Session session

details

protected Details details

STATUS

public static final String STATUS

See Also:

Constant Field Values

TIME

public static final String TIME

See Also:

Constant Field Values

EXPERIMENTER

public static final String EXPERIMENTER

See Also:

Constant Field Values

EXPERIMENTERGROUP

public static final String EXPERIMENTERGROUP

See Also:

Constant Field Values

TYPE

public static final String TYPE

See Also:

Constant Field Values

CONTAININGEVENT

public static final String CONTAININGEVENT

See Also:

Constant Field Values

LOGS

public static final String LOGS

See Also:

Constant Field Values

SESSION

public static final String SESSION

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

Event

public Event()

Event

protected Event(Long id)

Event

public Event(Long id,
     boolean loaded)

Main constructor.

Event

public Event(Timestamp _time,
     Experimenter _experimenter,
     ExperimenterGroup _experimenterGroup,
     EventType _type,
     Session _session)

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.

getStatus

@Fields(value={@Field(index=TOKENIZED),@Field(index=TOKENIZED,name="combined_fields")})
public String getStatus()

Simple field ome.model.meta.Event.status (java.lang.String)

setStatus

public void setStatus(String status)

getTime

@DateBridge(resolution=MINUTE)
@Fields(value={@Field(index=UN_TOKENIZED),@Field(index=UN_TOKENIZED,name="combined_fields")})
public Timestamp getTime()

Simple field ome.model.meta.Event.time (java.sql.Timestamp)

setTime

public void setTime(Timestamp time)

getExperimenter

public Experimenter getExperimenter()

Many-to-one field ome.model.meta.Event.experimenter (ome.model.meta.Experimenter)

setExperimenter

public void setExperimenter(Experimenter experimenter)

getExperimenterGroup

public ExperimenterGroup getExperimenterGroup()

Many-to-one field ome.model.meta.Event.experimenterGroup (ome.model.meta.ExperimenterGroup)

setExperimenterGroup

public void setExperimenterGroup(ExperimenterGroup experimenterGroup)

getType

public EventType getType()

Many-to-one field ome.model.meta.Event.type (ome.model.enums.EventType)

setType

public void setType(EventType type)

getContainingEvent

public Event getContainingEvent()

Many-to-one field ome.model.meta.Event.containingEvent (ome.model.meta.Event)

setContainingEvent

public void setContainingEvent(Event containingEvent)

getLogs

protected Set<EventLog> getLogs()

returns logs . You should not modify this collection unless you know what you are doing. Use the iterate method instead. one-to-many Set ome.model.meta.Event.logs (ome.model.meta.EventLog)

setLogs

protected void setLogs(Set<EventLog> logs)

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

sizeOfLogs

public int sizeOfLogs()

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

iterateLogs

public Iterator<EventLog> iterateLogs()

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

unmodifiableLogs

public Collection<EventLog> unmodifiableLogs()

Returns an unmodifiable collection-view

collectLogs

public <E> List<E> collectLogs(CBlock<E> block)

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

addEventLog

public void addEventLog(EventLog target)

use instead of setLogs . Makes the necessary call on ome.model.meta.EventLog as well.

addEventLogSet

public void addEventLogSet(Collection<EventLog> targets)

use like addEventLog.

removeEventLog

public void removeEventLog(EventLog target)

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

removeEventLogSet

public void removeEventLogSet(Collection<EventLog> targets)

use like removeEventLog

clearLogs

public void clearLogs()

clears the set.

getSession

public Session getSession()

Many-to-one field ome.model.meta.Event.session (ome.model.meta.Session)

setSession

public void setSession(Session session)

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

proxy

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