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
|
package de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters;
/*
This file is part of ELKI:
Environment for Developing KDD-Applications Supported by Index-Structures
Copyright (C) 2013
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.OptionID;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.ParameterException;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.UnspecifiedParameterException;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameterization.Parameterization;
/**
* Parameter class for a parameter representing a single object.
*
* It can be parameterized by giving a class name or class to instantiate, or an
* existing instance.
*
* @author Steffi Wanka
* @author Erich Schubert
* @param <C> Class type
*/
public class ObjectParameter<C> extends ClassParameter<C> {
/**
* The instance to use.
*/
private C instance;
/**
* Constructs a class parameter with the given optionID, restriction class,
* and default value.
*
* @param optionID the unique id of the option
* @param restrictionClass the restriction class of this class parameter
* @param defaultValue the default value of this class parameter
*/
public ObjectParameter(OptionID optionID, Class<?> restrictionClass, Class<?> defaultValue) {
super(optionID, restrictionClass, defaultValue);
}
/**
* Constructs a class parameter with the given optionID, restriction class,
* and default value.
*
* @param <T> default value type, to solve generics problems.
* @param optionID the unique id of the option
* @param restrictionClass the restriction class of this class parameter
* @param defaultValue the default instance of this class parameter
*/
public <T extends C> ObjectParameter(OptionID optionID, Class<?> restrictionClass, T defaultValue) {
super(optionID, restrictionClass);
this.instance = defaultValue;
}
/**
* Constructs a class parameter with the given optionID, restriction class,
* and optional flag.
*
* @param optionID the unique id of the option
* @param restrictionClass the restriction class of this class parameter
* @param optional specifies if this parameter is an optional parameter
*/
public ObjectParameter(OptionID optionID, Class<?> restrictionClass, boolean optional) {
super(optionID, restrictionClass, optional);
}
/**
* Constructs a class parameter with the given optionID, and restriction
* class.
*
* @param optionID the unique id of the option
* @param restrictionClass the restriction class of this class parameter
*/
public ObjectParameter(OptionID optionID, Class<?> restrictionClass) {
// It would be nice to be able to use Class<C> here, but this won't work
// with nested Generics:
// * ClassParameter<Foo<Bar>>(optionID, Foo.class) doesn't satisfy Class<C>
// * ClassParameter<Foo<Bar>>(optionID, Foo<Bar>.class) isn't valid
// * ClassParameter<Foo<Bar>>(optionID, (Class<Foo<Bar>>) Foo.class) is an
// invalid cast.
super(optionID, restrictionClass);
}
@SuppressWarnings("unchecked")
@Override
protected Class<? extends C> parseValue(Object obj) throws ParameterException {
if(obj == null) {
throw new UnspecifiedParameterException(this);
}
// does the given objects class fit?
if(restrictionClass.isInstance(obj)) {
return (Class<? extends C>) obj.getClass();
}
return super.parseValue(obj);
}
@SuppressWarnings("unchecked")
@Override
public void setValue(Object obj) throws ParameterException {
// This is a bit hackish. But when given an appropriate instance, keep it.
if(restrictionClass.isInstance(obj)) {
instance = (C) obj;
}
super.setValue(obj);
}
/**
* Returns a string representation of the parameter's type.
*
* @return "<class>"
*/
@Override
public String getSyntax() {
return "<class|object>";
}
/**
* Returns a new instance for the value (i.e., the class name) of this class
* parameter. The instance has the type of the restriction class of this class
* parameter.
* <p/>
* If the Class for the class name is not found, the instantiation is tried
* using the package of the restriction class as package of the class name.
*
* @param config Parameterization
* @return a new instance for the value of this class parameter
*/
@Override
public C instantiateClass(Parameterization config) {
if(instance != null) {
return instance;
}
// NOTE: instance may be null here, when instantiateClass failed.
return instance = super.instantiateClass(config);
}
@Override
public Object getGivenValue() {
if(instance != null) {
return instance;
}
else {
return super.getGivenValue();
}
}
}
|
