/*
*------------------------------------------------------------------------------
* 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.dataBrowser;
import java.util.Collection;
import org.openmicroscopy.shoola.agents.dataBrowser.view.DataBrowser;
import omero.gateway.SecurityContext;
import org.openmicroscopy.shoola.env.data.views.CallHandle;
import omero.gateway.model.TagAnnotationData;
/**
* Loads the available tags owned by the currently logged in user.
* This class calls the <code>loadExistingAnnotations</code> method 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
* @since OME3.0
*/
public class TagsLoader
extends DataBrowserLoader
{
/** Handle to the asynchronous call so that we can cancel it. */
private CallHandle handle;
/**
* Flag indicating to load all annotations available or
* to only load the user's annotation.
*/
private boolean loadAll;
/**
* 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 loadAll Pass <code>true</code> indicating to load all
* annotations available if the user can annotate,
* <code>false</code> to only load the user's annotation.
*/
public TagsLoader(DataBrowser viewer, SecurityContext ctx, boolean loadAll)
{
super(viewer, ctx);
this.loadAll = loadAll;
}
/**
* Cancels the data loading.
* @see DataBrowserLoader#cancel()
*/
public void cancel() { handle.cancel(); }
/** Overridden so the status is not displayed. */
public void onEnd() {}
/**
* Loads the tags for the specified nodes.
* @see DataBrowserLoader#load()
*/
public void load()
{
long userID = getCurrentUser();
if (loadAll) userID = -1;
handle = mhView.loadExistingAnnotations(ctx, TagAnnotationData.class,
userID, this);
}
/**
* Feeds the result back to the viewer.
* @see DataBrowserLoader#handleResult(Object)
*/
public void handleResult(Object result)
{
if (viewer.getState() == DataBrowser.DISCARDED) return; //Async cancel.
viewer.setExistingTags((Collection) result);
}
}