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 -->
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="Score";
21 var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":9};
22 var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/Score.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/data/sequence/RNAStructScoreManager.html" title="class in compbio.data.sequence"><span class="typeNameLink">Prev Class</span></a></li>
53 <li><a href="../../../compbio/data/sequence/ScoreManager.html" title="class in compbio.data.sequence"><span class="typeNameLink">Next Class</span></a></li>
56 <li><a href="../../../index.html?compbio/data/sequence/Score.html" target="_top">Frames</a></li>
57 <li><a href="Score.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>Nested | </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.data.sequence</div>
96 <h2 title="Class Score" class="title">Class Score</h2>
98 <div class="contentContainer">
99 <ul class="inheritance">
100 <li>java.lang.Object</li>
102 <ul class="inheritance">
103 <li>compbio.data.sequence.Score</li>
107 <div class="description">
108 <ul class="blockList">
109 <li class="blockList">
111 <dt>All Implemented Interfaces:</dt>
112 <dd>java.lang.Comparable<<a href="../../../compbio/data/sequence/Score.html" title="class in compbio.data.sequence">Score</a>></dd>
117 public class <span class="typeNameLabel">Score</span>
118 extends java.lang.Object
119 implements java.lang.Comparable<<a href="../../../compbio/data/sequence/Score.html" title="class in compbio.data.sequence">Score</a>></pre>
120 <div class="block">A value class for AACon annotation results storage. The objects of this type
123 <dt><span class="simpleTagLabel">Author:</span></dt>
129 <div class="summary">
130 <ul class="blockList">
131 <li class="blockList">
132 <!-- =========== FIELD SUMMARY =========== -->
133 <ul class="blockList">
134 <li class="blockList"><a name="field.summary">
137 <h3>Field Summary</h3>
138 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
139 <caption><span>Fields</span><span class="tabEnd"> </span></caption>
141 <th class="colFirst" scope="col">Modifier and Type</th>
142 <th class="colLast" scope="col">Field and Description</th>
144 <tr class="altColor">
145 <td class="colFirst"><code>private java.lang.String</code></td>
146 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/Score.html#method">method</a></span></code> </td>
148 <tr class="rowColor">
149 <td class="colFirst"><code>(package private) static java.text.NumberFormat</code></td>
150 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/Score.html#NUMBER_FORMAT">NUMBER_FORMAT</a></span></code> </td>
152 <tr class="altColor">
153 <td class="colFirst"><code>private java.util.TreeSet<<a href="../../../compbio/data/sequence/Range.html" title="class in compbio.data.sequence">Range</a>></code></td>
154 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/Score.html#ranges">ranges</a></span></code> </td>
156 <tr class="rowColor">
157 <td class="colFirst"><code>private java.util.ArrayList<java.lang.Float></code></td>
158 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/Score.html#scores">scores</a></span></code> </td>
163 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
164 <ul class="blockList">
165 <li class="blockList"><a name="constructor.summary">
168 <h3>Constructor Summary</h3>
169 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
170 <caption><span>Constructors</span><span class="tabEnd"> </span></caption>
172 <th class="colFirst" scope="col">Modifier</th>
173 <th class="colLast" scope="col">Constructor and Description</th>
175 <tr class="altColor">
176 <td class="colFirst"><code>private </code></td>
177 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/Score.html#Score--">Score</a></span>()</code> </td>
179 <tr class="rowColor">
180 <td class="colFirst"><code> </code></td>
181 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/Score.html#Score-java.lang.Enum-java.util.ArrayList-">Score</a></span>(java.lang.Enum<?> method,
182 java.util.ArrayList<java.lang.Float> scores)</code>
183 <div class="block">Instantiate the Score</div>
186 <tr class="altColor">
187 <td class="colFirst"><code> </code></td>
188 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/Score.html#Score-java.lang.Enum-java.util.ArrayList-java.util.TreeSet-">Score</a></span>(java.lang.Enum<?> method,
189 java.util.ArrayList<java.lang.Float> scores,
190 java.util.TreeSet<<a href="../../../compbio/data/sequence/Range.html" title="class in compbio.data.sequence">Range</a>> ranges)</code> </td>
192 <tr class="rowColor">
193 <td class="colFirst"><code> </code></td>
194 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/Score.html#Score-java.lang.Enum-float:A-">Score</a></span>(java.lang.Enum<?> method,
195 float[] scores)</code> </td>
197 <tr class="altColor">
198 <td class="colFirst"><code> </code></td>
199 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/Score.html#Score-java.lang.Enum-java.util.TreeSet-">Score</a></span>(java.lang.Enum<?> method,
200 java.util.TreeSet<<a href="../../../compbio/data/sequence/Range.html" title="class in compbio.data.sequence">Range</a>> ranges)</code> </td>
205 <!-- ========== METHOD SUMMARY =========== -->
206 <ul class="blockList">
207 <li class="blockList"><a name="method.summary">
210 <h3>Method Summary</h3>
211 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
212 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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>
214 <th class="colFirst" scope="col">Modifier and Type</th>
215 <th class="colLast" scope="col">Method and Description</th>
217 <tr id="i0" class="altColor">
218 <td class="colFirst"><code>int</code></td>
219 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/Score.html#compareTo-compbio.data.sequence.Score-">compareTo</a></span>(<a href="../../../compbio/data/sequence/Score.html" title="class in compbio.data.sequence">Score</a> o)</code> </td>
221 <tr id="i1" class="rowColor">
222 <td class="colFirst"><code>boolean</code></td>
223 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/Score.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object obj)</code> </td>
225 <tr id="i2" class="altColor">
226 <td class="colFirst"><code>java.lang.String</code></td>
227 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/Score.html#getMethod--">getMethod</a></span>()</code>
228 <div class="block">Returns the ConservationMethod</div>
231 <tr id="i3" class="rowColor">
232 <td class="colFirst"><code>java.util.TreeSet<<a href="../../../compbio/data/sequence/Range.html" title="class in compbio.data.sequence">Range</a>></code></td>
233 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/Score.html#getRanges--">getRanges</a></span>()</code>
234 <div class="block">Return Ranges if any Collections.EMPTY_SET otherwise</div>
237 <tr id="i4" class="altColor">
238 <td class="colFirst"><code>java.util.ArrayList<java.lang.Float></code></td>
239 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/Score.html#getScores--">getScores</a></span>()</code>
240 <div class="block">The column scores for the alignment</div>
243 <tr id="i5" class="rowColor">
244 <td class="colFirst"><code>int</code></td>
245 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/Score.html#hashCode--">hashCode</a></span>()</code> </td>
247 <tr id="i6" class="altColor">
248 <td class="colFirst"><code>void</code></td>
249 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/Score.html#setRanges-java.util.TreeSet-">setRanges</a></span>(java.util.TreeSet<<a href="../../../compbio/data/sequence/Range.html" title="class in compbio.data.sequence">Range</a>> ranges)</code> </td>
251 <tr id="i7" class="rowColor">
252 <td class="colFirst"><code>private java.util.ArrayList<java.lang.Float></code></td>
253 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/Score.html#toList-float:A-">toList</a></span>(float[] values)</code> </td>
255 <tr id="i8" class="altColor">
256 <td class="colFirst"><code>java.lang.String</code></td>
257 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/Score.html#toString--">toString</a></span>()</code> </td>
259 <tr id="i9" class="rowColor">
260 <td class="colFirst"><code>static void</code></td>
261 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/Score.html#write-java.util.TreeSet-java.io.Writer-">write</a></span>(java.util.TreeSet<<a href="../../../compbio/data/sequence/Score.html" title="class in compbio.data.sequence">Score</a>> scores,
262 java.io.Writer writer)</code>
263 <div class="block">Outputs the List of Score objects into the Output stream.</div>
267 <ul class="blockList">
268 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
271 <h3>Methods inherited from class java.lang.Object</h3>
272 <code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
279 <div class="details">
280 <ul class="blockList">
281 <li class="blockList">
282 <!-- ============ FIELD DETAIL =========== -->
283 <ul class="blockList">
284 <li class="blockList"><a name="field.detail">
287 <h3>Field Detail</h3>
288 <a name="NUMBER_FORMAT">
291 <ul class="blockList">
292 <li class="blockList">
293 <h4>NUMBER_FORMAT</h4>
294 <pre>static final java.text.NumberFormat NUMBER_FORMAT</pre>
300 <ul class="blockList">
301 <li class="blockList">
303 <pre>private final java.lang.String method</pre>
309 <ul class="blockList">
310 <li class="blockList">
312 <pre>private java.util.TreeSet<<a href="../../../compbio/data/sequence/Range.html" title="class in compbio.data.sequence">Range</a>> ranges</pre>
318 <ul class="blockListLast">
319 <li class="blockList">
321 <pre>private java.util.ArrayList<java.lang.Float> scores</pre>
326 <!-- ========= CONSTRUCTOR DETAIL ======== -->
327 <ul class="blockList">
328 <li class="blockList"><a name="constructor.detail">
331 <h3>Constructor Detail</h3>
335 <ul class="blockList">
336 <li class="blockList">
338 <pre>private Score()</pre>
341 <a name="Score-java.lang.Enum-java.util.ArrayList-">
344 <ul class="blockList">
345 <li class="blockList">
347 <pre>public Score(java.lang.Enum<?> method,
348 java.util.ArrayList<java.lang.Float> scores)</pre>
349 <div class="block">Instantiate the Score</div>
351 <dt><span class="paramLabel">Parameters:</span></dt>
352 <dd><code>method</code> - the ConservationMethod with which <code>scores</code> were
354 <dd><code>scores</code> - the actual conservation values for each column of the
359 <a name="Score-java.lang.Enum-java.util.ArrayList-java.util.TreeSet-">
362 <ul class="blockList">
363 <li class="blockList">
365 <pre>public Score(java.lang.Enum<?> method,
366 java.util.ArrayList<java.lang.Float> scores,
367 java.util.TreeSet<<a href="../../../compbio/data/sequence/Range.html" title="class in compbio.data.sequence">Range</a>> ranges)</pre>
369 <dt><span class="paramLabel">Parameters:</span></dt>
370 <dd><code>method</code> - the ConservationMethod with which <code>scores</code> were
372 <dd><code>scores</code> - the actual conservation values for each column of the
374 <dd><code>ranges</code> - The set of ranges i.e. parts of the sequence with specific
375 function, usually can be calculated based on scores</dd>
379 <a name="Score-java.lang.Enum-java.util.TreeSet-">
382 <ul class="blockList">
383 <li class="blockList">
385 <pre>public Score(java.lang.Enum<?> method,
386 java.util.TreeSet<<a href="../../../compbio/data/sequence/Range.html" title="class in compbio.data.sequence">Range</a>> ranges)</pre>
389 <a name="Score-java.lang.Enum-float:A-">
392 <ul class="blockListLast">
393 <li class="blockList">
395 <pre>public Score(java.lang.Enum<?> method,
396 float[] scores)</pre>
401 <!-- ============ METHOD DETAIL ========== -->
402 <ul class="blockList">
403 <li class="blockList"><a name="method.detail">
406 <h3>Method Detail</h3>
407 <a name="toList-float:A-">
410 <ul class="blockList">
411 <li class="blockList">
413 <pre>private java.util.ArrayList<java.lang.Float> toList(float[] values)</pre>
416 <a name="getMethod--">
419 <ul class="blockList">
420 <li class="blockList">
422 <pre>public java.lang.String getMethod()</pre>
423 <div class="block">Returns the ConservationMethod</div>
425 <dt><span class="returnLabel">Returns:</span></dt>
426 <dd>the ConservationMethod</dd>
430 <a name="getScores--">
433 <ul class="blockList">
434 <li class="blockList">
436 <pre>public java.util.ArrayList<java.lang.Float> getScores()</pre>
437 <div class="block">The column scores for the alignment</div>
439 <dt><span class="returnLabel">Returns:</span></dt>
440 <dd>the column scores for the alignment</dd>
444 <a name="getRanges--">
447 <ul class="blockList">
448 <li class="blockList">
450 <pre>public java.util.TreeSet<<a href="../../../compbio/data/sequence/Range.html" title="class in compbio.data.sequence">Range</a>> getRanges()</pre>
451 <div class="block">Return Ranges if any Collections.EMPTY_SET otherwise</div>
453 <dt><span class="returnLabel">Returns:</span></dt>
454 <dd>ordered set of Range</dd>
458 <a name="setRanges-java.util.TreeSet-">
461 <ul class="blockList">
462 <li class="blockList">
464 <pre>public void setRanges(java.util.TreeSet<<a href="../../../compbio/data/sequence/Range.html" title="class in compbio.data.sequence">Range</a>> ranges)</pre>
467 <a name="toString--">
470 <ul class="blockList">
471 <li class="blockList">
473 <pre>public java.lang.String toString()</pre>
475 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
476 <dd><code>toString</code> in class <code>java.lang.Object</code></dd>
480 <a name="hashCode--">
483 <ul class="blockList">
484 <li class="blockList">
486 <pre>public int hashCode()</pre>
488 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
489 <dd><code>hashCode</code> in class <code>java.lang.Object</code></dd>
493 <a name="equals-java.lang.Object-">
496 <ul class="blockList">
497 <li class="blockList">
499 <pre>public boolean equals(java.lang.Object obj)</pre>
501 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
502 <dd><code>equals</code> in class <code>java.lang.Object</code></dd>
506 <a name="write-java.util.TreeSet-java.io.Writer-">
509 <ul class="blockList">
510 <li class="blockList">
512 <pre>public static void write(java.util.TreeSet<<a href="../../../compbio/data/sequence/Score.html" title="class in compbio.data.sequence">Score</a>> scores,
513 java.io.Writer writer)
514 throws java.io.IOException</pre>
515 <div class="block">Outputs the List of Score objects into the Output stream. The output
516 format is as follows:
520 #MethodName [comma separated list of ranges] <space separated list of values>
524 #KABAT 0.2 0.3 0.2 0 0.645 0.333 1 1 0 0
525 #SMERFS 0.645 0.333 1 1 0 0 0.2 0.3 0.2 0
526 #COILS 22-33, 44-56 0.121 3.212
530 The maximum precision for values is 3 digits, but can be less.</div>
532 <dt><span class="paramLabel">Parameters:</span></dt>
533 <dd><code>scores</code> - the list of scores to output</dd>
534 <dd><code>writer</code> - </dd>
535 <dt><span class="throwsLabel">Throws:</span></dt>
536 <dd><code>java.io.IOException</code> - if the OutputStream cannot be written into</dd>
537 <dd><code>java.lang.NullPointerException</code> - if the output stream is null</dd>
541 <a name="compareTo-compbio.data.sequence.Score-">
544 <ul class="blockListLast">
545 <li class="blockList">
547 <pre>public int compareTo(<a href="../../../compbio/data/sequence/Score.html" title="class in compbio.data.sequence">Score</a> o)</pre>
549 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
550 <dd><code>compareTo</code> in interface <code>java.lang.Comparable<<a href="../../../compbio/data/sequence/Score.html" title="class in compbio.data.sequence">Score</a>></code></dd>
560 <!-- ========= END OF CLASS DATA ========= -->
561 <!-- ======= START OF BOTTOM NAVBAR ====== -->
562 <div class="bottomNav"><a name="navbar.bottom">
565 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
566 <a name="navbar.bottom.firstrow">
569 <ul class="navList" title="Navigation">
570 <li><a href="../../../overview-summary.html">Overview</a></li>
571 <li><a href="package-summary.html">Package</a></li>
572 <li class="navBarCell1Rev">Class</li>
573 <li><a href="class-use/Score.html">Use</a></li>
574 <li><a href="package-tree.html">Tree</a></li>
575 <li><a href="../../../deprecated-list.html">Deprecated</a></li>
576 <li><a href="../../../index-files/index-1.html">Index</a></li>
577 <li><a href="../../../help-doc.html">Help</a></li>
582 <li><a href="../../../compbio/data/sequence/RNAStructScoreManager.html" title="class in compbio.data.sequence"><span class="typeNameLink">Prev Class</span></a></li>
583 <li><a href="../../../compbio/data/sequence/ScoreManager.html" title="class in compbio.data.sequence"><span class="typeNameLink">Next Class</span></a></li>
586 <li><a href="../../../index.html?compbio/data/sequence/Score.html" target="_top">Frames</a></li>
587 <li><a href="Score.html" target="_top">No Frames</a></li>
589 <ul class="navList" id="allclasses_navbar_bottom">
590 <li><a href="../../../allclasses-noframe.html">All Classes</a></li>
593 <script type="text/javascript"><!--
594 allClassesLink = document.getElementById("allclasses_navbar_bottom");
596 allClassesLink.style.display = "block";
599 allClassesLink.style.display = "none";
605 <ul class="subNavList">
606 <li>Summary: </li>
607 <li>Nested | </li>
608 <li><a href="#field.summary">Field</a> | </li>
609 <li><a href="#constructor.summary">Constr</a> | </li>
610 <li><a href="#method.summary">Method</a></li>
612 <ul class="subNavList">
613 <li>Detail: </li>
614 <li><a href="#field.detail">Field</a> | </li>
615 <li><a href="#constructor.detail">Constr</a> | </li>
616 <li><a href="#method.detail">Method</a></li>
619 <a name="skip.navbar.bottom">
622 <!-- ======== END OF BOTTOM NAVBAR ======= -->