ParameterConstraint (ELKI: Environment for DeveLoping KDD-Applications Supported by Index-Structures)

Type Parameters:

T - the type of the parameter the constraint applies to

All Known Implementing Classes:

AbstractNumberConstraint, GreaterConstraint, GreaterEqualConstraint, LessConstraint, LessEqualConstraint, ListEachNumberConstraint, ListSizeConstraint
```
public interface ParameterConstraint<T>
```
Interface for specifying parameter constraints.
Each class specifying a constraint addressing only one parameter should implement this interface. The constraint value for testing the parameter should be defined as private attribute and should be initialized in the respective constructor of the class, i.e. it is a parameter of the constructor. The proper constraint test should be implemented in the method test(T).

Since:

0.1

Author:

Steffi Wanka

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`java.lang.String`	`getDescription(java.lang.String parameterName)`	Returns a description of this constraint.
`void`	`test(T t)`	Checks if the value `t` of the parameter to be tested fulfills the parameter constraint.

- Method Detail
  - test
```
void test(T t)
   throws ParameterException
```
    Checks if the value t of the parameter to be tested fulfills the parameter constraint. If not, a parameter exception is thrown.
    
    Parameters:
    
    t - Value to be checked whether or not it fulfills the underlying parameter constraint.
    
    Throws:
    
    ParameterException - if the parameter to be tested does not fulfill the parameter constraint
  - getDescription
```
java.lang.String getDescription(java.lang.String parameterName)
```
    Returns a description of this constraint.
    
    Parameters:
    
    parameterName - the name of the parameter this constraint is used for
    
    Returns:
    
    a description of this constraint