/*
*------------------------------------------------------------------------------
* 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 java.util.Iterator;
import java.util.List;
import org.apache.commons.collections.CollectionUtils;
import org.openmicroscopy.shoola.agents.dataBrowser.view.DataBrowser;
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.env.data.views.HierarchyBrowsingView;
import omero.gateway.model.DataObject;
/**
* Loads all thumbnails for the specified images.
* This class calls the <code>loadThumbnails</code> method in the
* <code>HierarchyBrowsingView</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 DataBrowserLoader
{
/**
* Indicates that the thumbnails are associated to an
* <code>ExperimenterData</code>.
*/
public static final int EXPERIMENTER = HierarchyBrowsingView.EXPERIMENTER;
/**
* Indicates that the thumbnails are associated to an <code>FileData</code>.
*/
public static final int FS_FILE = HierarchyBrowsingView.FS_FILE;
/**
* Indicates that the thumbnails are associated to an
* <code>ImageData</code>.
*/
public static final int IMAGE = HierarchyBrowsingView.IMAGE;
/** The number of thumbnails to load. */
private int max;
/**
* The <code>ImageData</code> objects for the images whose thumbnails
* have to be fetched.
*/
private Collection<DataObject> objects;
/**
* Indicates the types of thumbnails to retrieve. One of the constants
* defined by this class.
*/
private int type;
/** Flag indicating to retrieve thumbnail. */
private boolean thumbnail;
/** 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 objects The <code>DataObject</code>s associated to the images
* to fetch. Mustn't be <code>null</code>.
* @param max The maximum number of entries.
*/
public ThumbnailLoader(DataBrowser viewer, SecurityContext ctx,
Collection<DataObject> objects, int type, int max)
{
this(viewer, ctx, objects, true, type, max);
}
/**
* 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 objects The <code>DataObject</code>s associated to the images
* to fetch. Mustn't be <code>null</code>.
* @param max The maximum number of entries.
*/
public ThumbnailLoader(DataBrowser viewer, SecurityContext ctx,
Collection<DataObject> objects, int max)
{
this(viewer, ctx, objects, true, IMAGE, max);
}
/**
* 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 objects The <code>DataObject</code>s associated to the images
* to fetch. Mustn't be <code>null</code>.
* @param thumbnail Pass <code>true</code> to retrieve image at a thumbnail
* size, <code>false</code> otherwise.
* @param type The type of thumbnails to load.
* @param max The maximum number of entries.
*/
public ThumbnailLoader(DataBrowser viewer, SecurityContext ctx,
Collection<DataObject> objects, boolean thumbnail, int type,
int max)
{
super(viewer, ctx);
if (objects == null)
throw new IllegalArgumentException("Collection shouldn't be null.");
if (type < 0) this.type = IMAGE;
else this.type = type;
this.objects = objects;
this.thumbnail = thumbnail;
if (max < objects.size()) max = objects.size();
this.max = max;
}
/**
* Retrieves the thumbnails.
* @see DataBrowserLoader#load()
*/
public void load()
{
long userID = -1;
if (thumbnail)
handle = hiBrwView.loadThumbnails(ctx, objects,
ThumbnailProvider.THUMB_MAX_WIDTH,
ThumbnailProvider.THUMB_MAX_HEIGHT,
userID, type, this);
else
handle = hiBrwView.loadThumbnails(ctx, objects,
3*ThumbnailProvider.THUMB_MAX_WIDTH,
3*ThumbnailProvider.THUMB_MAX_HEIGHT,
userID, type, this);
}
/**
* Cancels the data loading.
* @see DataBrowserLoader#cancel()
*/
public void cancel() { handle.cancel(); }
/**
* Feeds the thumbnails back to the viewer, as they arrive.
* @see DataBrowserLoader#update(DSCallFeedbackEvent)
*/
public void update(DSCallFeedbackEvent fe)
{
if (viewer.getState() == DataBrowser.DISCARDED) return; //Async cancel.
String status = fe.getStatus();
int percDone = fe.getPercentDone();
if (thumbnail) {
if (status == null)
status = (percDone == 100) ? "Done" : //Else
""; //Description wasn't available.
//viewer.setStatus(status, percDone);
ThumbnailData td;
Object ref;
if (type == EXPERIMENTER) {
List<ThumbnailData> l =
(List<ThumbnailData>) fe.getPartialResult();
if (!CollectionUtils.isEmpty(l)) {
Iterator<ThumbnailData> i = l.iterator();
while (i.hasNext()) {
td = i.next();
ref = td.getRefObject();
if (ref == null) ref = td.getImageID();
viewer.setThumbnail(ref, td.getThumbnail(),
td.isValidImage(), max);
}
}
} else {
td = (ThumbnailData) fe.getPartialResult();
if (td != null) {
ref = td.getRefObject();
if (ref == null) ref = td.getImageID();
viewer.setThumbnail(ref, td.getThumbnail(),
td.isValidImage(), max);
}
}
} else {
if (status == null)
status = (percDone == 100) ? "Done" : //Else
""; //Description wasn't available.
viewer.setSlideViewStatus(status, percDone);
ThumbnailData td = (ThumbnailData) fe.getPartialResult();
if (td != null) {
Object ref = td.getRefObject();
if (ref == null) ref = td.getImageID();
viewer.setSlideViewImage(td.getImageID(), td.getThumbnail());
}
}
}
/**
* Does nothing as the asynchronous call returns <code>null</code>.
* The actual pay-load (thumbnails) is delivered progressively
* during the updates.
* @see DataBrowserLoader#handleNullResult()
*/
public void handleNullResult() {}
/** Does nothing.*/
public void onEnd() {}
/**
* Notifies the user that an error has occurred.
* @see DataBrowserLoader#handleException(Throwable)
*/
public void handleException(Throwable exc)
{
String s = "Thumbnail Retrieval Failure: ";
registry.getLogger().error(this, s+exc);
registry.getUserNotifier().notifyError("Thumbnail Retrieval Failure",
s, exc);
}
}