delete old javadoc to update
[jabaws.git] / website / dm_javadoc / compbio / data / sequence / AlignmentMetadata.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_21) on Wed Nov 24 12:17:18 GMT 2010 -->\r
6 <TITLE>\r
7 AlignmentMetadata\r
8 </TITLE>\r
9 \r
10 <META NAME="date" CONTENT="2010-11-24">\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="AlignmentMetadata";\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/AlignmentMetadata.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/data/sequence/Alignment.html" title="class in compbio.data.sequence"><B>PREV CLASS</B></A>&nbsp;\r
59 &nbsp;<A HREF="../../../compbio/data/sequence/ClustalAlignmentUtil.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/AlignmentMetadata.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
62 &nbsp;<A HREF="AlignmentMetadata.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.data.sequence</FONT>\r
92 <BR>\r
93 Class AlignmentMetadata</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.data.sequence.AlignmentMetadata</B>\r
97 </PRE>\r
98 <HR>\r
99 <DL>\r
100 <DT><PRE><FONT SIZE="-1">@Immutable\r
101 </FONT>public class <B>AlignmentMetadata</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
102 </PRE>\r
103 \r
104 <P>\r
105 Alignment metadata e.g. method/program being used to generate the alignment
106  and its parameters\r
107 <P>\r
108 \r
109 <P>\r
110 <DL>\r
111 <DT><B>Version:</B></DT>\r
112   <DD>1.0 September 2009</DD>\r
113 <DT><B>Author:</B></DT>\r
114   <DD>pvtroshin</DD>\r
115 </DL>\r
116 <HR>\r
117 \r
118 <P>\r
119 \r
120 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
121 \r
122 <A NAME="constructor_summary"><!-- --></A>\r
123 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
124 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
125 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
126 <B>Constructor Summary</B></FONT></TH>\r
127 </TR>\r
128 <TR BGCOLOR="white" CLASS="TableRowColor">\r
129 <TD><CODE><B><A HREF="../../../compbio/data/sequence/AlignmentMetadata.html#AlignmentMetadata(compbio.data.sequence.Program, char)">AlignmentMetadata</A></B>(<A HREF="../../../compbio/data/sequence/Program.html" title="enum in compbio.data.sequence">Program</A>&nbsp;program,\r
130                   char&nbsp;gapchar)</CODE>\r
131 \r
132 <BR>\r
133 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
134 </TR>\r
135 </TABLE>\r
136 &nbsp;\r
137 <!-- ========== METHOD SUMMARY =========== -->\r
138 \r
139 <A NAME="method_summary"><!-- --></A>\r
140 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
141 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
142 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
143 <B>Method Summary</B></FONT></TH>\r
144 </TR>\r
145 <TR BGCOLOR="white" CLASS="TableRowColor">\r
146 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
147 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
148 <TD><CODE><B><A HREF="../../../compbio/data/sequence/AlignmentMetadata.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>&nbsp;obj)</CODE>\r
149 \r
150 <BR>\r
151 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
152 </TR>\r
153 <TR BGCOLOR="white" CLASS="TableRowColor">\r
154 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
155 <CODE>&nbsp;char</CODE></FONT></TD>\r
156 <TD><CODE><B><A HREF="../../../compbio/data/sequence/AlignmentMetadata.html#getGapchar()">getGapchar</A></B>()</CODE>\r
157 \r
158 <BR>\r
159 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
160 </TR>\r
161 <TR BGCOLOR="white" CLASS="TableRowColor">\r
162 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
163 <CODE>&nbsp;<A HREF="../../../compbio/data/sequence/Program.html" title="enum in compbio.data.sequence">Program</A></CODE></FONT></TD>\r
164 <TD><CODE><B><A HREF="../../../compbio/data/sequence/AlignmentMetadata.html#getProgram()">getProgram</A></B>()</CODE>\r
165 \r
166 <BR>\r
167 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
168 </TR>\r
169 <TR BGCOLOR="white" CLASS="TableRowColor">\r
170 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
171 <CODE>&nbsp;int</CODE></FONT></TD>\r
172 <TD><CODE><B><A HREF="../../../compbio/data/sequence/AlignmentMetadata.html#hashCode()">hashCode</A></B>()</CODE>\r
173 \r
174 <BR>\r
175 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
176 </TR>\r
177 </TABLE>\r
178 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
179 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
180 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
181 <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
182 </TR>\r
183 <TR BGCOLOR="white" CLASS="TableRowColor">\r
184 <TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</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#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
185 </TR>\r
186 </TABLE>\r
187 &nbsp;\r
188 <P>\r
189 \r
190 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
191 \r
192 <A NAME="constructor_detail"><!-- --></A>\r
193 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
194 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
195 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
196 <B>Constructor Detail</B></FONT></TH>\r
197 </TR>\r
198 </TABLE>\r
199 \r
200 <A NAME="AlignmentMetadata(compbio.data.sequence.Program, char)"><!-- --></A><H3>\r
201 AlignmentMetadata</H3>\r
202 <PRE>\r
203 public <B>AlignmentMetadata</B>(<A HREF="../../../compbio/data/sequence/Program.html" title="enum in compbio.data.sequence">Program</A>&nbsp;program,\r
204                          char&nbsp;gapchar)</PRE>\r
205 <DL>\r
206 </DL>\r
207 \r
208 <!-- ============ METHOD DETAIL ========== -->\r
209 \r
210 <A NAME="method_detail"><!-- --></A>\r
211 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
212 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
213 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
214 <B>Method Detail</B></FONT></TH>\r
215 </TR>\r
216 </TABLE>\r
217 \r
218 <A NAME="getProgram()"><!-- --></A><H3>\r
219 getProgram</H3>\r
220 <PRE>\r
221 public <A HREF="../../../compbio/data/sequence/Program.html" title="enum in compbio.data.sequence">Program</A> <B>getProgram</B>()</PRE>\r
222 <DL>\r
223 <DD><DL>\r
224 </DL>\r
225 </DD>\r
226 </DL>\r
227 <HR>\r
228 \r
229 <A NAME="getGapchar()"><!-- --></A><H3>\r
230 getGapchar</H3>\r
231 <PRE>\r
232 public char <B>getGapchar</B>()</PRE>\r
233 <DL>\r
234 <DD><DL>\r
235 </DL>\r
236 </DD>\r
237 </DL>\r
238 <HR>\r
239 \r
240 <A NAME="equals(java.lang.Object)"><!-- --></A><H3>\r
241 equals</H3>\r
242 <PRE>\r
243 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>&nbsp;obj)</PRE>\r
244 <DL>\r
245 <DD><DL>\r
246 <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
247 </DD>\r
248 <DD><DL>\r
249 </DL>\r
250 </DD>\r
251 </DL>\r
252 <HR>\r
253 \r
254 <A NAME="hashCode()"><!-- --></A><H3>\r
255 hashCode</H3>\r
256 <PRE>\r
257 public int <B>hashCode</B>()</PRE>\r
258 <DL>\r
259 <DD><DL>\r
260 <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
261 </DD>\r
262 <DD><DL>\r
263 </DL>\r
264 </DD>\r
265 </DL>\r
266 <!-- ========= END OF CLASS DATA ========= -->\r
267 <HR>\r
268 \r
269 \r
270 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
271 <A NAME="navbar_bottom"><!-- --></A>\r
272 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
273 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
274 <TR>\r
275 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
276 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
277 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
278   <TR ALIGN="center" VALIGN="top">\r
279   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
280   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
281   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
282   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/AlignmentMetadata.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
283   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
284   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
285   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
286   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
287   </TR>\r
288 </TABLE>\r
289 </TD>\r
290 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
291 </EM>\r
292 </TD>\r
293 </TR>\r
294 \r
295 <TR>\r
296 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
297 &nbsp;<A HREF="../../../compbio/data/sequence/Alignment.html" title="class in compbio.data.sequence"><B>PREV CLASS</B></A>&nbsp;\r
298 &nbsp;<A HREF="../../../compbio/data/sequence/ClustalAlignmentUtil.html" title="class in compbio.data.sequence"><B>NEXT CLASS</B></A></FONT></TD>\r
299 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
300   <A HREF="../../../index.html?compbio/data/sequence/AlignmentMetadata.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
301 &nbsp;<A HREF="AlignmentMetadata.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
302 &nbsp;<SCRIPT type="text/javascript">\r
303   <!--\r
304   if(window==top) {\r
305     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
306   }\r
307   //-->\r
308 </SCRIPT>\r
309 <NOSCRIPT>\r
310   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
311 </NOSCRIPT>\r
312 \r
313 \r
314 </FONT></TD>\r
315 </TR>\r
316 <TR>\r
317 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
318   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
319 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
320 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
321 </TR>\r
322 </TABLE>\r
323 <A NAME="skip-navbar_bottom"></A>\r
324 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
325 \r
326 <HR>\r
327 \r
328 </BODY>\r
329 </HTML>\r