org.yawlfoundation.yawl.resourcing.constraints
Class AbstractConstraint

java.lang.Object
  extended by org.yawlfoundation.yawl.resourcing.AbstractSelector
      extended by org.yawlfoundation.yawl.resourcing.constraints.AbstractConstraint
Direct Known Subclasses:
GenericConstraint, PiledExecution, SeparationOfDuties

public abstract class AbstractConstraint
extends AbstractSelector

The base class for all constraints. Create Date: 03/08/2007. Last Date: 12/11/2007

Version:
2.0
Author:
Michael Adams (BPM Group, QUT Australia)

Field Summary
 
Fields inherited from class org.yawlfoundation.yawl.resourcing.AbstractSelector
_canonicalName, _description, _displayName, _name, _params
 
Constructor Summary
AbstractConstraint()
          Constructors
AbstractConstraint(String name)
           
AbstractConstraint(String name, HashMap<String,String> params)
           
AbstractConstraint(String name, String description)
           
AbstractConstraint(String name, String desc, HashMap<String,String> params)
           
 
Method Summary
abstract  Set<Participant> performConstraint(Set<Participant> resources, WorkItemRecord wir)
          Performs a constraint against the distribution set passed
 String toXML()
          Generates the XML required for the specification file
static AbstractConstraint unmarshal(org.jdom.Element elConstraint)
          Creates a runtime instance of this class from an XML description of it
 
Methods inherited from class org.yawlfoundation.yawl.resourcing.AbstractSelector
addKey, addParam, addParams, getCanonicalName, getClassName, getDescription, getDisplayName, getInformation, getKeys, getName, getParamKeys, getParams, getParamValue, reconstitute, setCanonicalName, setDescription, setDisplayName, setKeyValue, setName, setParams, toString, unmarshalParams
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AbstractConstraint

public AbstractConstraint()
Constructors


AbstractConstraint

public AbstractConstraint(String name)

AbstractConstraint

public AbstractConstraint(String name,
                          HashMap<String,String> params)

AbstractConstraint

public AbstractConstraint(String name,
                          String description)

AbstractConstraint

public AbstractConstraint(String name,
                          String desc,
                          HashMap<String,String> params)
Method Detail

toXML

public String toXML()
Generates the XML required for the specification file

Overrides:
toXML in class AbstractSelector
Returns:
an XML'd String containing the member values of an instantiation of this class

unmarshal

public static AbstractConstraint unmarshal(org.jdom.Element elConstraint)
Creates a runtime instance of this class from an XML description of it

Parameters:
elConstraint - a JDOM Element describing the class
Returns:
the instantiated object

performConstraint

public abstract Set<Participant> performConstraint(Set<Participant> resources,
                                                   WorkItemRecord wir)
Performs a constraint against the distribution set passed

Parameters:
resources - the distribution set of participants
wir - the workitem being resourced
Returns:
the constrined distribution set


Copyright © 2004-2012 The YAWL Foundation.