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
|
/* Copyright (c) 2009 Peter Troshin
*
* JAva Bioinformatics Analysis Web Services (JABAWS) @version: 1.0
*
* This library is free software; you can redistribute it and/or modify it under the terms of the
* Apache License version 2 as published by the Apache Software Foundation
*
* This library 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 Apache
* License for more details.
*
* A copy of the license is in apache_license.txt. It is also available here:
* @see: http://www.apache.org/licenses/LICENSE-2.0.txt
*
* Any republication or derived work distributed in source code form
* must include this copyright and license notice.
*/
package compbio.metadata;
import java.util.List;
import javax.xml.bind.ValidationException;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import compbio.util.Util;
/**
* Collection of presets and methods to manipulate them @see {@link Preset}
*
* @author pvtroshin
*
* @version 1.0 December 2009
* @param <T>
* type of executable.
*/
@XmlRootElement(name = "presets")
@XmlAccessorType(XmlAccessType.FIELD)
public class PresetManager<T> {
@XmlElement(required = true)
String runnerClassName;
@XmlElement(required = true)
List<Preset<T>> preset;
public static final String LOCAL_ENGINE_LIMIT_PRESET = "# LocalEngineExecutionLimit #";
public List<Preset<T>> getPresets() {
return preset;
}
public void setPresets(List<Preset<T>> presets) {
this.preset = presets;
}
/**
*
* @return fully qualified class name of type T
*/
public String getRunnerClassName() {
return runnerClassName;
}
public void setRunnerClassName(String runnerClassName) {
this.runnerClassName = runnerClassName;
}
/**
*
* @param presetName
* @return preset by its name, null if no preset found
*/
public Preset<T> getPresetByName(String presetName) {
for (Preset<T> p : preset) {
if (p.getName().equalsIgnoreCase(presetName)) {
return p;
}
}
return null;
}
boolean isComposite(String value) {
assert value != null;
return value.contains(" ");
}
boolean containsValue(List<String> values, String value) {
assert !Util.isEmpty(value);
for (String v : values) {
if (v.equals(value)) {
return true;
}
}
return false;
}
boolean isNumeric(String value) {
assert value != null;
try {
Double.parseDouble(value);
return true;
} catch (NumberFormatException e) {
// ignore
return false;
}
}
/**
* Checks whether preset option and parameter are defined in RunnerConfig
* object.
*
* TODO handle parameters with values properly!
*
* @throws ValidationException
* if preset is found to be invalid.
*
*/
public void validate(RunnerConfig<T> options) throws ValidationException {
for (Preset<T> p : preset) {
if (Util.isEmpty(p.name)) {
throw new ValidationException("Preset name must not be empty!");
}
List<String> optionNames = p.getOptions();
if (optionNames == null || optionNames.size() == 0) {
throw new ValidationException(
"At lease one option must be defined for a preset!");
}
for (String oName : optionNames) {
if (isComposite(oName)) {
String name = oName.split(" ")[0];
Argument<T> arg = getArgument(options, name);
String value = oName.split(" ")[1];
// Ignore numeric values
if (!isNumeric(value)
&& !containsValue(arg.getPossibleValues(), value)) {
throw new ValidationException("Value " + value
+ " is not found in the option " + name);
}
} else {
getArgument(options, oName);
}
}
}
}
Argument<T> getArgument(RunnerConfig<T> options, String optionName)
throws ValidationException {
Argument<T> arg = options.getArgumentByOptionName(optionName);
if (arg == null) {
throw new ValidationException(
"Option "
+ optionName
+ " is not found in the option list (<RunnerName>Parameter.xml file)");
}
return arg;
}
@Override
public String toString() {
String value = "Runner: " + this.runnerClassName + "\n";
for (Preset<T> p : preset) {
value += "##############################################################################\n" + p.toString() + "\n";
}
return value;
}
}
|