trunk/workflowmodel-api/src/main/java/net/sf/taverna/t2/workflowmodel/processor/activity/Activity.java

/*******************************************************************************
 * Copyright (C) 2007-2008 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.workflowmodel.processor.activity;

import static net.sf.taverna.t2.annotation.HierarchyRole.CHILD;

import java.util.Map;
import java.util.Set;

import net.sf.taverna.t2.annotation.Annotated;
import net.sf.taverna.t2.annotation.HierarchyTraversal;
import net.sf.taverna.t2.workflowmodel.OutputPort;
import net.sf.taverna.t2.workflowmodel.Configurable;

/**
 * Defines a single abstract or concrete invokable activity. Each Processor
 * contains at least one of these and may contain many, similarly the dispatch
 * stack may create new Activity instances from e.g. dynamic lookup or resolution
 * of an abstract activity to a concrete activity or set of activities.
 * 
 * @param <ConfigurationType> the ConfigurationType associated with the Activity. This is an arbitrary java class that provides details on how the Activity is configured..
 * @author Tom Oinn
 * 
 */
public interface Activity<ConfigurationType> extends Annotated<Activity<?>>, Configurable<ConfigurationType> {

	
	
	/**
	 * An Activity contains a set of named input ports. Names must be unique
	 * within this set.
	 * 
	 * @return the set of input ports for this activity
	 */
	@HierarchyTraversal(hierarchies = { "workflowStructure" }, role = { CHILD })
	public Set<ActivityInputPort> getInputPorts();

	/**
	 * A processor may have different input port names to the activity or
	 * activities it contains. This map is keyed on the processor input port names
	 * with the corresponding value being the activity port name.
	 * 
	 * @return mapping from processor input port names to activity input port
	 *         names
	 */
	public Map<String, String> getInputPortMapping();

	/**
	 * An Activity contains a set of named output ports. As with input ports names
	 * must be unique within the set.
	 * 
	 * @return
	 */
	@HierarchyTraversal(hierarchies = { "workflowStructure" }, role = { CHILD })
	public Set<OutputPort> getOutputPorts();

	/**
	 * Outputs of the activity may be named differently to those of the
	 * processor. This map is keyed on an activity output port name with each
	 * corresponding value being the processor output port name to which the
	 * activity output is bound.
	 * 
	 * @return mapping from activity output port name to processor output port
	 *         name
	 */
	public Map<String, String> getOutputPortMapping();
	
	/**
	 * {@inheritDoc}
	 */
	public abstract void configure(ConfigurationType conf) throws ActivityConfigurationException;


}