1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
5 <!-- Generated by javadoc (1.8.0_121) on Fri Apr 21 15:31:59 BST 2017 -->
6 <title>ValueConstrain</title>
7 <meta name="date" content="2017-04-21">
8 <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
9 <script type="text/javascript" src="../../script.js"></script>
12 <script type="text/javascript"><!--
14 if (location.href.indexOf('is-external=true') == -1) {
15 parent.document.title="ValueConstrain";
21 var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10};
22 var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
23 var altColor = "altColor";
24 var rowColor = "rowColor";
25 var tableTab = "tableTab";
26 var activeTableTab = "activeTableTab";
29 <div>JavaScript is disabled on your browser.</div>
31 <!-- ========= START OF TOP NAVBAR ======= -->
32 <div class="topNav"><a name="navbar.top">
35 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
36 <a name="navbar.top.firstrow">
39 <ul class="navList" title="Navigation">
40 <li><a href="../../overview-summary.html">Overview</a></li>
41 <li><a href="package-summary.html">Package</a></li>
42 <li class="navBarCell1Rev">Class</li>
43 <li><a href="class-use/ValueConstrain.html">Use</a></li>
44 <li><a href="package-tree.html">Tree</a></li>
45 <li><a href="../../deprecated-list.html">Deprecated</a></li>
46 <li><a href="../../index-files/index-1.html">Index</a></li>
47 <li><a href="../../help-doc.html">Help</a></li>
52 <li><a href="../../compbio/metadata/UnsupportedRuntimeException.html" title="class in compbio.metadata"><span class="typeNameLink">Prev Class</span></a></li>
53 <li><a href="../../compbio/metadata/ValueConstrain.Type.html" title="enum in compbio.metadata"><span class="typeNameLink">Next Class</span></a></li>
56 <li><a href="../../index.html?compbio/metadata/ValueConstrain.html" target="_top">Frames</a></li>
57 <li><a href="ValueConstrain.html" target="_top">No Frames</a></li>
59 <ul class="navList" id="allclasses_navbar_top">
60 <li><a href="../../allclasses-noframe.html">All Classes</a></li>
63 <script type="text/javascript"><!--
64 allClassesLink = document.getElementById("allclasses_navbar_top");
66 allClassesLink.style.display = "block";
69 allClassesLink.style.display = "none";
75 <ul class="subNavList">
76 <li>Summary: </li>
77 <li><a href="#nested.class.summary">Nested</a> | </li>
78 <li><a href="#field.summary">Field</a> | </li>
79 <li><a href="#constructor.summary">Constr</a> | </li>
80 <li><a href="#method.summary">Method</a></li>
82 <ul class="subNavList">
83 <li>Detail: </li>
84 <li><a href="#field.detail">Field</a> | </li>
85 <li><a href="#constructor.detail">Constr</a> | </li>
86 <li><a href="#method.detail">Method</a></li>
89 <a name="skip.navbar.top">
92 <!-- ========= END OF TOP NAVBAR ========= -->
93 <!-- ======== START OF CLASS DATA ======== -->
95 <div class="subTitle">compbio.metadata</div>
96 <h2 title="Class ValueConstrain" class="title">Class ValueConstrain</h2>
98 <div class="contentContainer">
99 <ul class="inheritance">
100 <li>java.lang.Object</li>
102 <ul class="inheritance">
103 <li>compbio.metadata.ValueConstrain</li>
107 <div class="description">
108 <ul class="blockList">
109 <li class="blockList">
112 <pre>public class <span class="typeNameLabel">ValueConstrain</span>
113 extends java.lang.Object</pre>
114 <div class="block">The type and the lower and upper boundaries for numerical value.</div>
116 <dt><span class="simpleTagLabel">Version:</span></dt>
117 <dd>1.0 November 2009</dd>
118 <dt><span class="simpleTagLabel">Author:</span></dt>
124 <div class="summary">
125 <ul class="blockList">
126 <li class="blockList">
127 <!-- ======== NESTED CLASS SUMMARY ======== -->
128 <ul class="blockList">
129 <li class="blockList"><a name="nested.class.summary">
132 <h3>Nested Class Summary</h3>
133 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
134 <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
136 <th class="colFirst" scope="col">Modifier and Type</th>
137 <th class="colLast" scope="col">Class and Description</th>
139 <tr class="altColor">
140 <td class="colFirst"><code>static class </code></td>
141 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/ValueConstrain.Type.html" title="enum in compbio.metadata">ValueConstrain.Type</a></span></code> </td>
146 <!-- =========== FIELD SUMMARY =========== -->
147 <ul class="blockList">
148 <li class="blockList"><a name="field.summary">
151 <h3>Field Summary</h3>
152 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
153 <caption><span>Fields</span><span class="tabEnd"> </span></caption>
155 <th class="colFirst" scope="col">Modifier and Type</th>
156 <th class="colLast" scope="col">Field and Description</th>
158 <tr class="altColor">
159 <td class="colFirst"><code>(package private) java.lang.String</code></td>
160 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/ValueConstrain.html#max">max</a></span></code> </td>
162 <tr class="rowColor">
163 <td class="colFirst"><code>(package private) java.lang.String</code></td>
164 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/ValueConstrain.html#min">min</a></span></code> </td>
166 <tr class="altColor">
167 <td class="colFirst"><code>(package private) <a href="../../compbio/metadata/ValueConstrain.Type.html" title="enum in compbio.metadata">ValueConstrain.Type</a></code></td>
168 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/ValueConstrain.html#type">type</a></span></code> </td>
173 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
174 <ul class="blockList">
175 <li class="blockList"><a name="constructor.summary">
178 <h3>Constructor Summary</h3>
179 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
180 <caption><span>Constructors</span><span class="tabEnd"> </span></caption>
182 <th class="colOne" scope="col">Constructor and Description</th>
184 <tr class="altColor">
185 <td class="colOne"><code><span class="memberNameLink"><a href="../../compbio/metadata/ValueConstrain.html#ValueConstrain--">ValueConstrain</a></span>()</code> </td>
190 <!-- ========== METHOD SUMMARY =========== -->
191 <ul class="blockList">
192 <li class="blockList"><a name="method.summary">
195 <h3>Method Summary</h3>
196 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
197 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
199 <th class="colFirst" scope="col">Modifier and Type</th>
200 <th class="colLast" scope="col">Method and Description</th>
202 <tr id="i0" class="altColor">
203 <td class="colFirst"><code>(package private) void</code></td>
204 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/ValueConstrain.html#checkValue-java.lang.String-">checkValue</a></span>(java.lang.String value)</code>
205 <div class="block">Validate that the value is within the constrain boundaries</div>
208 <tr id="i1" class="rowColor">
209 <td class="colFirst"><code>boolean</code></td>
210 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/ValueConstrain.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object obj)</code> </td>
212 <tr id="i2" class="altColor">
213 <td class="colFirst"><code>java.lang.Number</code></td>
214 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/ValueConstrain.html#getMax--">getMax</a></span>()</code> </td>
216 <tr id="i3" class="rowColor">
217 <td class="colFirst"><code>java.lang.Number</code></td>
218 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/ValueConstrain.html#getMin--">getMin</a></span>()</code> </td>
220 <tr id="i4" class="altColor">
221 <td class="colFirst"><code><a href="../../compbio/metadata/ValueConstrain.Type.html" title="enum in compbio.metadata">ValueConstrain.Type</a></code></td>
222 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/ValueConstrain.html#getType--">getType</a></span>()</code> </td>
224 <tr id="i5" class="rowColor">
225 <td class="colFirst"><code>int</code></td>
226 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/ValueConstrain.html#hashCode--">hashCode</a></span>()</code> </td>
228 <tr id="i6" class="altColor">
229 <td class="colFirst"><code>(package private) boolean</code></td>
230 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/ValueConstrain.html#hasMaxValue--">hasMaxValue</a></span>()</code> </td>
232 <tr id="i7" class="rowColor">
233 <td class="colFirst"><code>(package private) boolean</code></td>
234 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/ValueConstrain.html#hasMinValue--">hasMinValue</a></span>()</code> </td>
236 <tr id="i8" class="altColor">
237 <td class="colFirst"><code>void</code></td>
238 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/ValueConstrain.html#setMax-java.lang.String-">setMax</a></span>(java.lang.String max)</code> </td>
240 <tr id="i9" class="rowColor">
241 <td class="colFirst"><code>void</code></td>
242 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/ValueConstrain.html#setMin-java.lang.String-">setMin</a></span>(java.lang.String min)</code> </td>
244 <tr id="i10" class="altColor">
245 <td class="colFirst"><code>void</code></td>
246 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/ValueConstrain.html#setType-compbio.metadata.ValueConstrain.Type-">setType</a></span>(<a href="../../compbio/metadata/ValueConstrain.Type.html" title="enum in compbio.metadata">ValueConstrain.Type</a> type)</code> </td>
248 <tr id="i11" class="rowColor">
249 <td class="colFirst"><code>java.lang.String</code></td>
250 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/ValueConstrain.html#toString--">toString</a></span>()</code> </td>
252 <tr id="i12" class="altColor">
253 <td class="colFirst"><code>(package private) void</code></td>
254 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/ValueConstrain.html#validate--">validate</a></span>()</code>
255 <div class="block">Validate the ValueConstrain object.</div>
259 <ul class="blockList">
260 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
263 <h3>Methods inherited from class java.lang.Object</h3>
264 <code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
271 <div class="details">
272 <ul class="blockList">
273 <li class="blockList">
274 <!-- ============ FIELD DETAIL =========== -->
275 <ul class="blockList">
276 <li class="blockList"><a name="field.detail">
279 <h3>Field Detail</h3>
283 <ul class="blockList">
284 <li class="blockList">
286 <pre><a href="../../compbio/metadata/ValueConstrain.Type.html" title="enum in compbio.metadata">ValueConstrain.Type</a> type</pre>
292 <ul class="blockList">
293 <li class="blockList">
295 <pre>java.lang.String max</pre>
301 <ul class="blockListLast">
302 <li class="blockList">
304 <pre>java.lang.String min</pre>
309 <!-- ========= CONSTRUCTOR DETAIL ======== -->
310 <ul class="blockList">
311 <li class="blockList"><a name="constructor.detail">
314 <h3>Constructor Detail</h3>
315 <a name="ValueConstrain--">
318 <ul class="blockListLast">
319 <li class="blockList">
320 <h4>ValueConstrain</h4>
321 <pre>public ValueConstrain()</pre>
326 <!-- ============ METHOD DETAIL ========== -->
327 <ul class="blockList">
328 <li class="blockList"><a name="method.detail">
331 <h3>Method Detail</h3>
335 <ul class="blockList">
336 <li class="blockList">
338 <pre>public <a href="../../compbio/metadata/ValueConstrain.Type.html" title="enum in compbio.metadata">ValueConstrain.Type</a> getType()</pre>
341 <a name="setType-compbio.metadata.ValueConstrain.Type-">
344 <ul class="blockList">
345 <li class="blockList">
347 <pre>public void setType(<a href="../../compbio/metadata/ValueConstrain.Type.html" title="enum in compbio.metadata">ValueConstrain.Type</a> type)</pre>
353 <ul class="blockList">
354 <li class="blockList">
356 <pre>public java.lang.Number getMax()</pre>
359 <a name="setMax-java.lang.String-">
362 <ul class="blockList">
363 <li class="blockList">
365 <pre>public void setMax(java.lang.String max)</pre>
371 <ul class="blockList">
372 <li class="blockList">
374 <pre>public java.lang.Number getMin()</pre>
377 <a name="setMin-java.lang.String-">
380 <ul class="blockList">
381 <li class="blockList">
383 <pre>public void setMin(java.lang.String min)</pre>
386 <a name="equals-java.lang.Object-">
389 <ul class="blockList">
390 <li class="blockList">
392 <pre>public boolean equals(java.lang.Object obj)</pre>
394 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
395 <dd><code>equals</code> in class <code>java.lang.Object</code></dd>
399 <a name="toString--">
402 <ul class="blockList">
403 <li class="blockList">
405 <pre>public java.lang.String toString()</pre>
407 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
408 <dd><code>toString</code> in class <code>java.lang.Object</code></dd>
412 <a name="hashCode--">
415 <ul class="blockList">
416 <li class="blockList">
418 <pre>public int hashCode()</pre>
420 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
421 <dd><code>hashCode</code> in class <code>java.lang.Object</code></dd>
425 <a name="hasMinValue--">
428 <ul class="blockList">
429 <li class="blockList">
431 <pre>boolean hasMinValue()</pre>
434 <a name="hasMaxValue--">
437 <ul class="blockList">
438 <li class="blockList">
440 <pre>boolean hasMaxValue()</pre>
443 <a name="checkValue-java.lang.String-">
446 <ul class="blockList">
447 <li class="blockList">
449 <pre>void checkValue(java.lang.String value)</pre>
450 <div class="block">Validate that the value is within the constrain boundaries</div>
452 <dt><span class="paramLabel">Parameters:</span></dt>
453 <dd><code>value</code> - </dd>
454 <dt><span class="throwsLabel">Throws:</span></dt>
455 <dd><code>java.lang.IndexOutOfBoundsException</code> - when the value is outside the defined boundaries</dd>
459 <a name="validate--">
462 <ul class="blockListLast">
463 <li class="blockList">
465 <pre>void validate()
466 throws javax.xml.bind.ValidationException</pre>
467 <div class="block">Validate the ValueConstrain object. For the ValueConstrain object the
468 type and at least one boundary has to be defined</div>
470 <dt><span class="throwsLabel">Throws:</span></dt>
471 <dd><code>javax.xml.bind.ValidationException</code> - - if the type or no boundaries are defined</dd>
481 <!-- ========= END OF CLASS DATA ========= -->
482 <!-- ======= START OF BOTTOM NAVBAR ====== -->
483 <div class="bottomNav"><a name="navbar.bottom">
486 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
487 <a name="navbar.bottom.firstrow">
490 <ul class="navList" title="Navigation">
491 <li><a href="../../overview-summary.html">Overview</a></li>
492 <li><a href="package-summary.html">Package</a></li>
493 <li class="navBarCell1Rev">Class</li>
494 <li><a href="class-use/ValueConstrain.html">Use</a></li>
495 <li><a href="package-tree.html">Tree</a></li>
496 <li><a href="../../deprecated-list.html">Deprecated</a></li>
497 <li><a href="../../index-files/index-1.html">Index</a></li>
498 <li><a href="../../help-doc.html">Help</a></li>
503 <li><a href="../../compbio/metadata/UnsupportedRuntimeException.html" title="class in compbio.metadata"><span class="typeNameLink">Prev Class</span></a></li>
504 <li><a href="../../compbio/metadata/ValueConstrain.Type.html" title="enum in compbio.metadata"><span class="typeNameLink">Next Class</span></a></li>
507 <li><a href="../../index.html?compbio/metadata/ValueConstrain.html" target="_top">Frames</a></li>
508 <li><a href="ValueConstrain.html" target="_top">No Frames</a></li>
510 <ul class="navList" id="allclasses_navbar_bottom">
511 <li><a href="../../allclasses-noframe.html">All Classes</a></li>
514 <script type="text/javascript"><!--
515 allClassesLink = document.getElementById("allclasses_navbar_bottom");
517 allClassesLink.style.display = "block";
520 allClassesLink.style.display = "none";
526 <ul class="subNavList">
527 <li>Summary: </li>
528 <li><a href="#nested.class.summary">Nested</a> | </li>
529 <li><a href="#field.summary">Field</a> | </li>
530 <li><a href="#constructor.summary">Constr</a> | </li>
531 <li><a href="#method.summary">Method</a></li>
533 <ul class="subNavList">
534 <li>Detail: </li>
535 <li><a href="#field.detail">Field</a> | </li>
536 <li><a href="#constructor.detail">Constr</a> | </li>
537 <li><a href="#method.detail">Method</a></li>
540 <a name="skip.navbar.bottom">
543 <!-- ======== END OF BOTTOM NAVBAR ======= -->