/*
* org.openmicroscopy.shoola.agents.metadata.ContainersLoader
*
*------------------------------------------------------------------------------
* Copyright (C) 2006-2008 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.metadata;
//Java imports
//Third-party libraries
//Application-internal dependencies
import org.openmicroscopy.shoola.agents.metadata.browser.TreeBrowserSet;
import org.openmicroscopy.shoola.agents.metadata.view.MetadataViewer;
import omero.gateway.SecurityContext;
import org.openmicroscopy.shoola.env.data.views.CallHandle;
/**
* Loads the containers of a given object.
* This class calls one of the <code>loadContainers</code> methods in the
* <code>MetadataHandlerView</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
* <small>
* (<b>Internal version:</b> $Revision: $Date: $)
* </small>
* @since OME3.0
*/
public class ContainersLoader
extends MetadataLoader
{
/** The type of <code>DataObject</code>. */
private Class type;
/** The ID of the parent of the {@link #refNode}. */
private long id;
/** Handle to the asynchronous call so that we can cancel it. */
private CallHandle handle;
/**
* Creates a new instance.
*
* @param viewer The viewer this data loader is for.
* Mustn't be <code>null</code>.
* @param ctx The security context.
* @param refNode The node of reference. Mustn't be <code>null</code>.
* @param type The type of the parent of the {@link #refNode}.
* @param id The ID of the parent of the reference node.
* @param loaderID The identifier of the loader.
*/
public ContainersLoader(MetadataViewer viewer, SecurityContext ctx,
TreeBrowserSet refNode, Class type, long id, int loaderID)
{
super(viewer, ctx, refNode, loaderID);
this.type = type;
this.id = id;
}
/**
* Creates a new instance.
*
* @param viewer The viewer this data loader is for.
* Mustn't be <code>null</code>.
* @param ctx The security context.
* @param type The data type of the edited object.
* @param id The id of the currently edited object.
* @param loaderID The identifier of the loader.
*/
public ContainersLoader(MetadataViewer viewer, SecurityContext ctx,
Class type, long id, int loaderID)
{
super(viewer, ctx, loaderID);
this.type = type;
this.id = id;
}
/**
* Loads the folders containing the object.
* @see MetadataLoader#cancel()
*/
public void load()
{
handle = mhView.loadContainers(ctx, type, id, -1L, this);
}
/**
* Cancels the data loading.
* @see MetadataLoader#cancel()
*/
public void cancel() { handle.cancel(); }
/**
* Feeds the result back to the viewer.
* @see MetadataLoader#handleResult(Object)
*/
public void handleResult(Object result)
{
if (viewer.getState() == MetadataViewer.DISCARDED) return; //Async cancel.
viewer.setContainers(refNode, result);
}
}