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

Interface GlobalParameterConstraint

All Known Implementing Classes:

AllOrNoneMustBeSetGlobalConstraint, EqualSizeGlobalConstraint, GlobalListSizeConstraint, GlobalVectorListElementSizeConstraint, LessEqualGlobalConstraint, LessGlobalConstraint, NoDuplicateValueGlobalConstraint, OneMustBeSetGlobalConstraint, OnlyOneIsAllowedToBeSetGlobalConstraint, ParameterFlagGlobalConstraint

public interface GlobalParameterConstraint

Interface for specifying global parameter constraints, i.e. constraints addressing several parameters.

Each class specifying a global parameter constraint should implement this interface. The parameters to be tested should be defined as private attributes and should be initialized in the respective constructor of the class, i.e. they are parameters of the constructor. The proper constraint test should be implemented in the method test().

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription() Returns a description of this global constraint.
void	test() Checks if the respective parameters satisfy the parameter constraint.

Method Detail

test

void test()
          throws ParameterException

Checks if the respective parameters satisfy the parameter constraint. If not, a parameter exception is thrown.

Throws:

ParameterException - if the parameters don't satisfy the parameter constraint.

getDescription

String getDescription()

Returns a description of this global constraint.

Returns:

a description of this global constraint