/*
* org.openmicroscopy.shoola.env.ui.ScriptRunner
*
*------------------------------------------------------------------------------
* Copyright (C) 2006-2013 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.ui;
import org.openmicroscopy.shoola.env.config.Registry;
import org.openmicroscopy.shoola.env.data.events.DSCallFeedbackEvent;
import org.openmicroscopy.shoola.env.data.model.ScriptObject;
import omero.gateway.SecurityContext;
import org.openmicroscopy.shoola.env.data.views.CallHandle;
import org.openmicroscopy.shoola.env.data.views.ProcessCallback;
/**
* Runs a script.
*
* @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
* @since 3.0-Beta4
*/
public class ScriptRunner
extends UserNotifierLoader
{
/** Handle to the asynchronous call so that we can cancel it. */
private CallHandle handle;
/** Reference to the script to run. */
private ScriptObject script;
/** The call-back returned by the server. */
private ProcessCallback callBack;
/** Flag indicating that the user cancelled the action.*/
private boolean cancelled;
/**
* Notifies that an error occurred.
* @see UserNotifierLoader#onException(String, Throwable)
*/
protected void onException(String message, Throwable ex)
{
activity.notifyError("Unable to run the script", message, ex);
}
/**
* Creates a new instance.
*
* @param viewer The viewer this data loader is for.
* Mustn't be <code>null</code>.
* @param registry Convenience reference for subclasses.
* @param ctx The security context.
* @param script The script to run.
* @param activity The activity associated to this loader.
*/
public ScriptRunner(UserNotifier viewer, Registry registry,
SecurityContext ctx, ScriptObject script,
ActivityComponent activity)
{
super(viewer, registry, ctx, activity);
if (script == null)
throw new IllegalArgumentException("No script to run.");
this.script = script;
}
/**
* Runs the script.
* @see UserNotifierLoader#load()
*/
public void load()
{
handle = ivView.runScript(ctx, script, this);
}
/**
* Cancels the on-going data retrieval.
* @see UserNotifierLoader#cancel()
*/
public void cancel()
{
cancelled = true;
try {
if (callBack != null) {
callBack.cancel();
activity.onActivityCancelled();
}
} catch (Exception e) {
handleException(e);
}
handle.cancel();
}
/**
* Stores the call-back.
* @see UserNotifierLoader#update(DSCallFeedbackEvent)
*/
public void update(DSCallFeedbackEvent fe)
{
Object o = fe.getPartialResult();
if (o != null) {
if (Boolean.valueOf(false).equals(o)) {
onException(MESSAGE_RUN, null);
} else if (o instanceof ProcessCallback) {
callBack = (ProcessCallback) o;
callBack.setAdapter(this);
activity.onCallBackSet();
if (cancelled) cancel();
}
}
}
/**
* Feeds the result back to the viewer.
* @see UserNotifierLoader#handleResult(Object)
*/
public void handleResult(Object result)
{
if (Boolean.valueOf(false).equals(result)) {
onException(MESSAGE_RUN, null);
} else if (!(result instanceof Boolean)) {
activity.endActivity(result);
}
}
}