org.yawlfoundation.yawl.resourcing.constraints

Class AbstractConstraint

java.lang.Object

org.yawlfoundation.yawl.resourcing.AbstractSelector

org.yawlfoundation.yawl.resourcing.constraints.AbstractConstraint

All Implemented Interfaces:

java.lang.Comparable<AbstractSelector>

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

Constructors

Constructor and Description
AbstractConstraint() Constructors
AbstractConstraint(java.lang.String name)
AbstractConstraint(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> params)
AbstractConstraint(java.lang.String name, java.lang.String description)
AbstractConstraint(java.lang.String name, java.lang.String desc, java.util.Map<java.lang.String,java.lang.String> params)

Method Summary

Modifier and Type	Method and Description
abstract java.util.Set<Participant>	performConstraint(java.util.Set<Participant> resources, WorkItemRecord wir) Performs a constraint against the distribution set passed
java.lang.String	toXML() Generates the XML required for the specification file

Methods inherited from class org.yawlfoundation.yawl.resourcing.AbstractSelector

addKey, addParam, addParams, compareTo, equals, evaluate, getCanonicalName, getClassName, getDescription, getDisplayName, getInformation, getKeys, getName, getParamKeys, getParams, getParamValue, hashCode, intersection, reconstitute, setCanonicalName, setDescription, setDisplayName, setKeyValue, setName, setParams, toString, union, unmarshalParams

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractConstraint

public AbstractConstraint()

Constructors

AbstractConstraint

public AbstractConstraint(java.lang.String name)

AbstractConstraint

public AbstractConstraint(java.lang.String name,
                          java.util.Map<java.lang.String,java.lang.String> params)

AbstractConstraint

public AbstractConstraint(java.lang.String name,
                          java.lang.String description)

AbstractConstraint

public AbstractConstraint(java.lang.String name,
                          java.lang.String desc,
                          java.util.Map<java.lang.String,java.lang.String> params)

Method Detail

toXML

public java.lang.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

performConstraint

public abstract java.util.Set<Participant> performConstraint(java.util.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