/*
 *------------------------------------------------------------------------------
 *  Copyright (C) 2015 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.fsimporter;



import java.util.List;

import org.openmicroscopy.shoola.agents.fsimporter.util.FileImportComponent;
import org.openmicroscopy.shoola.agents.fsimporter.view.Importer;
import omero.gateway.SecurityContext;
import org.openmicroscopy.shoola.env.data.views.CallHandle;

import omero.gateway.model.ROIData;


/**
 * Saved the roi after import.
 *
 * @author Jean-Marie Burel     
 * <a href="mailto:j.burel@dundee.ac.uk">j.burel@dundee.ac.uk</a>
 * @since 5.0
 */
public class ROISaver
    extends DataImporterLoader
{

    /** Indicates that the rois are being saved.*/
    private static final String SAVING_MESSAGE = "Saving ROIs";

    /** Indicates that the rois have been saved.*/
    private static final String SAVED_MESSAGE = "ROIs Saved";

    /** Indicates that an error occurred while saving rois.*/
    private static final String ERROR_MESSAGE =
            "Error occurred while saving ROIs";

    /** Handle to the asynchronous call so that we can cancel it. */
    private CallHandle handle;

    /** The id of the image the ROIs are related to. */
    private long imageID;

    /** The id of the user. */
    private long userID;

    /** The ROI data to save. */
    private List<ROIData> rois;

    /** The component to use to notify of saving progress.*/
    private FileImportComponent c;

    /**
     * Creates a new instance.
     * 
     * @param viewer The Importer this data loader is for.
     *               Mustn't be <code>null</code>.
     * @param ctx The security context.
     * @param rois The ROI to save.
     * @param imageID The image to link the roi to.
     * @param userID The owner of the rois.
     * @param c The component to update when saving rois.
     */
    public ROISaver(Importer viewer, SecurityContext ctx,
            List<ROIData> rois, long imageID, long userID,
            FileImportComponent c)
    {
        super(viewer, ctx);
        if (imageID < 0) 
            throw new IllegalArgumentException("No image specified.");
        this.imageID = imageID;
        this.userID = userID;
        this.rois = rois;
        this.c = c;
    }

    /** 
     * Starts the import.
     * @see DataImporterLoader#load()
     */
    public void load()
    {
        handle = ivView.saveROI(ctx, imageID, userID, rois , this);
        if (c != null) {
            c.onResultsSaving(SAVING_MESSAGE, true);
        }
    }
 
    /** 
     * Cancels the data loading.
     * @see DataImporterLoader#load()
     */
    public void cancel() { handle.cancel(); }

    /**
     * Feeds the result back to the viewer.
     * @see DataImporterLoader#handleResult(Object)
     */
    public void handleResult(Object result) 
    {
        if (c != null) {
            c.onResultsSaving(SAVED_MESSAGE, false);
        }
    }

    /**
     * Displays message if an error occurred.
     * @see DataImporterLoader#handleException(Throwable)
     */
    public void handleException(Throwable exc)
    {
        super.handleException(exc);
        if (c != null) {
            c.onResultsSaving(ERROR_MESSAGE, false);
        }
    }
}