taverna-workbench-perspective-design/src/main/java/net/sf/taverna/t2/ui/perspectives/design/WorkflowSelectorComponent.java

/*******************************************************************************
 * Copyright (C) 2012 The University of Manchester
 *
 *  Modifications to the initial code base are copyright of their
 *  respective authors, or their employers as appropriate.
 *
 *  This program 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 (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
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 ******************************************************************************/
package net.sf.taverna.t2.ui.perspectives.design;

import static java.awt.FlowLayout.LEFT;

import java.awt.FlowLayout;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.net.URI;
import java.util.LinkedList;
import java.util.List;

import javax.swing.JButton;
import javax.swing.JLabel;
import javax.swing.JPanel;

import net.sf.taverna.t2.lang.observer.Observable;
import net.sf.taverna.t2.lang.observer.SwingAwareObserver;
import net.sf.taverna.t2.workbench.selection.SelectionManager;
import net.sf.taverna.t2.workbench.selection.events.SelectionManagerEvent;
import net.sf.taverna.t2.workbench.selection.events.WorkflowBundleSelectionEvent;
import net.sf.taverna.t2.workbench.selection.events.WorkflowSelectionEvent;
import uk.org.taverna.scufl2.api.activity.Activity;
import uk.org.taverna.scufl2.api.common.NamedSet;
import uk.org.taverna.scufl2.api.common.Scufl2Tools;
import uk.org.taverna.scufl2.api.configurations.Configuration;
import uk.org.taverna.scufl2.api.container.WorkflowBundle;
import uk.org.taverna.scufl2.api.core.Processor;
import uk.org.taverna.scufl2.api.core.Workflow;
import uk.org.taverna.scufl2.api.profiles.ProcessorBinding;
import uk.org.taverna.scufl2.api.profiles.Profile;

import com.fasterxml.jackson.databind.JsonNode;

/**
 * Component for managing selection of workflows.
 *
 * @author David Withers
 */
@SuppressWarnings("serial")
public class WorkflowSelectorComponent extends JPanel {
	private static final URI NESTED_WORKFLOW_TYPE = URI
			.create("http://ns.taverna.org.uk/2010/activity/nested-workflow");

	private final Scufl2Tools scufl2Tools = new Scufl2Tools();
	private final SelectionManager selectionManager;

	public WorkflowSelectorComponent(SelectionManager selectionManager) {
		super(new FlowLayout(LEFT));
		this.selectionManager = selectionManager;
		update(selectionManager.getSelectedWorkflow());
		selectionManager.addObserver(new SelectionManagerObserver());
	}

	private void update(Workflow workflow) {
		removeAll();
		if (workflow != null
				&& workflow.getParent().getMainWorkflow() != workflow)
			update(workflow, selectionManager.getSelectedProfile());
		revalidate();
		repaint();
	}

	/** @see #update(Workflow) */
	private void update(Workflow workflow, Profile profile) {
		boolean first = true;
		for (final Workflow workflowItem : getPath(
				new NamedSet<>(profile.getActivities()), workflow, profile)) {
			JButton button = new JButton(workflowItem.getName());
//				button.setBorder(null);
			button.addActionListener(new ActionListener() {
				@Override
				public void actionPerformed(ActionEvent e) {
					selectionManager.setSelectedWorkflow(workflowItem);
				}
			});
			if (!first)
				add(new JLabel(">"));
			first = false;
			add(button);
		}
	}

	private List<Workflow> getPath(NamedSet<Activity> activities,
			Workflow workflow, Profile profile) {
		LinkedList<Workflow> path = new LinkedList<>();
		for (Activity activity : activities) {
			if (!activity.getType().equals(NESTED_WORKFLOW_TYPE))
				continue;
			if (getNestedWorkflow(workflow, profile, activity) != workflow)
				continue;

			List<ProcessorBinding> processorBindings = scufl2Tools
					.processorBindingsToActivity(activity);
			for (ProcessorBinding processorBinding : processorBindings) {
				Processor processor = processorBinding.getBoundProcessor();
				Workflow parentWorkflow = processor.getParent();
				if (workflow.getParent().getMainWorkflow() == parentWorkflow)
					path.add(parentWorkflow);
				else {
					activities.remove(activity);
					path.addAll(getPath(activities, parentWorkflow, profile));
				}
				break;
			}
			break;
		}
		path.add(workflow);
		return path;
	}

	private Workflow getNestedWorkflow(Workflow workflow, Profile profile,
			Activity activity) {
		for (Configuration configuration : scufl2Tools.configurationsFor(
				activity, profile)) {
			JsonNode nested = configuration.getJson().get("nestedWorkflow");
			Workflow wf = workflow.getParent().getWorkflows()
					.getByName(nested.asText());
			if (wf != null)
				return wf;
		}
		return null;
	}

	private class SelectionManagerObserver extends
			SwingAwareObserver<SelectionManagerEvent> {
		@Override
		public void notifySwing(Observable<SelectionManagerEvent> sender,
				SelectionManagerEvent message) {
			if (message instanceof WorkflowBundleSelectionEvent)
				bundleSelected((WorkflowBundleSelectionEvent) message);
			else if (message instanceof WorkflowSelectionEvent)
				workflowSelected((WorkflowSelectionEvent) message);
		}
	}

	private void workflowSelected(WorkflowSelectionEvent event) {
		update(event.getSelectedWorkflow());
	}

	private void bundleSelected(WorkflowBundleSelectionEvent event) {
		WorkflowBundle workflowBundle = event.getSelectedWorkflowBundle();
		if (workflowBundle == null)
			update((Workflow) null);
		else
			update(selectionManager.getSelectedWorkflow());
	}
}