/*
*------------------------------------------------------------------------------
* Copyright (C) 2006-2009 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.io.File;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.Map.Entry;
import omero.model.FileAnnotation;
import omero.model.OriginalFile;
import org.openmicroscopy.shoola.agents.metadata.editor.Editor;
import org.openmicroscopy.shoola.env.data.events.DSCallFeedbackEvent;
import omero.gateway.SecurityContext;
import org.openmicroscopy.shoola.env.data.views.CallHandle;
import omero.gateway.model.FileAnnotationData;
/**
* Loads images like PNG, TIFF etc linked to a given object.
*
* @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 3.0-Beta4
*/
public class FileLoader
extends EditorLoader
{
/** The absolute of the new file. */
private File file;
/** The object the thumbnails are for. */
private FileAnnotationData data;
/** The component where to feed the results back to. */
private Object uiView;
/** Handle to the asynchronous call so that we can cancel it. */
private CallHandle handle;
/** The files to load. */
private Map<FileAnnotationData, Object> files;
/** The files to load. */
private Map<FileAnnotationData, File> filesMap;
/**
* 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 data The annotation hosting the file to load.
* @param uiView The object to handle.
*/
public FileLoader(Editor viewer, SecurityContext ctx,
FileAnnotationData data, Object uiView)
{
super(viewer, ctx);
if (data == null)
throw new IllegalArgumentException("No data set.");
this.data = data;
this.uiView = uiView;
file = new File(MetadataViewerAgent.getTmpDir()
+File.separator+data.getFileName());
file.deleteOnExit();
}
/**
* 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 files The files to load.
*/
public FileLoader(Editor viewer, SecurityContext ctx,
Map<FileAnnotationData, Object> files)
{
super(viewer, ctx);
if (files == null)
throw new IllegalArgumentException("No data set.");
this.files = files;
}
/**
* Cancels the data loading.
* @see EditorLoader#cancel()
*/
public void cancel()
{
handle.cancel();
if (file != null) file.delete();
if (filesMap != null) {
Entry<FileAnnotationData, File> entry;
Iterator<Entry<FileAnnotationData, File>>
i = filesMap.entrySet().iterator();
File f;
while (i.hasNext()) {
entry = i.next();
f = entry.getValue();
f.delete();
}
}
}
/**
* Downloads the file.
* @see EditorLoader#cancel()
*/
public void load()
{
if (data != null) {
OriginalFile f = ((FileAnnotation) data.asAnnotation()).getFile();
if (f.isLoaded()) {
handle = mhView.loadFile(ctx, file, f.getId().getValue(), this);
}
} else {
Entry<FileAnnotationData, Object> entry;
Iterator<Entry<FileAnnotationData, Object>>
i = files.entrySet().iterator();
FileAnnotationData fa;
filesMap = new HashMap<FileAnnotationData, File>(files.size());
File f;
//int index = 0;
String dir = MetadataViewerAgent.getTmpDir();
while (i.hasNext()) {
entry = i.next();
fa = entry.getKey();
f = new File(dir+File.separator+fa.getFileID()+"_"+
fa.getFileName());
f.deleteOnExit();
filesMap.put(fa, f);
}
handle = mhView.loadFiles(ctx, filesMap, this);
}
}
/**
* Feeds the file back to the viewer, as they arrive.
* @see EditorLoader#update(DSCallFeedbackEvent)
*/
public void update(DSCallFeedbackEvent fe)
{
if (data == null) {
Map<FileAnnotationData, File> m = (Map<FileAnnotationData, File>)
fe.getPartialResult();
if (m != null) {
Entry<FileAnnotationData, File> entry;
Iterator<Entry<FileAnnotationData, File>>
i = m.entrySet().iterator();
FileAnnotationData fa;
while (i.hasNext()) {
entry = i.next();
fa = entry.getKey();
viewer.setLoadedFile(fa, entry.getValue(), files.get(fa));
}
}
}
}
/**
* Does nothing as the asynchronous call returns <code>null</code>.
* The actual payload is delivered progressively during the updates
* if data is <code>null</code>.
* @see EditorLoader#handleNullResult()
*/
public void handleNullResult()
{
if (data != null)
handleException(new Exception("No data available."));
}
/**
* Feeds the result back to the viewer.
* @see EditorLoader#handleResult(Object)
*/
public void handleResult(Object result)
{
if (data != null) {
viewer.setLoadedFile(data, file, uiView);
} else {
/*
Map m = (Map) result;
Entry entry;
Iterator i = m.entrySet().iterator();
FileAnnotationData fa;
while (i.hasNext()) {
entry = (Entry) i.next();
fa = (FileAnnotationData) entry.getKey();
viewer.setLoadedFile(fa, (File) entry.getValue(),
files.get(fa));
}
*/
}
}
}