/*
 *------------------------------------------------------------------------------
 *  Copyright (C) 2006-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.env.data.model;

import java.io.File;
import java.util.List;

import javax.swing.Icon;

import org.apache.commons.collections.CollectionUtils;
import org.openmicroscopy.shoola.util.ui.UIUtilities;

/** 
 * Holds the information required to save the images as JPEG, PNG.
 * 
 *
 * @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 SaveAsParam
{

	/** Identifies the <code>Batch Image Export</code> script. */
	public static final String SAVE_AS_SCRIPT = 
		ScriptObject.EXPORT_PATH+"Batch_Image_Export.py";
	
	/** The folder where to save the data. */
	private File folder;
	
	/** The collection of objects to handle. */
	private List<omero.gateway.model.DataObject> objects;
	
	/** One of the constants defined by this class. */
	private int index;
	
    /** The icon associated to the parameters. */
    private Icon icon;
    
    /** Flag to indicate to delete the file after downloading */
    private boolean deleteWhenFinished = false;
    
    /** Filename for the batch export */
    private String batchExportFilename;
    
	/**
	 * Creates a new instance.
	 * 
	 * @param folder The folder where to save the data.
	 * @param objects The collection of objects to handle.
	 */
	public SaveAsParam(File folder, List<omero.gateway.model.DataObject> objects)
	{
		if (CollectionUtils.isEmpty(objects))
			throw new IllegalArgumentException("No objects specified.");
		this.objects = objects;
		if (folder == null) folder = UIUtilities.getDefaultFolder();
		this.folder = folder;
		index = FigureParam.DEFAULT_FORMAT;
	}
	
	/**
	 * Sets the index. If the value is not supported, the default value
	 * is used. 
	 * 
	 * @param index The value to set.
	 */
	public void setIndex(int index)
	{
		if (!FigureParam.FORMATS.containsKey(index))
			index = FigureParam.DEFAULT_FORMAT;
		this.index = index;
	}
	
	/**
	 * Sets the icon associated to the activity.
	 * 
	 * @param icon The value to set.
	 */
	public void setIcon(Icon icon) { this.icon = icon; }
	
	/**
	 * Returns the icon if set or <code>null</code>.
	 * 
	 * @return See above.
	 */
	public Icon getIcon() { return icon; }
	
	/** 
	 * Returns the index, one of the constants defined by this class.
	 * 
	 * @return See above.
	 */
	public int getIndex() { return index; }
	
	/**
	 * Returns the index as a string.
	 * 
	 * @return See above.
	 */
	public String getIndexAsString()
	{
		return FigureParam.FORMATS.get(index);
	}
	
	/**
	 * Returns the folder where to save the data.
	 * 
	 * @return See above.
	 */
	public File getFolder() { return folder; }
	
	/**
	 * Returns the collection of objects to handle.
	 * 
	 * @return See above.
	 */
	public List<omero.gateway.model.DataObject> getObjects() { return objects; }

	/**
	 * Returns <code>true</code> if the the file should
	 * be deleted after downloading
	 * @return See above
	 */
	public boolean isDeleteWhenFinished() {
		return deleteWhenFinished;
	}

	/**
	 * Pass <code>true</code> to delete the file after
	 * downloading
	 * @param deleteWhenFinished See above
	 */
	public void setDeleteWhenFinished(boolean deleteWhenFinished) {
		this.deleteWhenFinished = deleteWhenFinished;
	}

	/**
	 * Get the filename to use for the batch export file
	 * 
	 * @return See above.
	 */
	public String getBatchExportFilename() {
		return batchExportFilename;
	}

	/**
	 * Set the filename to use for the batch export file
	 * 
	 * @param batchExportFilename
	 *            The filename
	 */
	public void setBatchExportFilename(String batchExportFilename) {
		this.batchExportFilename = batchExportFilename;
	}
	
}