org.protempa

Class AlgorithmParameter

java.lang.Object

org.protempa.AlgorithmParameter

All Implemented Interfaces:

Serializable

public class AlgorithmParameter
extends Object
implements Serializable

Definition of an algorithm parameter.

Author:

Andrew Post

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AlgorithmParameter(String name, ValueComparator[] comparators, ValueType valueType) Defines a parameter.

Method Summary

Modifier and Type	Method and Description
ValueComparator[]	getComparators() Returns the allowed comparators for this parameter.
String	getName() Returns the name of this parameter.
ValueType	getValueType() Returns the type of value of this parameter.
boolean	hasComparator(ValueComparator valueComparator) Returns true if the given value comparator is allowed for this parameter.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AlgorithmParameter

public AlgorithmParameter(String name,
                          ValueComparator[] comparators,
                          ValueType valueType)

Defines a parameter.

Parameters:

name - the name of the parameter.

comparators - the allowed comparators for the parameter.

valueFactory - the allowed types of values for this parameter, one of Value or its subclasses.

Method Detail

getComparators

public ValueComparator[] getComparators()

Returns the allowed comparators for this parameter.

Returns:

an array of ValueComparator objects. Never returns null (but can be length zero).

getName

public String getName()

Returns the name of this parameter.

Returns:

a String.

getValueType

public ValueType getValueType()

Returns the type of value of this parameter.

Returns:

one of ValueFactory or its subclasses.

hasComparator

public boolean hasComparator(ValueComparator valueComparator)

Returns true if the given value comparator is allowed for this parameter.

Parameters:

valueComparator - the value comparator to search for.

Returns:

true if the given value comparator is allowed for this parameter.

toString

public String toString()

Overrides:

toString in class Object