blob: 2837983d595428ad7160d139a854d837db2ba61e (
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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
|
package de.lmu.ifi.dbs.elki.utilities.optionhandling.parameterization;
/*
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 java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import de.lmu.ifi.dbs.elki.logging.LoggingUtil;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.NoParameterValueException;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.ParameterException;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.Flag;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.Parameter;
/**
* Manage a parameterization serialized as String array, e.g. from command line.
*
* When building parameter lists, use {@link ListParameterization} where possible.
*
* @author Erich Schubert
* @since 0.3
*/
public class SerializedParameterization extends AbstractParameterization {
/**
* Prefix of option markers on the command line.
* <p/>
* The option markers are supposed to be given on the command line with
* leading -.
*/
public static final String OPTION_PREFIX = "-";
/**
* Parameter storage
*/
LinkedList<String> parameters = null;
/**
* Constructor
*/
public SerializedParameterization() {
super();
parameters = new LinkedList<>();
}
/**
* Constructor
*
* @param args Parameters
*/
public SerializedParameterization(String[] args) {
this();
for (String arg : args) {
parameters.add(arg);
}
}
/**
* Constructor
*
* @param args Parameter list
*/
public SerializedParameterization(List<String> args) {
this();
parameters.addAll(args);
}
/**
* Return the yet unused parameters.
*
* @return Unused parameters.
*/
public List<String> getRemainingParameters() {
return parameters;
}
@Override
public boolean hasUnusedParameters() {
return (parameters.size() > 0);
}
/**
* Log a warning if there were unused parameters.
*/
public void logUnusedParameters() {
if(hasUnusedParameters()) {
LoggingUtil.warning("The following parameters were not processed: " + parameters);
}
}
@Override
public boolean setValueForOption(Parameter<?> opt) throws ParameterException {
Iterator<String> piter = parameters.iterator();
while(piter.hasNext()) {
String cur = piter.next();
if(!cur.startsWith(OPTION_PREFIX)) {
continue;
// throw new NoParameterValueException(cur + " is no parameter!");
}
// get the option without the option prefix -
String noPrefixOption = cur.substring(OPTION_PREFIX.length());
if(opt.getName().equals(noPrefixOption)) {
// Consume.
piter.remove();
// check if the option is a parameter or a flag
if(opt instanceof Flag) {
String set = Flag.SET;
// The next element must be a parameter
if(piter.hasNext()) {
String next = piter.next();
if(Flag.SET.equals(next)) {
set = Flag.SET;
piter.remove();
}
else if(Flag.NOT_SET.equals(next)) {
set = Flag.NOT_SET;
piter.remove();
}
else if(!next.startsWith(OPTION_PREFIX)) {
throw new NoParameterValueException("Flag " + opt.getName() + " requires no parameter-value! " + "(read parameter-value: " + next + ")");
}
// We do not consume the next if it's not for us ...
}
// set the Flag
opt.setValue(set);
return true;
}
else {
// Ensure there is a potential value for this parameter
if(!piter.hasNext()) {
throw new NoParameterValueException("Parameter " + opt.getName() + " requires a parameter value!");
}
opt.setValue(piter.next());
// Consume parameter
piter.remove();
// Success - return.
return true;
}
}
}
return false;
}
/** {@inheritDoc}
* Default implementation, for flat parameterizations.
*/
@Override
public Parameterization descend(Object option) {
return this;
}
}
|