1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
\r
5 <!-- Generated by javadoc (build 1.6.0_21) on Tue Dec 21 18:32:58 GMT 2010 -->
\r
10 <META NAME="date" CONTENT="2010-12-21">
\r
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
\r
14 <SCRIPT type="text/javascript">
\r
15 function windowTitle()
\r
17 if (location.href.indexOf('is-external=true') == -1) {
\r
18 parent.document.title="Score";
\r
27 <BODY BGCOLOR="white" onload="windowTitle();">
\r
31 <!-- ========= START OF TOP NAVBAR ======= -->
\r
32 <A NAME="navbar_top"><!-- --></A>
\r
33 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
\r
34 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
36 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
37 <A NAME="navbar_top_firstrow"><!-- --></A>
\r
38 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
39 <TR ALIGN="center" VALIGN="top">
\r
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
42 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Score.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
\r
44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
51 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
58 <A HREF="../../../compbio/data/sequence/Program.html" title="enum in compbio.data.sequence"><B>PREV CLASS</B></A>
\r
59 <A HREF="../../../compbio/data/sequence/SequenceUtil.html" title="class in compbio.data.sequence"><B>NEXT CLASS</B></A></FONT></TD>
\r
60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
61 <A HREF="../../../index.html?compbio/data/sequence/Score.html" target="_top"><B>FRAMES</B></A>
\r
62 <A HREF="Score.html" target="_top"><B>NO FRAMES</B></A>
\r
63 <SCRIPT type="text/javascript">
\r
66 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
71 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
78 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
79 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
80 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
81 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
84 <A NAME="skip-navbar_top"></A>
\r
85 <!-- ========= END OF TOP NAVBAR ========= -->
\r
88 <!-- ======== START OF CLASS DATA ======== -->
\r
91 compbio.data.sequence</FONT>
\r
95 <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
\r
96 <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>compbio.data.sequence.Score</B>
\r
100 <DT><PRE><FONT SIZE="-1">@Immutable
\r
101 </FONT>public class <B>Score</B><DT>extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL>
\r
105 A value class for AACon annotation results storage
\r
110 <DT><B>Author:</B></DT>
\r
117 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
\r
119 <A NAME="constructor_summary"><!-- --></A>
\r
120 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
121 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
122 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
\r
123 <B>Constructor Summary</B></FONT></TH>
\r
125 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
126 <TD><CODE><B><A HREF="../../../compbio/data/sequence/Score.html#Score(compbio.data.sequence.ConservationMethod, java.util.List)">Score</A></B>(<A HREF="../../../compbio/data/sequence/ConservationMethod.html" title="enum in compbio.data.sequence">ConservationMethod</A> method,
\r
127 <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Float.html?is-external=true" title="class or interface in java.lang">Float</A>> scores)</CODE>
\r
130 Instantiate the Score</TD>
\r
134 <!-- ========== METHOD SUMMARY =========== -->
\r
136 <A NAME="method_summary"><!-- --></A>
\r
137 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
138 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
139 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
\r
140 <B>Method Summary</B></FONT></TH>
\r
142 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
143 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
144 <CODE> boolean</CODE></FONT></TD>
\r
145 <TD><CODE><B><A HREF="../../../compbio/data/sequence/Score.html#equals(java.lang.Object)">equals</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> obj)</CODE>
\r
148 </TD>
\r
150 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
151 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
152 <CODE> <A HREF="../../../compbio/data/sequence/ConservationMethod.html" title="enum in compbio.data.sequence">ConservationMethod</A></CODE></FONT></TD>
\r
153 <TD><CODE><B><A HREF="../../../compbio/data/sequence/Score.html#getMethod()">getMethod</A></B>()</CODE>
\r
156 Returns the ConservationMethod</TD>
\r
158 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
159 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
160 <CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Float.html?is-external=true" title="class or interface in java.lang">Float</A>></CODE></FONT></TD>
\r
161 <TD><CODE><B><A HREF="../../../compbio/data/sequence/Score.html#getScores()">getScores</A></B>()</CODE>
\r
164 The column scores for the alignment</TD>
\r
166 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
167 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
168 <CODE> int</CODE></FONT></TD>
\r
169 <TD><CODE><B><A HREF="../../../compbio/data/sequence/Score.html#hashCode()">hashCode</A></B>()</CODE>
\r
172 </TD>
\r
174 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
175 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
176 <CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
\r
177 <TD><CODE><B><A HREF="../../../compbio/data/sequence/Score.html#toString()">toString</A></B>()</CODE>
\r
180 </TD>
\r
182 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
183 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
184 <CODE>static void</CODE></FONT></TD>
\r
185 <TD><CODE><B><A HREF="../../../compbio/data/sequence/Score.html#write(java.util.Set, java.io.OutputStream)">write</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</A><<A HREF="../../../compbio/data/sequence/Score.html" title="class in compbio.data.sequence">Score</A>> scores,
\r
186 <A HREF="http://java.sun.com/javase/6/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A> output)</CODE>
\r
189 Outputs the List of Score objects into the Output stream.</TD>
\r
192 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
\r
193 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
194 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
195 <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
\r
197 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
198 <TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
\r
204 <!-- ========= CONSTRUCTOR DETAIL ======== -->
\r
206 <A NAME="constructor_detail"><!-- --></A>
\r
207 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
208 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
209 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
\r
210 <B>Constructor Detail</B></FONT></TH>
\r
214 <A NAME="Score(compbio.data.sequence.ConservationMethod, java.util.List)"><!-- --></A><H3>
\r
217 public <B>Score</B>(<A HREF="../../../compbio/data/sequence/ConservationMethod.html" title="enum in compbio.data.sequence">ConservationMethod</A> method,
\r
218 <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Float.html?is-external=true" title="class or interface in java.lang">Float</A>> scores)</PRE>
\r
220 <DD>Instantiate the Score
\r
223 <DT><B>Parameters:</B><DD><CODE>method</CODE> - the ConservationMethod with which <code>scores</code> were
224 calculated<DD><CODE>scores</CODE> - the actual conservation values for each column of the
228 <!-- ============ METHOD DETAIL ========== -->
\r
230 <A NAME="method_detail"><!-- --></A>
\r
231 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
232 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
233 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
\r
234 <B>Method Detail</B></FONT></TH>
\r
238 <A NAME="getMethod()"><!-- --></A><H3>
\r
241 public <A HREF="../../../compbio/data/sequence/ConservationMethod.html" title="enum in compbio.data.sequence">ConservationMethod</A> <B>getMethod</B>()</PRE>
\r
243 <DD>Returns the ConservationMethod
\r
247 <DT><B>Returns:</B><DD>the ConservationMethod</DL>
\r
252 <A NAME="getScores()"><!-- --></A><H3>
\r
255 public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Float.html?is-external=true" title="class or interface in java.lang">Float</A>> <B>getScores</B>()</PRE>
\r
257 <DD>The column scores for the alignment
\r
261 <DT><B>Returns:</B><DD>the column scores for the alignment</DL>
\r
266 <A NAME="toString()"><!-- --></A><H3>
\r
269 public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>toString</B>()</PRE>
\r
272 <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A></CODE> in class <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL>
\r
280 <A NAME="hashCode()"><!-- --></A><H3>
\r
283 public int <B>hashCode</B>()</PRE>
\r
286 <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A></CODE> in class <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL>
\r
294 <A NAME="equals(java.lang.Object)"><!-- --></A><H3>
\r
297 public boolean <B>equals</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> obj)</PRE>
\r
300 <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A></CODE> in class <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL>
\r
308 <A NAME="write(java.util.Set, java.io.OutputStream)"><!-- --></A><H3>
\r
311 public static void <B>write</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</A><<A HREF="../../../compbio/data/sequence/Score.html" title="class in compbio.data.sequence">Score</A>> scores,
\r
312 <A HREF="http://java.sun.com/javase/6/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A> output)
\r
313 throws <A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
\r
315 <DD>Outputs the List of Score objects into the Output stream. The output
316 format is as follows:
319 <code>#MethodName <space separated list of values>
323 #KABAT 0.2 0.3 0.2 0 0.645 0.333 1 1 0 0
324 #SMERFS 0.645 0.333 1 1 0 0 0.2 0.3 0.2 0
328 The maximum precision for values is 3 digits, but can be less.
\r
331 <DT><B>Parameters:</B><DD><CODE>scores</CODE> - the list of scores to output<DD><CODE>output</CODE> - the stream to output the data to
\r
333 <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - if the OutputStream cannot be written into
\r
334 <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if the output stream is null</DL>
\r
337 <!-- ========= END OF CLASS DATA ========= -->
\r
341 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
342 <A NAME="navbar_bottom"><!-- --></A>
\r
343 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
\r
344 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
346 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
347 <A NAME="navbar_bottom_firstrow"><!-- --></A>
\r
348 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
349 <TR ALIGN="center" VALIGN="top">
\r
350 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
351 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
352 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
353 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Score.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
\r
354 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
355 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
356 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
357 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
361 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
367 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
368 <A HREF="../../../compbio/data/sequence/Program.html" title="enum in compbio.data.sequence"><B>PREV CLASS</B></A>
\r
369 <A HREF="../../../compbio/data/sequence/SequenceUtil.html" title="class in compbio.data.sequence"><B>NEXT CLASS</B></A></FONT></TD>
\r
370 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
371 <A HREF="../../../index.html?compbio/data/sequence/Score.html" target="_top"><B>FRAMES</B></A>
\r
372 <A HREF="Score.html" target="_top"><B>NO FRAMES</B></A>
\r
373 <SCRIPT type="text/javascript">
\r
376 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
381 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
388 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
389 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
390 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
391 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
394 <A NAME="skip-navbar_bottom"></A>
\r
395 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r