omero.api

Class _ITimelineDisp

java.lang.Object

Ice.ObjectImpl

omero.api._ITimelineDisp

All Implemented Interfaces:

Ice.Object, java.io.Serializable, java.lang.Cloneable, _ITimelineOperations, _ITimelineOperationsNC, _ServiceInterfaceOperations, _ServiceInterfaceOperationsNC, ITimeline, ServiceInterface

Direct Known Subclasses:

_ITimelineTie

public abstract class _ITimelineDisp
extends Ice.ObjectImpl
implements ITimeline

Service for the querying of OMERO metadata based on creation and modification time. Currently supported types for querying include:

• Annotation
• Dataset
• Image
• Project
• RenderingDef

Return maps

The map return values will be indexed by the short type name above: Project, Image, ... All keys which are passed in the StringSet argument will be included in the returned map, even if they have no values. A default value of 0 or the empty list \[] will be used. The only exception to this rule is that the null or empty StringSet implies all valid keys.

Parameters

All methods take a omero::sys::Parameters object and will apply the filter object for paging through the data in order to prevent loading too many objects. If the parameters argument is null or no paging is activated, then the default will be: OFFSET=0, LIMIT=50. Filter.ownerId and Filter.groupId will also be AND'ed to the query if either value is present. If both are null, then the current user id will be used. To retrieve for all users, use ownerId == rlong(-1) and groupId == null.

Merging

The methods which take a StringSet and a Parameters object, also have a bool merge argument. This argument defines whether or not the LIMIT applies to each object independently (\["a","b"] @ 100 == 200) or merges the lists together chronologically (\["a","b"] @ 100 merged == 100).

Time used

Except for Image, IObject.details.updateEvent is used in all cases for determining most recent events. Images are compared via Image.acquisitionDate which is unlike the other properties is modifiable by the user. A typical invocation might look like (in Python):

 
 timeline = sf.getTimelineService()
 params = ParametersI().page(0,100)
 types = \["Project","Dataset"])
 map = timeline.getByPeriod(types, params, False)
 
 

At this point, map will not contain more than 200 objects. This service is defined only in Blitz and so no javadoc is available in the ome.api package. TODOS: binning, stateful caching, ...

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	__ids
static long	serialVersionUID

Fields inherited from interface omero.api.ITimeline

ice_staticId

Constructor Summary

Constructors

Constructor and Description
_ITimelineDisp()

Method Summary

