org.yawlfoundation.yawl.resourcing.filters

Class AbstractFilter

java.lang.Object

org.yawlfoundation.yawl.resourcing.AbstractSelector

org.yawlfoundation.yawl.resourcing.filters.AbstractFilter

All Implemented Interfaces:

java.lang.Comparable<AbstractSelector>

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

Fields

Modifier and Type	Field and Description
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

Constructors

Constructor and Description
AbstractFilter() Constructors
AbstractFilter(java.lang.String name)
AbstractFilter(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> params)
AbstractFilter(java.lang.String name, java.lang.String description)
AbstractFilter(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
int	getFilterType() **************************************************************************
abstract java.util.Set<Participant>	performFilter(java.util.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)
java.lang.String	toXML()

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

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(java.lang.String name)

AbstractFilter

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

AbstractFilter

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

AbstractFilter

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

Method Detail

getFilterType

public int getFilterType()

**************************************************************************

setFilterType

public void setFilterType(int fType)

toXML

public java.lang.String toXML()

Overrides:

toXML in class AbstractSelector

Returns:

an XML string describing this filter - used by the editor to build the specification XML

performFilter

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