org.yawlfoundation.yawl.resourcing.filters
Class AbstractFilter

java.lang.Object
  extended by org.yawlfoundation.yawl.resourcing.AbstractSelector
      extended by org.yawlfoundation.yawl.resourcing.filters.AbstractFilter
Direct Known Subclasses:
CapabilityFilter, GenericFilter, OrgFilter

public abstract class AbstractFilter
extends AbstractSelector

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

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

Field Summary
protected  int _filterType
           
static int CAPABILITY_FILTER
           
static int HISTORICAL_FILTER
           
static int ORGANISATIONAL_FILTER
           
 
Fields inherited from class org.yawlfoundation.yawl.resourcing.AbstractSelector
_canonicalName, _description, _displayName, _name, _params
 
Constructor Summary
AbstractFilter()
          Constructors
AbstractFilter(String name)
           
AbstractFilter(String name, HashMap<String,String> params)
           
AbstractFilter(String name, String description)
           
AbstractFilter(String name, String desc, HashMap<String,String> params)
           
 
Method Summary
 int getFilterType()
           
abstract  Set<Participant> performFilter(Set<Participant> resources)
          Abstract method, to be implemented by all child classes, which carries out whatever filtering the class has been created to do.
 void setFilterType(int fType)
           
 String toXML()
           
static AbstractFilter unmarshal(org.jdom.Element elFilter)
          Instantiates a filter object (extending from this base class)
 
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
 

Field Detail

ORGANISATIONAL_FILTER

public static final int ORGANISATIONAL_FILTER
See Also:
Constant Field Values

CAPABILITY_FILTER

public static final int CAPABILITY_FILTER
See Also:
Constant Field Values

HISTORICAL_FILTER

public static final int HISTORICAL_FILTER
See Also:
Constant Field Values

_filterType

protected int _filterType
Constructor Detail

AbstractFilter

public AbstractFilter()
Constructors


AbstractFilter

public AbstractFilter(String name)

AbstractFilter

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

AbstractFilter

public AbstractFilter(String name,
                      String description)

AbstractFilter

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

getFilterType

public int getFilterType()

setFilterType

public void setFilterType(int fType)

toXML

public String toXML()
Overrides:
toXML in class AbstractSelector
Returns:
an XML string describing this filter - used by the editor to build the specification XML

unmarshal

public static AbstractFilter unmarshal(org.jdom.Element elFilter)
Instantiates a filter object (extending from this base class)

Parameters:
elFilter - the xml extracted from a spec file describing this filter
Returns:
an instantiated object of 'name' type

performFilter

public abstract Set<Participant> performFilter(Set<Participant> resources)
Abstract method, to be implemented by all child classes, which carries out whatever filtering the class has been created to do.

Parameters:
resources - a distribution set of Participant objects
Returns:
the resultant filtered distribution set


Copyright © 2004-2012 The YAWL Foundation.