Package ome.model.meta

Class Event

    • Field Detail

      • id

        protected java.lang.Long id

      • status

        protected java.lang.String status

      • time

        protected java.sql.Timestamp time

      • containingEvent

        protected Event containingEvent

      • logs

        protected java.util.Set<EventLog> logs

      • session

        protected Session session

      • details

        protected Details details

      • EXPERIMENTERGROUP

        public static final java.lang.String EXPERIMENTERGROUP
        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

      • Event

        public Event()

      • Event

        protected Event​(java.lang.Long id)

      • Event

        public Event​(java.lang.Long id,
             boolean loaded)
        Main constructor.

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

      • getStatus

        @Field(index=TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields")
public java.lang.String getStatus()
        Simple field ome.model.meta.Event.status (java.lang.String)

      • setStatus

        public void setStatus​(java.lang.String status)

      • getTime

        @DateBridge(resolution=MINUTE)
@Fields(@Field(index=UN_TOKENIZED))
public java.sql.Timestamp getTime()
        Simple field ome.model.meta.Event.time (java.sql.Timestamp)

      • setTime

        public void setTime​(java.sql.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 java.util.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​(java.util.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 java.util.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 java.util.Collection<EventLog> unmodifiableLogs()
        Returns an unmodifiable collection-view

      • collectLogs

        public <E> java.util.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​(java.util.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​(java.util.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 subclass of the Details type.
        Specified by:
        getDetails in interface IObject

      • setDetails

        protected void setDetails​(Details details)

      • 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()

      • 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)