blob: c01802bcb05e7ce2ea5df62ac876e4607d1bdc8b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
|
package de.lmu.ifi.dbs.elki.utilities.optionhandling.constraints;
/*
This file is part of ELKI:
Environment for Developing KDD-Applications Supported by Index-Structures
Copyright (C) 2015
Ludwig-Maximilians-Universität München
Lehr- und Forschungseinheit für Datenbanksysteme
ELKI Development Team
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
import de.lmu.ifi.dbs.elki.utilities.optionhandling.ParameterException;
/**
* <p>Interface for specifying global parameter constraints, i.e. constraints addressing
* several parameters.
* </p>
* <p>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 {@link #test()}.
* </p>
* @author Steffi Wanka
*
*/
public interface GlobalParameterConstraint {
/**
* 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.
*/
public abstract void test() throws ParameterException;
/**
* Returns a description of this global constraint.
*
* @return a description of this global constraint
*/
public abstract String getDescription();
}
|
