de.lmu.ifi.dbs.elki.utilities.optionhandling.constraints
Class DistanceFunctionPatternConstraint

java.lang.Object
  de.lmu.ifi.dbs.elki.utilities.optionhandling.constraints.DistanceFunctionPatternConstraint

All Implemented Interfaces:

ParameterConstraint<String>

public class DistanceFunctionPatternConstraint
extends Object
implements ParameterConstraint<String>

Parameter constraint class for testing if a given pattern parameter (PatternParameter) holds a valid pattern for a specific distance function (DistanceFunction).

Author:

Steffi Wanka

Field Summary

private DistanceFunction<?,?>

distanceFunction The distance function the pattern is checked for.

Constructor Summary

DistanceFunctionPatternConstraint(DistanceFunction<?,?> distFunction)
Constructs a distance function pattern constraint for testing if a given pattern parameter holds a valid pattern for the parameter distFunction

Method Summary

String	getDescription(String parameterName) Returns a description of this constraint.
void	test(String t) Checks if the given pattern parameter holds a valid pattern for the distance function.

Methods inherited from class java.lang.Object

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

Field Detail

distanceFunction

private DistanceFunction<?,?> distanceFunction

The distance function the pattern is checked for.

Constructor Detail

DistanceFunctionPatternConstraint

public DistanceFunctionPatternConstraint(DistanceFunction<?,?> distFunction)

Constructs a distance function pattern constraint for testing if a given pattern parameter holds a valid pattern for the parameter distFunction

Parameters:

distFunction - the distance function the pattern is checked for

Method Detail

test

public void test(String t)
          throws ParameterException

Checks if the given pattern parameter holds a valid pattern for the distance function. If not so, a parameter exception (ParameterException) is thrown.

Specified by:

test in interface ParameterConstraint<String>

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

public String getDescription(String parameterName)

Description copied from interface: ParameterConstraint

Returns a description of this constraint.

Specified by:

getDescription in interface ParameterConstraint<String>

Parameters:

parameterName - the name of the parameter this constraint is used for

Returns:

a description of this constraint