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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
|
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.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import de.lmu.ifi.dbs.elki.logging.LoggingUtil;
import de.lmu.ifi.dbs.elki.utilities.ClassGenericsUtil;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.InternalParameterizationErrors;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.ParameterException;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.constraints.GlobalParameterConstraint;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.Parameter;
/**
* Utility wrapper to track parameters for a configuration session.
*
* All actual Parameterization operations are forwarded to the inner class.
*
* @author Erich Schubert
* @since 0.3
*
* @apiviz.composedOf TrackedParameter
*/
public class TrackParameters implements Parameterization {
/**
* Inner parameterization
*/
Parameterization inner;
/**
* Tracking storage
*/
List<TrackedParameter> options = new ArrayList<>();
/**
* Tree information: parent links
*/
Map<Object, Object> parents = new HashMap<>();
/**
* Tree information: child links
*/
// Implementation note: we need the map to support "null" keys!
Map<Object, List<Object>> children = new HashMap<>();
/**
* Current parent for nested parameterization
*/
Object owner = null;
/**
* Constructor.
*
* @param inner Inner parameterization to wrap.
*/
public TrackParameters(Parameterization inner) {
super();
this.inner = inner;
}
/**
* Constructor.
*
* @param inner Inner parameterization to wrap.
* @param owner Class/instance owning the parameter
*/
public TrackParameters(Parameterization inner, Object owner) {
super();
this.inner = inner;
this.owner = owner;
}
/**
* Internal constructor, for nested tracking.
*
* @param inner Inner parameterization
* @param owner Object owning the current parameters
* @param options List of options
* @param parents Parent map
* @param children Child map
*/
private TrackParameters(Parameterization inner, Object owner, List<TrackedParameter> options, Map<Object, Object> parents, Map<Object, List<Object>> children) {
super();
this.inner = inner.descend(owner);
this.owner = owner;
this.options = options;
this.parents = parents;
this.children = children;
}
@Override
public Collection<ParameterException> getErrors() {
return inner.getErrors();
}
@Override
public boolean hasErrors() {
return inner.hasErrors();
}
@Override
public boolean grab(Parameter<?> opt) {
registerChild(opt);
options.add(new TrackedParameter(owner, opt));
return inner.grab(opt);
}
@Override
public boolean hasUnusedParameters() {
return inner.hasUnusedParameters();
}
@Override
public void reportError(ParameterException e) {
inner.reportError(e);
}
@Override
public boolean setValueForOption(Parameter<?> opt) throws ParameterException {
registerChild(opt);
options.add(new TrackedParameter(owner, opt));
return inner.setValueForOption(opt);
}
/**
* Get all seen parameters, set or unset, along with their owner objects.
*
* @return Parameters seen
*/
public Collection<TrackedParameter> getAllParameters() {
return options;
}
@Override
public boolean checkConstraint(GlobalParameterConstraint constraint) {
return inner.checkConstraint(constraint);
}
/**
* {@inheritDoc}
*
* Track parameters using a shared options list with parent tracker.
*/
@Override
public Parameterization descend(Object option) {
registerChild(option);
return new TrackParameters(inner, option, options, parents, children);
}
private void registerChild(Object opt) {
if(opt == owner) {
LoggingUtil.exception("Options shouldn't have themselves as parents!", new Throwable());
}
parents.put(opt, owner);
List<Object> c = children.get(owner);
if(c == null) {
c = new ArrayList<>();
children.put(owner, c);
}
if(!c.contains(opt)) {
c.add(opt);
}
}
/**
* Traverse the tree upwards.
*
* @param pos Current object
* @return Parent object
*/
public Object getParent(Object pos) {
return parents.get(pos);
}
@Override
public <C> C tryInstantiate(Class<C> r, Class<?> c) {
try {
return ClassGenericsUtil.tryInstantiate(r, c, this);
}
catch(Exception e) {
reportError(new InternalParameterizationErrors("Error instantiating internal class: " + c.getName(), e));
return null;
}
}
@Override
public <C> C tryInstantiate(Class<C> c) {
try {
return ClassGenericsUtil.tryInstantiate(c, c, this);
}
catch(Exception e) {
reportError(new InternalParameterizationErrors("Error instantiating internal class: " + c.getName(), e));
return null;
}
}
}
|
