diff options
Diffstat (limited to 'src/de/lmu/ifi/dbs/elki/utilities/optionhandling/constraints/NoDuplicateValueGlobalConstraint.java')
-rw-r--r-- | src/de/lmu/ifi/dbs/elki/utilities/optionhandling/constraints/NoDuplicateValueGlobalConstraint.java | 92 |
1 files changed, 92 insertions, 0 deletions
diff --git a/src/de/lmu/ifi/dbs/elki/utilities/optionhandling/constraints/NoDuplicateValueGlobalConstraint.java b/src/de/lmu/ifi/dbs/elki/utilities/optionhandling/constraints/NoDuplicateValueGlobalConstraint.java new file mode 100644 index 00000000..cb5426d0 --- /dev/null +++ b/src/de/lmu/ifi/dbs/elki/utilities/optionhandling/constraints/NoDuplicateValueGlobalConstraint.java @@ -0,0 +1,92 @@ +package de.lmu.ifi.dbs.elki.utilities.optionhandling.constraints; +/* +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 java.util.Arrays; +import java.util.HashSet; +import java.util.List; +import java.util.Set; + +import de.lmu.ifi.dbs.elki.utilities.optionhandling.OptionUtil; +import de.lmu.ifi.dbs.elki.utilities.optionhandling.ParameterException; +import de.lmu.ifi.dbs.elki.utilities.optionhandling.WrongParameterValueException; +import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.NumberParameter; +import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.Parameter; + +/** + * Global parameter constraint specifying that parameters of a list of number + * parameters ({@link NumberParameter}) are not allowed to have the same value. + * + * @author Steffi Wanka + */ +public class NoDuplicateValueGlobalConstraint implements GlobalParameterConstraint { + /** + * List of number parameters to be checked. + */ + private List<? extends Parameter<?, ?>> parameters; + + /** + * Constructs a Not-Equal-Value global parameter constraint. That is, the + * elements of a list of number parameters are not allowed to have equal + * values. + * + * @param parameters list of number parameters to be tested + */ + public NoDuplicateValueGlobalConstraint(List<? extends Parameter<?, ?>> parameters) { + this.parameters = parameters; + } + + /** + * Constructs a Not-Equal-Value global parameter constraint. That is, the + * elements of a list of number parameters are not allowed to have equal + * values. + * + * @param parameters list of number parameters to be tested + */ + public NoDuplicateValueGlobalConstraint(Parameter<?, ?>... parameters) { + this.parameters = Arrays.asList(parameters); + } + + /** + * Checks if the elements of the list of number parameters do have different + * values. If not, a parameter exception is thrown. + * + */ + @Override + public void test() throws ParameterException { + Set<Object> numbers = new HashSet<Object>(); + + for(Parameter<?, ?> param : parameters) { + if(param.isDefined()) { + if(!numbers.add(param.getValue())) { + throw new WrongParameterValueException("Global Parameter Constraint Error:\n" + "Parameters " + OptionUtil.optionsNamesToString(parameters) + " must have different values. Current values: " + OptionUtil.parameterNamesAndValuesToString(parameters) + ".\n"); + } + } + } + } + + @Override + public String getDescription() { + return "Parameters " + OptionUtil.optionsNamesToString(parameters) + " must have different values."; + } +}
\ No newline at end of file |