File: LimitsManager.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 (156 lines) | stat: -rw-r--r-- 4,015 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
/* 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.XmlRootElement;

import compbio.util.Util;

/**
 * A collection of Limits
 * 
 * @see Limit
 * @author pvtroshin
 * 
 * @version 1.0 January 2010
 * @param <T>
 *            executable type
 */
@XmlRootElement(name = "limits")
@XmlAccessorType(XmlAccessType.FIELD)
public class LimitsManager<T> {

	String runnerClassName;
	List<Limit<T>> limit;

	/**
	 * 
	 * @return all limits defined for an executable T
	 */
	public List<Limit<T>> getLimits() {
		return limit;
	}

	@Override
	public String toString() {
		String value = "";
		if (null != limit) {
			for (Limit<T> lim : limit) {
				value += lim.toString();
			}
		}
		return value;
	}

	/**
	 * 
	 * @param presetName
	 * @return Limit defined for the executable T and presetName. If no limit is
	 *         defined for the presetName then default Limit is returned. If
	 *         presetName is empty or null than the default Limit will be
	 *         returned. If not limit defined for the type T than NULL will be
	 *         returned
	 */
	public Limit<T> getLimitByName(String presetName) {
		if (limit == null) {
			return null;
		}
		if (Util.isEmpty(presetName)) {
			// return default limit
			return getDefaultLimit();
		}
		for (Limit<T> lim : limit) {
			String preset = lim.getPreset();
			if (preset == null) {
				continue;
			}
			if (preset.equalsIgnoreCase(presetName)) {
				return lim;
			}
		}
		return null;
	}

	/**
	 * 
	 * @return the default Limit for an executable type T
	 */
	public Limit<T> getDefaultLimit() {
		for (Limit<T> lim : limit) {
			if (lim.isDefault) {
				return lim;
			}
		}
		return null;
	}

	/**
	 * Validate Limits
	 * 
	 * @see Limit
	 * @see Preset
	 * @param presets
	 * @throws ValidationException
	 *             if any of the Limit defined is found to be invalid. That is
	 *             when
	 * 
	 *             1) No default limit is defined
	 * 
	 *             2) More than 1 default limit is defined
	 * 
	 *             3) Limit's preset name does not match any presets for type T
	 */
	public void validate(PresetManager<T> presets) throws ValidationException {
		int defaults = 0;
		for (Limit<T> lim : limit) {
			if (lim.isDefault) {
				defaults++;
			}
		}
		if (defaults == 0) {
			throw new ValidationException("Default limit is not set!");
		}
		if (defaults > 1) {
			throw new ValidationException(
					"Default limit is set more than once!");
		}
		if (presets != null) {
			for (Limit<T> lim : limit) {
				lim.validate();
				String presetName = lim.getPreset();
				// skip "special" preset
				if (presetName != null
						&& !presetName
								.equals(PresetManager.LOCAL_ENGINE_LIMIT_PRESET)) {
					Preset<T> preset = presets.getPresetByName(presetName);
					if (preset == null) {
						throw new ValidationException("Preset " + presetName
								+ " is not found!");
					}
				}
			}
		}
	}

}