blob: 32ab5bdb7033c65a8ac6ae23b035fa303af9e588 (
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
|
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) 2014
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.Collection;
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.ClassParameter;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.Parameter;
/**
* Interface for object parameterizations.
*
* See the {@link de.lmu.ifi.dbs.elki.utilities.optionhandling} package for documentation!
*
* @apiviz.landmark
* @apiviz.uses Parameter
* @apiviz.uses ParameterException
*
* @author Erich Schubert
*/
public interface Parameterization {
/**
* Get the option value from the Parameterization.
*
* Note: this method returns success; the actual value can be obtained from
* {@code opt} itself!
*
* In particular {@link #grab} can return {@code true} when
* {@link de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.Flag#getValue Flag.getValue()}
* returns {@code false}! Instead the semantics of {@code grab} are those of {@code Parameter#isDefined()}.
*
* This method will catch {@link ParameterException}s and store them to be
* retrieved by {@link #getErrors}.
*
* @param opt Option to add
* @return if the value is available (= readable)
*/
public boolean grab(Parameter<?> opt);
/**
* Assign a value for an option, but not using default values and throwing
* exceptions on error.
*
* @param opt Parameter to set
* @return Success code
* @throws ParameterException on assignment errors.
*/
public boolean setValueForOption(Parameter<?> opt) throws ParameterException;
/**
* Get the configuration errors thrown in {@link #grab}
*
* @return Configuration errors encountered
*/
public Collection<ParameterException> getErrors();
/**
* Report a configuration error.
*
* @param e Destination to report errors to
*/
public void reportError(ParameterException e);
/**
* Check for unused parameters
*
* @return {@code true} if at least one parameter was not consumed
*/
public boolean hasUnusedParameters();
/**
* Check a parameter constraint.
*
* @param constraint Parameter constraint
* @return test result
*/
public boolean checkConstraint(GlobalParameterConstraint constraint);
/**
* Descend parameterization tree into sub-option.
*
* Note: this is done automatically by a {@link ClassParameter#instantiateClass}.
* You only need to call this when you want to expose the tree structure
* without offering a class choice as parameter.
*
* @param option Option subtree
* @return Parameterization
*/
public Parameterization descend(Object option);
/**
* Return true when there have been errors.
*
* @return Success code
*/
public boolean hasErrors();
/**
* Try to instantiate a particular class.
*
* @param <C> return type
* @param r Restriction class
* @param c Base class
* @return class instance or null
*/
public <C> C tryInstantiate(Class<C> r, Class<?> c);
/**
* Try to instantiate a particular class.
*
* @param <C> return type
* @param c Base class
* @return class instance or null
*/
public <C> C tryInstantiate(Class<C> c);
}
|
