omero.api

Class Callback_IContainer_findContainerHierarchies

java.lang.Object

IceInternal.CallbackBase

IceInternal.TwowayCallback

omero.api.Callback_IContainer_findContainerHierarchies

All Implemented Interfaces:

Ice.TwowayCallback, Ice.TwowayCallbackArg1<java.util.List<IObject>>, Ice.TwowayCallbackArg1UE<java.util.List<IObject>>

public abstract class Callback_IContainer_findContainerHierarchies
extends IceInternal.TwowayCallback
implements Ice.TwowayCallbackArg1UE<java.util.List<IObject>>

Retrieves hierarchy trees in various hierarchies that contain the specified Images.

This method will look for all the containers containing the specified Images and then for all containers containing those containers and on up the container hierarchy.

This method returns a Set with all root nodes that were found. Every root node is linked to the found objects and so on until the leaf nodes, which are Image objects. Note that the type of any root node in the returned set can be the given rootNodeType, any of its containees or an Image.

For example, say that you pass in the ids of six Images: i1, i2, i3, i4, i5, i6. If the P/D/I hierarchy in the DB looks like this:

 |                  __p1__                     
 |                 /      \                    
 |               _d1_    _d2_      d3          
 |              /    \  /    \     |           
 |             i1     i2     i3    i4    i5  i6
 

Then the returned set will contain p1, d3, i5, i6. All objects will be properly linked up.

Finally, this method will only retrieve the nodes that are connected in a tree to the specified leaf image nodes. Back to the previous example, if d1 contained image img500, then the returned object would not contain img500. In a similar way, if p1 contained ds300 and this dataset weren't linked to any of the i1, i2, i3, i4, i5, i6 images, then ds300 would not be part of the returned tree rooted by p1.

Constructor Summary

Constructors

Constructor and Description
Callback_IContainer_findContainerHierarchies()

Method Summary

Modifier and Type	Method and Description
void	__completed(Ice.AsyncResult __result)

Methods inherited from class IceInternal.TwowayCallback

__hasSentCallback, __sent, exception, sent

Methods inherited from class IceInternal.CallbackBase

check

Methods inherited from class java.lang.Object

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

Methods inherited from interface Ice.TwowayCallbackArg1UE

exception

Methods inherited from interface Ice.TwowayCallbackArg1

response

Methods inherited from interface Ice.TwowayCallback

exception, exception

Constructor Detail

Callback_IContainer_findContainerHierarchies

public Callback_IContainer_findContainerHierarchies()

Method Detail

__completed

public final void __completed(Ice.AsyncResult __result)

Specified by:

__completed in class IceInternal.CallbackBase