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
|
package de.lmu.ifi.dbs.elki.utilities.optionhandling;
/*
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 de.lmu.ifi.dbs.elki.utilities.exceptions.AbortException;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameterization.Parameterization;
/**
* Abstract base class that handles the parameterization of a class.
*
* @author Erich Schubert
*
* @apiviz.uses Parameterization
* @apiviz.has de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.Parameter
* @apiviz.excludeSubtypes
*/
public abstract class AbstractParameterizer implements Parameterizer {
/**
* Constant for "fresh" state
*/
private static final int STATE_FRESH = 0;
/**
* Constant for "initializing" state
*/
private static final int STATE_INIT = 1;
/**
* Constant for "complete" state
*/
private static final int STATE_COMPLETE = 2;
/**
* Constant for "errors" state
*/
private static final int STATE_ERRORS = -1;
/**
* Parameterization state.
*/
private int state = STATE_FRESH;
/**
* Add all options.
*
* <b>ALWAYS call super.makeOptions(config), unless you have a strong reason
* to do otherwise!</b>
*
* @param config Parameterization to add options to.
*/
protected void makeOptions(Parameterization config) {
// Nothing to do here.
}
// TODO: remove
@Override
public final void configure(Parameterization config) {
makeOptions(config);
}
/**
* Make an instance after successful configuration.
*
* @return instance
*/
abstract protected Object makeInstance();
/**
* Method to configure a class, then instantiate when the configuration step
* was successful.
*
* <b>Don't call this directly use unless you know what you are doing. <br />
* Instead, use {@link Parameterization#tryInstantiate(Class)}!</b>
*
* Otherwise, {@code null} will be returned, and the resulting errors can be
* retrieved from the {@link Parameterization} parameter object. In general,
* you should be checking the {@link Parameterization} object for errors
* before accessing the returned value, since it may be {@code null}
* unexpectedly otherwise.
*
* @param config Parameterization
* @return Instance or {@code null}
*/
public final Object make(Parameterization config) {
if(state != STATE_FRESH) {
throw new AbortException("Parameterizers may only be set up once!");
}
state = STATE_INIT;
Object owner = this.getClass().getDeclaringClass();
if(owner == null) {
owner = this;
}
config = config.descend(owner);
makeOptions(config);
if(!config.hasErrors()) {
state = STATE_COMPLETE;
Object ret = makeInstance();
if(ret == null) {
throw new AbortException("makeInstance() returned null!", new Throwable());
}
return ret;
}
else {
state = STATE_ERRORS;
return null;
}
}
}
|
