org.yawlfoundation.yawl.resourcing

Class AbstractSelector

java.lang.Object

org.yawlfoundation.yawl.resourcing.AbstractSelector

All Implemented Interfaces:

java.lang.Comparable<AbstractSelector>

Direct Known Subclasses:

AbstractAllocator, AbstractConstraint, AbstractFilter

public abstract class AbstractSelector
extends java.lang.Object
implements java.lang.Comparable<AbstractSelector>

The base class inherited by all of the 'selector' classes :- filters, constraints and allocators.

As well as giving an inherited class a meaningful class name, extending classes need to provide values for: _name --> the class name _displayName --> a 'pretty' name to show to designers/users when required _description --> a user-oriented description of what the extending class does _params --> a set of parameters needed when applying the extending class's 'perform...' method (the param value should be set to null when initialised).

Create Date: 03/08/2007. Last Date: 09/11/2007.

Version:

2.0

Author:

Michael Adams (BPM Group, QUT Australia)

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	_canonicalName
protected java.lang.String	_description
protected java.lang.String	_displayName
protected java.lang.String	_name
protected java.util.Map<java.lang.String,java.lang.String>	_params

Constructor Summary

Constructors

Constructor and Description
AbstractSelector() ****************************************************************************
AbstractSelector(java.lang.String name)
AbstractSelector(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> params)
AbstractSelector(java.lang.String name, java.lang.String desc)
AbstractSelector(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
void	addKey(java.lang.String key) Adds a key - ie.
void	addParam(java.lang.String key, java.lang.String value) Adds a single parameter passed to the selector's parameters
void	addParams(java.util.Map<java.lang.String,java.lang.String> paramMap) Adds (does not replace) the parameters in the map passed to the selectors parameters
int	compareTo(AbstractSelector other)
boolean	equals(java.lang.Object other) AbstractSelectors are considered equal if their canonical names and name fields are equal
protected <T> java.util.Set<T>	evaluate(java.util.List<java.util.Set<T>> setList, java.lang.String expression) Evaluates a list of Sets against an expression.
java.lang.String	getCanonicalName()
java.lang.String	getClassName()
java.lang.String	getDescription()
java.lang.String	getDisplayName()
java.lang.String	getInformation(java.lang.String outerTag) Gets a 'dump' of this selector object as an XML'd String
java.util.Set<java.lang.String>	getKeys()
java.lang.String	getName()
protected java.util.Set<java.lang.String>	getParamKeys()
java.util.Map<java.lang.String,java.lang.String>	getParams()
java.lang.String	getParamValue(java.lang.String key) Retrieves the value of the specified parameter
int	hashCode()
protected <T> java.util.Set<T>	intersection(java.util.Set<T> set1, java.util.Set<T> set2) Performs an intersection over two Sets
void	reconstitute(Element e) Fills the members of this object with values found in an XML description
void	setCanonicalName(java.lang.String name) Stores the full class name of this 'selector'
void	setDescription(java.lang.String desc) Sets the description of this 'selector'
void	setDisplayName(java.lang.String name) Sets the user-friendly display name of this 'selector'
void	setKeyValue(java.lang.String key, java.lang.String value) Sets the value of a key (at specification design time)
void	setName(java.lang.String name) Stores the class name of this 'selector'
void	setParams(java.util.Map<java.lang.String,java.lang.String> paramsMap) Sets (replaces) the parameters with the map passed
java.lang.String	toString()
protected java.lang.String	toXML()
protected <T> java.util.Set<T>	union(java.util.Set<T> set1, java.util.Set<T> set2) Performs an union over two Sets
protected static java.util.Map<java.lang.String,java.lang.String>	unmarshalParams(Element eParams) Unpacks the xml describing the parameters to a HashMap object

Methods inherited from class java.lang.Object

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

Field Detail

_name

protected java.lang.String _name

_canonicalName

protected java.lang.String _canonicalName

_displayName

protected java.lang.String _displayName

_description

protected java.lang.String _description

_params

protected java.util.Map<java.lang.String,java.lang.String> _params

Constructor Detail

AbstractSelector

public AbstractSelector()

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

AbstractSelector

public AbstractSelector(java.lang.String name)

AbstractSelector

public AbstractSelector(java.lang.String name,
                        java.lang.String desc)

AbstractSelector

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

AbstractSelector

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

Method Detail

getParamKeys

protected java.util.Set<java.lang.String> getParamKeys()

Returns:

a Set of parameter names needing values to be used in the performance of the selection

getName

public java.lang.String getName()

Returns:

the name of this selector

getDisplayName

public java.lang.String getDisplayName()

Returns:

the display name of this selector

getDescription

public java.lang.String getDescription()

Returns:

how this selector is described

getKeys

public java.util.Set<java.lang.String> getKeys()

Returns:

a Set of keys (ie. attribute names) for the expected params

getParams

public java.util.Map<java.lang.String,java.lang.String> getParams()

Returns:

a HashMap of parameters of the form [name, value]

getClassName

public java.lang.String getClassName()

Returns:

the name of this selector class

getCanonicalName

public java.lang.String getCanonicalName()

Returns:

the full name of this selector class

getParamValue

public java.lang.String getParamValue(java.lang.String key)

Retrieves the value of the specified parameter

Parameters:

key - the name of the parameter

Returns:

the specified parameter's value

setName

public void setName(java.lang.String name)

Stores the class name of this 'selector'

Parameters:

name - the name to set

setCanonicalName

public void setCanonicalName(java.lang.String name)

Stores the full class name of this 'selector'

Parameters:

name - the name to set

setDisplayName

public void setDisplayName(java.lang.String name)

Sets the user-friendly display name of this 'selector'

Parameters:

name - the name to set

setDescription

public void setDescription(java.lang.String desc)

Sets the description of this 'selector'

Parameters:

desc - the description value to set

setParams

public void setParams(java.util.Map<java.lang.String,java.lang.String> paramsMap)

Sets (replaces) the parameters with the map passed

Parameters:

paramsMap - the new parameter map of the form [name, value] (both Strings)

addParams

public void addParams(java.util.Map<java.lang.String,java.lang.String> paramMap)

Adds (does not replace) the parameters in the map passed to the selectors parameters

Parameters:

paramMap - the new parameter map of the form [name, value] (both Strings)

addParam

public void addParam(java.lang.String key,
                     java.lang.String value)

Adds a single parameter passed to the selector's parameters

Parameters:

key - the name of the parameter

value - the value of the parameter

addKey

public void addKey(java.lang.String key)

Adds a key - ie. an attribute which needs to be assigned a value at design time

Parameters:

key - the attribute name

setKeyValue

public void setKeyValue(java.lang.String key,
                        java.lang.String value)

Sets the value of a key (at specification design time)

Parameters:

key - the attribute name

value - the value to set

equals

public boolean equals(java.lang.Object other)

AbstractSelectors are considered equal if their canonical names and name fields are equal

Overrides:

equals in class java.lang.Object

Parameters:

other - the object to compare to this

Returns:

true if equal

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

compareTo

public int compareTo(AbstractSelector other)

Specified by:

compareTo in interface java.lang.Comparable<AbstractSelector>

evaluate

protected <T> java.util.Set<T> evaluate(java.util.List<java.util.Set<T>> setList,
                                        java.lang.String expression)

Evaluates a list of Sets against an expression. Sets may be unioned (when the expression operator is '|') or intersected (when '&'). Operator precedence is strictly left to right. The number of operators in the expression should be one less than the number of Sets in the List

Type Parameters:

T - the object type contained in each set

Parameters:

setList - the list of sets

expression - the expression containing the operators

Returns:

the resultant final set

intersection

protected <T> java.util.Set<T> intersection(java.util.Set<T> set1,
                                            java.util.Set<T> set2)

Performs an intersection over two Sets

Type Parameters:

T - the object type contained in each set

Parameters:

set1 - Set A

set2 - Set B

Returns:

A Set containing only those members that are present in both A and B

union

protected <T> java.util.Set<T> union(java.util.Set<T> set1,
                                     java.util.Set<T> set2)

Performs an union over two Sets

Type Parameters:

T - the object type contained in each set

Parameters:

set1 - Set A

set2 - Set B

Returns:

A Set containing all the members of A and all the members of B

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toXML

protected java.lang.String toXML()

Returns:

an xml representation of this object's parameters (if any). Used to build the specification xml

unmarshalParams

protected static java.util.Map<java.lang.String,java.lang.String> unmarshalParams(Element eParams)

Unpacks the xml describing the parameters to a HashMap object

Parameters:

eParams -

Returns:

a [key, value] map of the parameters described by the Element

getInformation

public java.lang.String getInformation(java.lang.String outerTag)

Gets a 'dump' of this selector object as an XML'd String

Parameters:

outerTag - a value for the surrounding tag (one of the extended classes)

Returns:

an XML String describing this object

See Also:

reconstitute(Element)

reconstitute

public void reconstitute(Element e)

Fills the members of this object with values found in an XML description

Parameters:

e - a JDOM Element containing the values

See Also:

getInformation(String)