updated javadoc
[jabaws.git] / website / full_javadoc / compbio / pipeline / _jpred / BlastParser.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">\r
2 <!--NewPage-->\r
3 <HTML>\r
4 <HEAD>\r
5 <!-- Generated by javadoc (build 1.6.0_24) on Fri Aug 12 14:32:35 BST 2011 -->\r
6 <TITLE>\r
7 BlastParser\r
8 </TITLE>\r
9 \r
10 <META NAME="date" CONTENT="2011-08-12">\r
11 \r
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">\r
13 \r
14 <SCRIPT type="text/javascript">\r
15 function windowTitle()\r
16 {\r
17     if (location.href.indexOf('is-external=true') == -1) {\r
18         parent.document.title="BlastParser";\r
19     }\r
20 }\r
21 </SCRIPT>\r
22 <NOSCRIPT>\r
23 </NOSCRIPT>\r
24 \r
25 </HEAD>\r
26 \r
27 <BODY BGCOLOR="white" onload="windowTitle();">\r
28 <HR>\r
29 \r
30 \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
35 <TR>\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>&nbsp;</TD>\r
41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
42   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/BlastParser.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
44   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
45   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
46   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
47   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
48   </TR>\r
49 </TABLE>\r
50 </TD>\r
51 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
52 </EM>\r
53 </TD>\r
54 </TR>\r
55 \r
56 <TR>\r
57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
58 &nbsp;<A HREF="../../../compbio/pipeline/_jpred/BlastHmmerComparator.html" title="class in compbio.pipeline._jpred"><B>PREV CLASS</B></A>&nbsp;\r
59 &nbsp;<A HREF="../../../compbio/pipeline/_jpred/Hit.html" title="class in compbio.pipeline._jpred"><B>NEXT CLASS</B></A></FONT></TD>\r
60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
61   <A HREF="../../../index.html?compbio/pipeline/_jpred/BlastParser.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
62 &nbsp;<A HREF="BlastParser.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
63 &nbsp;<SCRIPT type="text/javascript">\r
64   <!--\r
65   if(window==top) {\r
66     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
67   }\r
68   //-->\r
69 </SCRIPT>\r
70 <NOSCRIPT>\r
71   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
72 </NOSCRIPT>\r
73 \r
74 \r
75 </FONT></TD>\r
76 </TR>\r
77 <TR>\r
78 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
79   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
80 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
81 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
82 </TR>\r
83 </TABLE>\r
84 <A NAME="skip-navbar_top"></A>\r
85 <!-- ========= END OF TOP NAVBAR ========= -->\r
86 \r
87 <HR>\r
88 <!-- ======== START OF CLASS DATA ======== -->\r
89 <H2>\r
90 <FONT SIZE="-1">\r
91 compbio.pipeline._jpred</FONT>\r
92 <BR>\r
93 Class BlastParser</H2>\r
94 <PRE>\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.pipeline._jpred.BlastParser</B>\r
97 </PRE>\r
98 <HR>\r
99 <DL>\r
100 <DT><PRE>public class <B>BlastParser</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
101 </PRE>\r
102 \r
103 <P>\r
104 <HR>\r
105 \r
106 <P>\r
107 \r
108 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
109 \r
110 <A NAME="constructor_summary"><!-- --></A>\r
111 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
112 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
113 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
114 <B>Constructor Summary</B></FONT></TH>\r
115 </TR>\r
116 <TR BGCOLOR="white" CLASS="TableRowColor">\r
117 <TD><CODE><B><A HREF="../../../compbio/pipeline/_jpred/BlastParser.html#BlastParser(java.lang.String)">BlastParser</A></B>(<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>&nbsp;file)</CODE>\r
118 \r
119 <BR>\r
120 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
121 </TR>\r
122 </TABLE>\r
123 &nbsp;\r
124 <!-- ========== METHOD SUMMARY =========== -->\r
125 \r
126 <A NAME="method_summary"><!-- --></A>\r
127 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
128 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
129 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
130 <B>Method Summary</B></FONT></TH>\r
131 </TR>\r
132 <TR BGCOLOR="white" CLASS="TableRowColor">\r
133 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
134 <CODE>static&nbsp;void</CODE></FONT></TD>\r
135 <TD><CODE><B><A HREF="../../../compbio/pipeline/_jpred/BlastParser.html#main(java.lang.String[])">main</A></B>(<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>[]&nbsp;args)</CODE>\r
136 \r
137 <BR>\r
138 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;args[0] is assumed to be the name of a Blast output file</TD>\r
139 </TR>\r
140 </TABLE>\r
141 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
142 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
143 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
144 <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
145 </TR>\r
146 <TR BGCOLOR="white" CLASS="TableRowColor">\r
147 <TD><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>, <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#hashCode()" title="class or interface in java.lang">hashCode</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#toString()" title="class or interface in java.lang">toString</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
148 </TR>\r
149 </TABLE>\r
150 &nbsp;\r
151 <P>\r
152 \r
153 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
154 \r
155 <A NAME="constructor_detail"><!-- --></A>\r
156 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
157 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
158 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
159 <B>Constructor Detail</B></FONT></TH>\r
160 </TR>\r
161 </TABLE>\r
162 \r
163 <A NAME="BlastParser(java.lang.String)"><!-- --></A><H3>\r
164 BlastParser</H3>\r
165 <PRE>\r
166 public <B>BlastParser</B>(<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>&nbsp;file)\r
167             throws <A HREF="http://java.sun.com/javase/6/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</A>,\r
168                    <A HREF="http://java.sun.com/javase/6/docs/api/javax/xml/stream/XMLStreamException.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamException</A></PRE>\r
169 <DL>\r
170 <DL>\r
171 \r
172 <DT><B>Throws:</B>\r
173 <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</A></CODE>\r
174 <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/javax/xml/stream/XMLStreamException.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamException</A></CODE></DL>\r
175 </DL>\r
176 \r
177 <!-- ============ METHOD DETAIL ========== -->\r
178 \r
179 <A NAME="method_detail"><!-- --></A>\r
180 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
181 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
182 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
183 <B>Method Detail</B></FONT></TH>\r
184 </TR>\r
185 </TABLE>\r
186 \r
187 <A NAME="main(java.lang.String[])"><!-- --></A><H3>\r
188 main</H3>\r
189 <PRE>\r
190 public static void <B>main</B>(<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>[]&nbsp;args)\r
191                  throws <A HREF="http://java.sun.com/javase/6/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</A>,\r
192                         <A HREF="http://java.sun.com/javase/6/docs/api/javax/xml/stream/XMLStreamException.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamException</A></PRE>\r
193 <DL>\r
194 <DD>args[0] is assumed to be the name of a Blast output file\r
195 <P>\r
196 <DD><DL>\r
197 \r
198 <DT><B>Throws:</B>\r
199 <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/javax/xml/stream/XMLStreamException.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamException</A></CODE>\r
200 <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</A></CODE></DL>\r
201 </DD>\r
202 </DL>\r
203 <!-- ========= END OF CLASS DATA ========= -->\r
204 <HR>\r
205 \r
206 \r
207 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
208 <A NAME="navbar_bottom"><!-- --></A>\r
209 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
210 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
211 <TR>\r
212 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
213 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
214 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
215   <TR ALIGN="center" VALIGN="top">\r
216   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
217   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
218   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
219   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/BlastParser.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
220   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
221   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
222   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
223   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
224   </TR>\r
225 </TABLE>\r
226 </TD>\r
227 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
228 </EM>\r
229 </TD>\r
230 </TR>\r
231 \r
232 <TR>\r
233 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
234 &nbsp;<A HREF="../../../compbio/pipeline/_jpred/BlastHmmerComparator.html" title="class in compbio.pipeline._jpred"><B>PREV CLASS</B></A>&nbsp;\r
235 &nbsp;<A HREF="../../../compbio/pipeline/_jpred/Hit.html" title="class in compbio.pipeline._jpred"><B>NEXT CLASS</B></A></FONT></TD>\r
236 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
237   <A HREF="../../../index.html?compbio/pipeline/_jpred/BlastParser.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
238 &nbsp;<A HREF="BlastParser.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
239 &nbsp;<SCRIPT type="text/javascript">\r
240   <!--\r
241   if(window==top) {\r
242     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
243   }\r
244   //-->\r
245 </SCRIPT>\r
246 <NOSCRIPT>\r
247   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
248 </NOSCRIPT>\r
249 \r
250 \r
251 </FONT></TD>\r
252 </TR>\r
253 <TR>\r
254 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
255   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
256 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
257 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
258 </TR>\r
259 </TABLE>\r
260 <A NAME="skip-navbar_bottom"></A>\r
261 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
262 \r
263 <HR>\r
264 \r
265 </BODY>\r
266 </HTML>\r