/*
*------------------------------------------------------------------------------
* 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;
import java.awt.image.BufferedImage;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;
import org.openmicroscopy.shoola.agents.metadata.view.MetadataViewer;
import org.openmicroscopy.shoola.env.data.events.DSCallFeedbackEvent;
import org.openmicroscopy.shoola.env.data.model.ThumbnailData;
import omero.gateway.SecurityContext;
import org.openmicroscopy.shoola.env.data.views.CallHandle;
import org.openmicroscopy.shoola.util.image.geom.Factory;
import omero.gateway.model.ImageData;
/**
* Loads the thumbnails, one per specified user for a given set of
* pixels. This class calls the <code>loadThumbnails</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 ThumbnailLoader
extends MetadataLoader
{
/** The object the thumbnails are for. */
private ImageData image;
/** Collection of users who viewed the image. */
private Set<Long> userIDs;
/** Handle to the asynchronous call so that we can cancel it. */
private CallHandle handle;
/** The collection of thumbnails. */
private Map<Long, BufferedImage> thumbnails;
/**
* 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 image The image.
* @param userIDs The node of reference. Mustn't be <code>null</code>.
* @param loaderID The identifier of the loader.
*/
public ThumbnailLoader(MetadataViewer viewer, SecurityContext ctx,
ImageData image, Set<Long> userIDs, int loaderID)
{
super(viewer, ctx, loaderID);
this.image = image;
this.userIDs = userIDs;
thumbnails = new HashMap<Long, BufferedImage>();
}
/**
* Retrieves the thumbnails associated to the image for the given users.
* @see EditorLoader#load()
*/
public void load()
{
handle = mhView.loadThumbnails(ctx, image, userIDs,
Factory.THUMB_DEFAULT_WIDTH, Factory.THUMB_DEFAULT_HEIGHT,
this);
}
/**
* Cancels the data loading.
* @see EditorLoader#cancel()
*/
public void cancel() { handle.cancel(); }
/**
* Feeds the thumbnails back to the viewer, as they arrive.
* @see EditorLoader#update(DSCallFeedbackEvent)
*/
public void update(DSCallFeedbackEvent fe)
{
ThumbnailData td = (ThumbnailData) fe.getPartialResult();
if (td != null) {
//Last fe has null object.
thumbnails.put(td.getUserID(), td.getThumbnail());
}
if (thumbnails.size() == userIDs.size())
viewer.setThumbnails(thumbnails, image.getId());
}
/**
* Does nothing as the asynchronous call returns <code>null</code>.
* The actual payload (thumbnails) is delivered progressively
* during the updates.
* @see EditorLoader#handleNullResult()
*/
public void handleNullResult() {}
}