jadex.bpmn.model.MSubProcess Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jadex-model-bpmn Show documentation
Business Process Model and Notation (BPMN) implementation.
There is a newer version: 3.0.117
package jadex.bpmn.model;

import java.util.ArrayList;
import java.util.List;

/**
 *  A sub process represents an activity with and a sub activity flow. 
 */
public class MSubProcess extends MActivity
{
	//-------- constants --------
	
	/** The default subprocess type. */
	public static final String	SUBPROCESSTYPE_NONE	= "none";
	
	/** The parallel subprocess type. */
	public static final String	SUBPROCESSTYPE_PARALLEL	= "parallel";
	
	/** The looping subprocess type. */
	public static final String	SUBPROCESSTYPE_SEQUENTIAL = "sequential";
	
	/** The event subprocess type. */
	public static final String	SUBPROCESSTYPE_EVENT	= "event";
	
	/** The name of the parameter identifying the multi instance iterator. */
	public static final String	MULTIINSTANCE_ITERATOR = "iterator";
	
	//-------- attributes --------
	
	/** The vertices. */
	protected List activities;
	
	/** The sequence edges. */
//	protected List sequenceedges;
	
	/** The artifacts. */
	protected List artifacts;
	
	//-------- added --------
	
	/** The subprocess type (e.g. looping). */
	protected String subprocesstype;
	
//	/** Non-functional hard constraints valid during the subprocess */
//	protected List hardconstraints;
	
	//-------- methods --------
	
	/**
	 *  Get the activities.
	 *  @return The activities.
	 */
	public List getActivities()
	{
		return activities;
	}
	
	/**
	 *  Set the activities.
	 *  @param activities The activities.
	 */
	public void setActivities(List activities)
	{
		this.activities = activities;
	}
	
	/**
	 *  Get the edges.
	 *  @return The edges.
	 */
	public List getEdges()
	{
		List ret = new ArrayList();
		for (MActivity act : activities)
		{
			if (act.getOutgoingDataEdges() != null)
			{
				ret.addAll(act.getOutgoingDataEdges());
			}
			if (act.getOutgoingSequenceEdges() != null)
			{
				ret.addAll(act.getOutgoingSequenceEdges());
			}
			if (act.getOutgoingMessagingEdges() != null)
			{
				ret.addAll(act.getOutgoingMessagingEdges());
			}
		}
		return ret;
	}
	
	/**
	 *  Add an activity.
	 *  @param activity The activity.
	 */ 
	public void addActivity(MActivity activity)
	{
		if(activities==null)
			activities = new ArrayList();
		
		if(activities.contains(activity))
		{
			Thread.dumpStack();
			System.out.println("Duplicate Item:" +activity);
		}
		
		activities.add(activity);
	}
	
	/**
	 *  Remove an activity.
	 *  @param activity The activity. 
	 */
	public void removeActivity(MActivity vertex)
	{
		if(activities!=null)
			activities.remove(vertex);
	}
	
//	/**
//	 *  Add a non-functional hard constraint.
//	 *  @param hardconstraint The constraint.
//	 */ 
//	public void addHardConstraint(MHardConstraint hardconstraint)
//	{
//		if(hardconstraints==null)
//			hardconstraints = new ArrayList();
//		
//		if(hardconstraints.contains(hardconstraint))
//		{
//			Thread.dumpStack();
//			System.out.println("Duplicate Item:" +hardconstraint);
//		}
//		
//		hardconstraints.add(hardconstraint);
//	}
//	
//	/**
//	 *  Remove a non-functional hard constraint.
//	 *  @param hardconstraint The constraint.
//	 */ 
//	public void removeHardConstraint(MHardConstraint hardconstraint)
//	{
//		if(hardconstraints!=null)
//			hardconstraints.remove(hardconstraint);
//	}
//	
//	/**
//	 *  Returns the hard constraints.
//	 *  
//	 *  @return The hard constraints.
//	 */
//	public List getHardConstraints()
//	{
//		return hardconstraints;
//	}
	
	/**
	 *  Get an activity per id.
	 */
	public MActivity getActivity(String id)
	{
		MActivity ret = null;
		if(activities!=null)
		{
			for(MActivity act: activities)
			{
				if(act.getId().equals(id))
				{
					ret = act;
					break;
				}
			}
		}
		return ret;
	}
	
	/**
	 *  Get all start activities of the pool.
	 *  @return A non-empty List of start activities or null, if none.
	 */
	public List getStartActivities()
	{
		return MBpmnModel.getStartActivities(activities);
	}	
	
	/**
	 *  Get the sequence edges.
	 *  @return The sequence edges.
	 */
//	public List getSequenceEdges()
//	{
//		return sequenceedges;
//	}
	
	/**
	 *  Add a sequence edge.
	 *  @param edge The edge.
	 */
//	public void addSequenceEdge(MSequenceEdge edge)
//	{
//		if(sequenceedges==null)
//			sequenceedges = new ArrayList();
//		sequenceedges.add(edge);
//	}
	
	/**
	 *  Remove a sequence edge.
	 *  @param edge The edge.
	 */
//	public void removeSequenceEdge(MSequenceEdge edge)
//	{
//		if(sequenceedges!=null)
//			sequenceedges.remove(edge);
//	}
	
	/**
	 *  Get the artifacts.
	 *  @return The artifacts.
	 */
	public List getArtifacts()
	{
		return artifacts;
	}
	
	/**
	 *  Add an artifact.
	 *  @param artifact The artifact.
	 */
	public void addArtifact(MArtifact artifact)
	{
		if(artifacts==null)
			artifacts = new ArrayList();
		artifacts.add(artifact);
	}
	
	/**
	 *  Remove an artifact.
	 *  @param artifact The artifact.
	 */
	public void removeArtifact(MArtifact artifact)
	{
		if(artifacts!=null)
			artifacts.remove(artifact);
	}
	
	/**
	 *  Get the subprocess type.
	 */
	public String	getSubprocessType()
	{
		return subprocesstype!=null ? subprocesstype : SUBPROCESSTYPE_NONE;
	}
	
	/**
	 *  Set the subprocess type.
	 */
	public void	setSubprocessType(String subprocesstype)
	{
		assert SUBPROCESSTYPE_NONE.equals(subprocesstype)
			|| SUBPROCESSTYPE_PARALLEL.equals(subprocesstype)
			|| SUBPROCESSTYPE_SEQUENTIAL.equals(subprocesstype)
			|| SUBPROCESSTYPE_EVENT.equals(subprocesstype) : subprocesstype+", "+this;

		this.subprocesstype	= subprocesstype;
	}

}