/*
* org.openmicroscopy.shoola.env.data.views.calls.ServerSideROILoader
*
*------------------------------------------------------------------------------
* Copyright (C) 2006-2009 University of Dundee. All rights reserved.
*
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
*------------------------------------------------------------------------------
*/
package org.openmicroscopy.shoola.env.data.views.calls;
//Java imports
//Third-party libraries
//Application-internal dependencies
import org.openmicroscopy.shoola.env.data.OmeroImageService;
import omero.gateway.SecurityContext;
import org.openmicroscopy.shoola.env.data.views.BatchCall;
import org.openmicroscopy.shoola.env.data.views.BatchCallTree;
/**
* Loads the server side ROIs into the measurement tool. Also if there are no
* ROI it will check to see if there is an ROI.xml file and try and load from
* it.
*
*
* @author Jean-Marie Burel
* <a href="mailto:j.burel@dundee.ac.uk">j.burel@dundee.ac.uk</a>
* @author Donald MacDonald
* <a href="mailto:donald@lifesci.dundee.ac.uk">donald@lifesci.dundee.ac.uk</a>
* @version 3.0
* <small>
* (<b>Internal version:</b> $Revision: $Date: $)
* </small>
* @since 3.0-Beta4
*/
public class ServerSideROILoader
extends BatchCallTree
{
/** The result of the query. */
private Object results;
/** Call to load the ROIs. */
private BatchCall loadCall;
/**
* This loader will check that there are ROI's on the server and if so
* load those ROIs. If there are no ROI, the measurement tool will check
* to see if there is an XML ROI file to load roi's from.
*
* @param ctx The security context.
* @param imageID The id of the image the ROIs are related to.
* @param userID The id of the user.
*/
private BatchCall makeLoadCalls(final SecurityContext ctx,
final long imageID, final long userID)
{
return new BatchCall("load ROI From Server") {
public void doCall() throws Exception
{
OmeroImageService svc = context.getImageService();
results = svc.loadROIFromServer(ctx, imageID, userID);
}
};
}
/**
* Adds the {@link #loadCall} to the computation tree.
* @see BatchCallTree#buildTree()
*/
protected void buildTree() { add(loadCall); }
/**
* Returns the root node of the requested tree.
* @see BatchCallTree#getResult()
*/
protected Object getResult() { return results; }
/**
* Creates a new instance.
*
* @param ctx The security context.
* @param imageID The image's ID.
* @param userID The user's ID.
*/
public ServerSideROILoader(SecurityContext ctx, long imageID, long userID)
{
loadCall = makeLoadCalls(ctx, imageID, userID);
}
}