src/main/java/net/sf/taverna/t2/activities/dataflow/DataflowActivity.java

/*******************************************************************************
 * Copyright (C) 2007 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.activities.dataflow;

import java.util.HashMap;
import java.util.Map;

import net.sf.taverna.t2.facade.FacadeListener;
import net.sf.taverna.t2.facade.ResultListener;
import net.sf.taverna.t2.facade.WorkflowInstanceFacade;
import net.sf.taverna.t2.facade.WorkflowInstanceFacade.State;
import net.sf.taverna.t2.invocation.TokenOrderException;
import net.sf.taverna.t2.invocation.WorkflowDataToken;
import net.sf.taverna.t2.reference.T2Reference;
import net.sf.taverna.t2.workflowmodel.Dataflow;
import net.sf.taverna.t2.workflowmodel.InvalidDataflowException;
import net.sf.taverna.t2.workflowmodel.processor.activity.AbstractAsynchronousActivity;
import net.sf.taverna.t2.workflowmodel.processor.activity.ActivityConfigurationException;
import net.sf.taverna.t2.workflowmodel.processor.activity.AsynchronousActivityCallback;
import net.sf.taverna.t2.workflowmodel.processor.activity.NestedDataflow;

import org.apache.log4j.Logger;

import com.fasterxml.jackson.databind.JsonNode;

/**
 * An Activity providing nested Dataflow functionality.
 *
 * @author David Withers
 */
public class DataflowActivity extends AbstractAsynchronousActivity<JsonNode> implements NestedDataflow {

	public static final String URI = "http://ns.taverna.org.uk/2010/activity/nested-workflow";

	@SuppressWarnings("unused")
	private static final Logger logger = Logger.getLogger(DataflowActivity.class);

	private Dataflow dataflow;

	private JsonNode json;

	@Override
	public void configure(JsonNode json) throws ActivityConfigurationException {
		this.json = json;
//		dataflow.checkValidity();
//		buildInputPorts();
//		buildOutputPorts();
	}

	@Override
	public JsonNode getConfiguration() {
		return json;
	}

	@Override
	public void executeAsynch(final Map<String, T2Reference> data,
			final AsynchronousActivityCallback callback) {
		callback.requestRun(new Runnable() {
			
			Map<String, T2Reference> outputData = new HashMap<String, T2Reference>();

			public void run() {

				final WorkflowInstanceFacade facade;
				try {
					facade = getEdits().createWorkflowInstanceFacade(dataflow, callback.getContext(),
							callback.getParentProcessIdentifier());
				} catch (InvalidDataflowException ex) {
					callback.fail("Invalid workflow", ex);
					return;
				}

				final ResultListener rl = new ResultListener() {


					public void resultTokenProduced(WorkflowDataToken dataToken, String port) {
						if (dataToken.getIndex().length == 0) {
							outputData.put(port, dataToken.getData());
						}
					}
				};
				
				final FacadeListener fl = new FacadeListener() {

					@Override
					public void workflowFailed(WorkflowInstanceFacade facade,
							String message, Throwable t) {
						callback.fail(message, t);
					}

					@Override
					public void stateChange(WorkflowInstanceFacade facade,
							State oldState, State newState) {
						if (newState == State.completed) {
							facade.removeResultListener(rl);
							facade.removeFacadeListener(this);
							callback.receiveResult(outputData, new int[]{});
						}
					}
					
				};
				
				facade.addResultListener(rl);
				facade.addFacadeListener(fl);

				facade.fire();

				for (Map.Entry<String, T2Reference> entry : data.entrySet()) {
					try {
						WorkflowDataToken token = new WorkflowDataToken(callback
								.getParentProcessIdentifier(), new int[] {}, entry.getValue(),
								callback.getContext());
						facade.pushData(token, entry.getKey());
					} catch (TokenOrderException e) {
						callback.fail("Failed to push data into facade", e);
					}
				}

			}

		});
	}

//	private void buildInputPorts() throws ActivityConfigurationException {
//		inputPorts.clear();
//		for (DataflowInputPort dataflowInputPort : dataflow.getInputPorts()) {
//			addInput(dataflowInputPort.getName(), dataflowInputPort.getDepth(), true,
//					new ArrayList<Class<? extends ExternalReferenceSPI>>(), null);
//		}
//	}

//	private void buildOutputPorts() throws ActivityConfigurationException {
//		outputPorts.clear();
//		// granular depth same as depth - no streaming of results
//		for (DataflowOutputPort dataflowOutputPort : dataflow.getOutputPorts()) {
//			addOutput(dataflowOutputPort.getName(), dataflowOutputPort.getDepth(),
//					dataflowOutputPort.getDepth());
//		}
//	}

	public Dataflow getNestedDataflow() {
		return dataflow;
	}

	@Override
	public void setNestedDataflow(Dataflow dataflow) {
		this.dataflow = dataflow;
	}

}