Modifier and Type	Method and Description
static Ice.DispatchStatus	___countByPeriod(ITimeline __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___getByPeriod(ITimeline __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___getEventLogsByPeriod(ITimeline __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___getMostRecentAnnotationLinks(ITimeline __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___getMostRecentObjects(ITimeline __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___getMostRecentShareCommentLinks(ITimeline __obj, IceInternal.Incoming __inS, Ice.Current __current)
Ice.DispatchStatus	__dispatch(IceInternal.Incoming in, Ice.Current __current)
protected void	__readImpl(IceInternal.BasicStream __is)
protected void	__writeImpl(IceInternal.BasicStream __os)
void	countByPeriod_async(AMD_ITimeline_countByPeriod __cb, java.util.List<java.lang.String> types, RTime start, RTime end, Parameters p) Queries the same information as getByPeriod, but only returns the counts for the given objects.
void	getByPeriod_async(AMD_ITimeline_getByPeriod __cb, java.util.List<java.lang.String> types, RTime start, RTime end, Parameters p, boolean merge) Returns the given LIMIT objects of TYPES as ordered by creation/modification times in the Event table, but within the given time window.
void	getEventLogsByPeriod_async(AMD_ITimeline_getEventLogsByPeriod __cb, RTime start, RTime end, Parameters p) Returns the EventLog table objects which are queried to produce the counts above.
void	getMostRecentAnnotationLinks_async(AMD_ITimeline_getMostRecentAnnotationLinks __cb, java.util.List<java.lang.String> parentTypes, java.util.List<java.lang.String> childTypes, java.util.List<java.lang.String> namespaces, Parameters p) Return the last LIMIT annotation __Links__ whose parent (IAnnotated) matches one of the parentTypes, whose child (Annotation) matches one of the childTypes (limit of one for the moment), and who namespace matches via ILIKE.
void	getMostRecentObjects_async(AMD_ITimeline_getMostRecentObjects __cb, java.util.List<java.lang.String> types, Parameters p, boolean merge) Returns the last LIMIT objects of TYPES as ordered by creation/modification times in the Event table.
void	getMostRecentShareCommentLinks_async(AMD_ITimeline_getMostRecentShareCommentLinks __cb, Parameters p) Return the last LIMIT comment annotation links attached to a share by __others__.
protected void	ice_copyStateFrom(Ice.Object __obj)
java.lang.String	ice_id()
java.lang.String	ice_id(Ice.Current __current)
java.lang.String[]	ice_ids()
java.lang.String[]	ice_ids(Ice.Current __current)
boolean	ice_isA(java.lang.String s)
boolean	ice_isA(java.lang.String s, Ice.Current __current)
static java.lang.String	ice_staticId()

Methods inherited from class Ice.ObjectImpl

___ice_id, ___ice_ids, ___ice_isA, ___ice_ping, __checkMode, __read, __read, __readImpl, __write, __write, __writeImpl, clone, ice_dispatch, ice_dispatch, ice_operationAttributes, ice_ping, ice_ping, ice_postUnmarshal, ice_preMarshal

Methods inherited from class java.lang.Object

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

Methods inherited from interface omero.api._ITimelineOperations

countByPeriod_async, getByPeriod_async, getEventLogsByPeriod_async, getMostRecentAnnotationLinks_async, getMostRecentObjects_async, getMostRecentShareCommentLinks_async

Methods inherited from interface Ice.Object

__read, __read, __write, __write, clone, ice_dispatch, ice_dispatch, ice_operationAttributes, ice_ping, ice_ping, ice_postUnmarshal, ice_preMarshal

Field Detail

__ids

public static final java.lang.String[] __ids

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

_ITimelineDisp

public _ITimelineDisp()

Method Detail

ice_copyStateFrom

protected void ice_copyStateFrom(Ice.Object __obj)
                          throws java.lang.CloneNotSupportedException

Throws:

java.lang.CloneNotSupportedException

ice_isA

public boolean ice_isA(java.lang.String s)

Specified by:

ice_isA in interface Ice.Object

Overrides:

ice_isA in class Ice.ObjectImpl

ice_isA

public boolean ice_isA(java.lang.String s,
                       Ice.Current __current)

Specified by:

ice_isA in interface Ice.Object

Overrides:

ice_isA in class Ice.ObjectImpl

ice_ids

public java.lang.String[] ice_ids()

Specified by:

ice_ids in interface Ice.Object

Overrides:

ice_ids in class Ice.ObjectImpl

ice_ids

public java.lang.String[] ice_ids(Ice.Current __current)

Specified by:

ice_ids in interface Ice.Object

Overrides:

ice_ids in class Ice.ObjectImpl

ice_id

public java.lang.String ice_id()

Specified by:

ice_id in interface Ice.Object

Overrides:

ice_id in class Ice.ObjectImpl

ice_id

public java.lang.String ice_id(Ice.Current __current)

Specified by:

ice_id in interface Ice.Object

Overrides:

ice_id in class Ice.ObjectImpl

ice_staticId

public static java.lang.String ice_staticId()

countByPeriod_async

public final void countByPeriod_async(AMD_ITimeline_countByPeriod __cb,
                                      java.util.List<java.lang.String> types,
                                      RTime start,
                                      RTime end,
                                      Parameters p)
                               throws ServerError

Queries the same information as getByPeriod, but only returns the counts for the given objects.

Specified by:

countByPeriod_async in interface _ITimelineOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

getByPeriod_async

public final void getByPeriod_async(AMD_ITimeline_getByPeriod __cb,
                                    java.util.List<java.lang.String> types,
                                    RTime start,
                                    RTime end,
                                    Parameters p,
                                    boolean merge)
                             throws ServerError

Returns the given LIMIT objects of TYPES as ordered by creation/modification times in the Event table, but within the given time window.

Specified by:

getByPeriod_async in interface _ITimelineOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

getEventLogsByPeriod_async

public final void getEventLogsByPeriod_async(AMD_ITimeline_getEventLogsByPeriod __cb,
                                             RTime start,
                                             RTime end,
                                             Parameters p)
                                      throws ServerError

Returns the EventLog table objects which are queried to produce the counts above. Note the concept of period inclusion mentioned above. WORKAROUND WARNING: this method returns non-managed EventLogs (i.e. eventLog.getId() == null) for Image acquisitions.

Specified by:

getEventLogsByPeriod_async in interface _ITimelineOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

getMostRecentAnnotationLinks_async

public final void getMostRecentAnnotationLinks_async(AMD_ITimeline_getMostRecentAnnotationLinks __cb,
                                                     java.util.List<java.lang.String> parentTypes,
                                                     java.util.List<java.lang.String> childTypes,
                                                     java.util.List<java.lang.String> namespaces,
                                                     Parameters p)
                                              throws ServerError

Return the last LIMIT annotation __Links__ whose parent (IAnnotated) matches one of the parentTypes, whose child (Annotation) matches one of the childTypes (limit of one for the moment), and who namespace matches via ILIKE. The parents and children will be unloaded. The link will have its creation/update events loaded. If Parameters.theFilter.ownerId or groupId are set, they will be AND'ed to the query to filter results. Merges by default based on parentType.

Specified by:

getMostRecentAnnotationLinks_async in interface _ITimelineOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

getMostRecentObjects_async

public final void getMostRecentObjects_async(AMD_ITimeline_getMostRecentObjects __cb,
                                             java.util.List<java.lang.String> types,
                                             Parameters p,
                                             boolean merge)
                                      throws ServerError

Returns the last LIMIT objects of TYPES as ordered by creation/modification times in the Event table.

Specified by:

getMostRecentObjects_async in interface _ITimelineOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

getMostRecentShareCommentLinks_async

public final void getMostRecentShareCommentLinks_async(AMD_ITimeline_getMostRecentShareCommentLinks __cb,
                                                       Parameters p)
                                                throws ServerError

Return the last LIMIT comment annotation links attached to a share by __others__. Note: Currently the storage of these objects is not optimal and so this method may change.

Specified by:

getMostRecentShareCommentLinks_async in interface _ITimelineOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

___getMostRecentAnnotationLinks

public static Ice.DispatchStatus ___getMostRecentAnnotationLinks(ITimeline __obj,
                                                                 IceInternal.Incoming __inS,
                                                                 Ice.Current __current)

___getMostRecentShareCommentLinks

public static Ice.DispatchStatus ___getMostRecentShareCommentLinks(ITimeline __obj,
                                                                   IceInternal.Incoming __inS,
                                                                   Ice.Current __current)

___getMostRecentObjects

public static Ice.DispatchStatus ___getMostRecentObjects(ITimeline __obj,
                                                         IceInternal.Incoming __inS,
                                                         Ice.Current __current)

___getByPeriod

public static Ice.DispatchStatus ___getByPeriod(ITimeline __obj,
                                                IceInternal.Incoming __inS,
                                                Ice.Current __current)

___countByPeriod

public static Ice.DispatchStatus ___countByPeriod(ITimeline __obj,
                                                  IceInternal.Incoming __inS,
                                                  Ice.Current __current)

___getEventLogsByPeriod

public static Ice.DispatchStatus ___getEventLogsByPeriod(ITimeline __obj,
                                                         IceInternal.Incoming __inS,
                                                         Ice.Current __current)

__dispatch

public Ice.DispatchStatus __dispatch(IceInternal.Incoming in,
                                     Ice.Current __current)

Specified by:

__dispatch in interface Ice.Object

Overrides:

__dispatch in class Ice.ObjectImpl

__writeImpl

protected void __writeImpl(IceInternal.BasicStream __os)

Overrides:

__writeImpl in class Ice.ObjectImpl

__readImpl

protected void __readImpl(IceInternal.BasicStream __is)

Overrides:

__readImpl in class Ice.ObjectImpl