File: MetadataHelper.java

package info (click to toggle)
libjaba-client-java 2.2.0-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, forky, sid, trixie
  • size: 2,052 kB
  • sloc: java: 17,308; makefile: 12
file content (188 lines) | stat: -rw-r--r-- 5,603 bytes parent folder | download
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
/* Copyright (c) 2011 Peter Troshin
 *  
 *  JAva Bioinformatics Analysis Web Services (JABAWS) @version: 2.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.ws.client;

import static compbio.ws.client.Constraints.pseparator;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.net.MalformedURLException;
import java.net.URL;

import compbio.data.msa.Metadata;
import compbio.metadata.Limit;
import compbio.metadata.LimitsManager;
import compbio.metadata.Option;
import compbio.metadata.Preset;
import compbio.metadata.PresetManager;
import compbio.metadata.RunnerConfig;
import compbio.metadata.WrongParameterException;

public class MetadataHelper {

	/**
	 * Returns a list of options supported by web service
	 * 
	 * @param <T>
	 *            web service type
	 * @param msaws
	 *            web service proxy
	 * @return List of options supported by a web service
	 */
	static <T> List<Option<T>> getParametersList(Metadata<T> msaws) {
		assert msaws != null;
		RunnerConfig<T> config = msaws.getRunnerOptions();
		if (config == null) {
			return Collections.emptyList();
		}
		return config.getArguments();
	}

	/**
	 * Returns a list of options supported by web service
	 * 
	 * @param <T>
	 *            web service type
	 * @param msaws
	 *            web service proxy
	 * @param host
	 *            the server URL, as a string
	 * @return List of options supported by a web service
	 */
	static <T> List<Option<T>> getParametersList(Metadata<T> msaws, String host) throws MalformedURLException {
		assert msaws != null;
		RunnerConfig<T> config = msaws.getRunnerOptions();
		if (config == null) {
			return Collections.emptyList();
		}
		List<Option<T>> opts = config.getArguments();
		for (Option<T> o : opts) {
			o.setBasicURL(new URL(host + "/"));
		}
		return opts;
	}

	/**
	 * Returns an objects from which the list of presets supported by web
	 * service <T> can be obtained
	 * 
	 * @param <T>
	 *            web service type
	 * @param msaws
	 *            web service proxy
	 * @return PresetManager, object which operates on presets
	 */
	static <T> PresetManager<T> getPresetList(Metadata<T> msaws) {
		assert msaws != null;
		PresetManager<T> presetman = msaws.getPresets();
		return presetman;
	}

	/**
	 * Returns a list of limits supported by web service Each limit correspond
	 * to a particular preset.
	 * 
	 * @param <T>
	 *            web service type
	 * @param msaws
	 *            web service proxy
	 * @return List of limits supported by a web service
	 */
	static <T> List<Limit<T>> getLimits(Metadata<T> msaws) {
		assert msaws != null;
		LimitsManager<T> lmanger = msaws.getLimits();

		return lmanger != null ? lmanger.getLimits() : null;
	}

	/**
	 * Returns {@code Preset} by its name
	 * 
	 * @see Preset
	 * @param <T>
	 * @param msaws
	 * @param presetName
	 * @return Return a Preset by its optionName
	 */
	static <T> Preset<T> getPreset(Metadata<T> msaws, String presetName) {
		assert presetName != null;
		PresetManager<T> presets = MetadataHelper.getPresetList(msaws);
		if (presets == null) {
			System.out.println("No presets are supported by the service! Ignoring -r directive!");
			return null;
		}
		Preset<T> pre = presets.getPresetByName(presetName);
		if (pre == null) {
			System.out.println("Cannot find preset: " + presetName + " WARN: ignoring -r directive!");
		}
		return pre;
	}

	/**
	 * Converts options supplied via parameters file into {@code Option} objects
	 * 
	 * @param <T>
	 *            web service type
	 * @param params
	 * @param options
	 * @return List of Options of type T
	 */
	static <T> List<Option<T>> processParameters(List<String> params,
			RunnerConfig<T> options) {
		List<Option<T>> chosenOptions = new ArrayList<Option<T>>();
		for (String param : params) {
			String oname = null;
			if (isParameter(param)) {
				oname = getParamName(param);
			} else {
				oname = param;
			}
			Option<T> o = options.getArgumentByOptionName(oname);
			if (o == null) {
				System.out.println("WARN ignoring unsuppoted parameter: " + oname);
				continue;
			}
			if (isParameter(param)) {
				try {
					o.setValue(getParamValue(param));
				} catch (WrongParameterException e) {
					System.out.println("Problem setting value for the parameter: " + param);
					e.printStackTrace();
				}
			}
			chosenOptions.add(o);
		}
		return chosenOptions;
	}

	static String getParamName(String fullName) {
		assert isParameter(fullName);
		return fullName.substring(0, fullName.indexOf(pseparator));
	}

	static String getParamValue(String fullName) {
		assert isParameter(fullName);
		return fullName.substring(fullName.indexOf(pseparator) + 1);
	}

	static boolean isParameter(String param) {
		return param.contains(pseparator);
	}

}