blob: 8f67766932cef83e407f767ab9e60bc1f58cda86 (
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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
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) 2011
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 java.util.List;
import java.util.Vector;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.OptionUtil;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.ParameterException;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.WrongParameterValueException;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.Flag;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.Parameter;
/**
* Global parameter constraint specifying that only one parameter of a list of
* parameters ({@link Parameter}) is allowed to be set.
*
* @author Steffi Wanka
*/
public class OnlyOneIsAllowedToBeSetGlobalConstraint implements GlobalParameterConstraint {
/**
* List of parameters to be checked.
*/
private List<Parameter<?, ?>> parameters;
/**
* Constructs a global parameter constraint for testing if only one parameter
* of a list of parameters is set.
*
* @param params list of parameters to be checked
*/
public OnlyOneIsAllowedToBeSetGlobalConstraint(List<Parameter<?, ?>> params) {
parameters = params;
}
/**
* Checks if only one parameter of a list of parameters is set. If not, a
* parameter exception is thrown.
*
*/
@Override
public void test() throws ParameterException {
Vector<String> set = new Vector<String>();
for(Parameter<?, ?> p : parameters) {
if(p.isDefined()) {
// FIXME: Retire the use of this constraint for Flags!
if(p instanceof Flag) {
if (((Flag)p).getValue()) {
set.add(p.getName());
}
} else {
set.add(p.getName());
}
}
}
if(set.size() > 1) {
throw new WrongParameterValueException("Global Parameter Constraint Error.\n" + "Only one of the parameters " + OptionUtil.optionsNamesToString(parameters) + " is allowed to be set. " + "Parameters currently set: " + set.toString());
}
}
@Override
public String getDescription() {
return "Only one of the parameters " + OptionUtil.optionsNamesToString(parameters) + " is allowed to be set.";
}
}
|
