/*
*------------------------------------------------------------------------------
* Copyright (C) 2006 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.agents.treeviewer;
import java.util.List;
import org.openmicroscopy.shoola.agents.treeviewer.view.TreeViewer;
import omero.gateway.SecurityContext;
import org.openmicroscopy.shoola.env.data.views.CallHandle;
import omero.gateway.model.DataObject;
import omero.gateway.model.DatasetData;
import omero.gateway.model.GroupData;
import omero.gateway.model.ProjectData;
/**
* Loads existing objects of a given type.
* This class calls one of the <code>loadExistingObjects</code> method in the
* <code>DataManagerView</code>.
*
* @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 OME2.2
*/
public class ExistingObjectsLoader
extends DataTreeViewerLoader
{
/** The node the objects are added to. */
private DataObject ho;
/** Handle to the asynchronous call so that we can cancel it. */
private CallHandle handle;
/**
* Controls if the passed object is supported.
*
* @param o The object to control.
*/
private void checkObject(DataObject o)
{
if (o instanceof DatasetData || o instanceof ProjectData ||
o instanceof GroupData)
return;
throw new IllegalArgumentException("Data type not supported.");
}
/**
* Creates a new instance.
*
* @param viewer The TreeViewer this data loader is for.
* Mustn't be <code>null</code>.
* @param ctx The security context.
* @param ho The object the nodes has to be added to.
*/
public ExistingObjectsLoader(TreeViewer viewer, SecurityContext ctx,
DataObject ho)
{
super(viewer, ctx);
checkObject(ho);
this.ho = ho;
}
/**
* Retrieves the available objects.
* @see DataTreeViewerLoader#load()
*/
public void load()
{
if (ho instanceof GroupData) {
handle = adminView.loadExperimenters(ctx, -1, this);
}
}
/**
* Cancels the data loading.
* @see DataTreeViewerLoader#cancel()
*/
public void cancel() { handle.cancel(); }
/**
* Feeds the result back to the viewer.
* @see DataTreeViewerLoader#handleResult(Object)
*/
public void handleResult(Object result)
{
if (viewer.getState() == TreeViewer.DISCARDED) return; //Async cancel.
viewer.setExistingObjects((List) result);
}
}