/* 
  File: LayoutTask.java

  Copyright (c) 2006, The Cytoscape Consortium (www.cytoscape.org)

  The Cytoscape Consortium is:
  - Institute for Systems Biology
  - University of California San Diego
  - Memorial Sloan-Kettering Cancer Center
  - Pasteur Institute
  - Agilent Technologies

  This library is free software; you can redistribute it and/or modify it
  under the terms of the GNU Lesser General Public License as published
  by the Free Software Foundation; either version 2.1 of the License, or
  any later version.

  This library 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.  The software and
  documentation provided hereunder is on an "as is" basis, and the
  Institute for Systems Biology and the Whitehead Institute
  have no obligations to provide maintenance, support,
  updates, enhancements or modifications.  In no event shall the
  Institute for Systems Biology and the Whitehead Institute
  be liable to any party for direct, indirect, special,
  incidental or consequential damages, including lost profits, arising
  out of the use of this software and its documentation, even if the
  Institute for Systems Biology and the Whitehead Institute
  have been advised of the possibility of such damage.  See
  the GNU Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public License
  along with this library; if not, write to the Free Software Foundation,
  Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
*/
package cytoscape.layout;

import cytoscape.Cytoscape;
import cytoscape.layout.CyLayoutAlgorithm;
import cytoscape.logger.CyLogger;
import cytoscape.view.CyNetworkView;

import cytoscape.task.Task;
import cytoscape.task.TaskMonitor;

import cytoscape.task.ui.JTaskConfig;

/**
 * A wrapper for applying a layout in a task. Use it something like
 * this:
 * <p>TaskManager.executeTask( new LayoutTask(layout, view), LayoutTask.getDefaultTaskConfig() );

 */
public class LayoutTask implements Task {

	CyLayoutAlgorithm layout;
	CyNetworkView view;
	TaskMonitor monitor;
	CyLogger logger = CyLogger.getLogger(LayoutTask.class);

	/**
	 * Creates the task.
	 * 
	 * @param layout The CyLayoutAlgorithm to apply.
	 * @param view The view the algorithm should be applied to.
	 */
	public LayoutTask(CyLayoutAlgorithm layout,CyNetworkView view) {
		this.layout = layout; 
		this.view = view; 
	}

	/**
	 * Sets the task monitor to be used for the layout. 
	 */
	public void setTaskMonitor(TaskMonitor monitor) {
		this.monitor = monitor;
	}

	/**
	 * Run the algorithm.  
	 */
	public void run() {
		try {
			layout.doLayout(view,monitor);
		} catch (Exception e) {
			String message = "Execution of "+layout.getName()+" did not complete!  Error: "+e.getMessage();
			// Update our monitor, if we have one
			if (monitor != null) {
				monitor.setException(e, message);
				logger.warn(message, e);
			} else {
				logger.error(message, e); // Send to error so the user is sure to see it
			}
		}
	}

	/**
	 * Halt the algorithm if the CyLayoutAlgorithm supports it.
	 */
	public void halt() {
		layout.halt();
	}

	/**
	 * Get the "nice" title of this algorithm
	 *
	 * @return algorithm title
	 */
	public String getTitle() {
		return "Performing " + layout.toString();
	}

	/**
	 * This method returns a default TaskConfig object.
	 * @return a default JTaskConfig object.
	 */
	public static JTaskConfig getDefaultTaskConfig() {
		JTaskConfig result = new JTaskConfig();

		result.displayCancelButton(true);
		result.displayCloseButton(false);
		result.displayStatus(true);
		result.displayTimeElapsed(false);
		result.setAutoDispose(true);
		result.setModal(true);
		result.setOwner(Cytoscape.getDesktop());

		return result;
	}
}