Adding updated javadoc
[jabaws.git] / website / dm_javadoc / compbio / data / sequence / package-summary.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 Tue Dec 21 18:32:59 GMT 2010 -->\r
6 <TITLE>\r
7 compbio.data.sequence\r
8 </TITLE>\r
9 \r
10 <META NAME="date" CONTENT="2010-12-21">\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="compbio.data.sequence";\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="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>\r
42   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>\r
43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-use.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/msa/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;\r
59 &nbsp;<A HREF="../../../compbio/metadata/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>\r
60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
61   <A HREF="../../../index.html?compbio/data/sequence/package-summary.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
62 &nbsp;<A HREF="package-summary.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 </TABLE>\r
78 <A NAME="skip-navbar_top"></A>\r
79 <!-- ========= END OF TOP NAVBAR ========= -->\r
80 \r
81 <HR>\r
82 <H2>\r
83 Package compbio.data.sequence\r
84 </H2>\r
85 A data model for multiple sequence alignment web services and utility methods
86  that work on the objects of this model.\r
87 <P>\r
88 <B>See:</B>\r
89 <BR>\r
90 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<A HREF="#package_description"><B>Description</B></A>\r
91 <P>\r
92 \r
93 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
94 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
95 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
96 <B>Class Summary</B></FONT></TH>\r
97 </TR>\r
98 <TR BGCOLOR="white" CLASS="TableRowColor">\r
99 <TD WIDTH="15%"><B><A HREF="../../../compbio/data/sequence/Alignment.html" title="class in compbio.data.sequence">Alignment</A></B></TD>\r
100 <TD>Multiple sequence alignment.</TD>\r
101 </TR>\r
102 <TR BGCOLOR="white" CLASS="TableRowColor">\r
103 <TD WIDTH="15%"><B><A HREF="../../../compbio/data/sequence/AlignmentMetadata.html" title="class in compbio.data.sequence">AlignmentMetadata</A></B></TD>\r
104 <TD>Alignment metadata e.g.</TD>\r
105 </TR>\r
106 <TR BGCOLOR="white" CLASS="TableRowColor">\r
107 <TD WIDTH="15%"><B><A HREF="../../../compbio/data/sequence/AnnotatedSequence.html" title="class in compbio.data.sequence">AnnotatedSequence</A></B></TD>\r
108 <TD>&nbsp;</TD>\r
109 </TR>\r
110 <TR BGCOLOR="white" CLASS="TableRowColor">\r
111 <TD WIDTH="15%"><B><A HREF="../../../compbio/data/sequence/ClustalAlignmentUtil.html" title="class in compbio.data.sequence">ClustalAlignmentUtil</A></B></TD>\r
112 <TD>Tools to read and write clustal formated files</TD>\r
113 </TR>\r
114 <TR BGCOLOR="white" CLASS="TableRowColor">\r
115 <TD WIDTH="15%"><B><A HREF="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A></B></TD>\r
116 <TD>A FASTA formatted sequence.</TD>\r
117 </TR>\r
118 <TR BGCOLOR="white" CLASS="TableRowColor">\r
119 <TD WIDTH="15%"><B><A HREF="../../../compbio/data/sequence/MultiAnnotatedSequence.html" title="class in compbio.data.sequence">MultiAnnotatedSequence&lt;T extends Enum&lt;T&gt;&gt;</A></B></TD>\r
120 <TD>TODO complete</TD>\r
121 </TR>\r
122 <TR BGCOLOR="white" CLASS="TableRowColor">\r
123 <TD WIDTH="15%"><B><A HREF="../../../compbio/data/sequence/Score.html" title="class in compbio.data.sequence">Score</A></B></TD>\r
124 <TD>A value class for AACon annotation results storage</TD>\r
125 </TR>\r
126 <TR BGCOLOR="white" CLASS="TableRowColor">\r
127 <TD WIDTH="15%"><B><A HREF="../../../compbio/data/sequence/SequenceUtil.html" title="class in compbio.data.sequence">SequenceUtil</A></B></TD>\r
128 <TD>Utility class for operations on sequences</TD>\r
129 </TR>\r
130 </TABLE>\r
131 &nbsp;\r
132 \r
133 <P>\r
134 \r
135 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
136 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
137 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
138 <B>Enum Summary</B></FONT></TH>\r
139 </TR>\r
140 <TR BGCOLOR="white" CLASS="TableRowColor">\r
141 <TD WIDTH="15%"><B><A HREF="../../../compbio/data/sequence/ConservationMethod.html" title="enum in compbio.data.sequence">ConservationMethod</A></B></TD>\r
142 <TD>Enumeration listing of all the supported methods.</TD>\r
143 </TR>\r
144 <TR BGCOLOR="white" CLASS="TableRowColor">\r
145 <TD WIDTH="15%"><B><A HREF="../../../compbio/data/sequence/DisemblResultAnnot.html" title="enum in compbio.data.sequence">DisemblResultAnnot</A></B></TD>\r
146 <TD>&nbsp;</TD>\r
147 </TR>\r
148 <TR BGCOLOR="white" CLASS="TableRowColor">\r
149 <TD WIDTH="15%"><B><A HREF="../../../compbio/data/sequence/Program.html" title="enum in compbio.data.sequence">Program</A></B></TD>\r
150 <TD>The list of programmes that can produce alignments</TD>\r
151 </TR>\r
152 <TR BGCOLOR="white" CLASS="TableRowColor">\r
153 <TD WIDTH="15%"><B><A HREF="../../../compbio/data/sequence/SMERFSConstraints.html" title="enum in compbio.data.sequence">SMERFSConstraints</A></B></TD>\r
154 <TD>Enumeration defining two constraints for SMERFS columns score calculation.</TD>\r
155 </TR>\r
156 </TABLE>\r
157 &nbsp;\r
158 \r
159 <P>\r
160 \r
161 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
162 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
163 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
164 <B>Exception Summary</B></FONT></TH>\r
165 </TR>\r
166 <TR BGCOLOR="white" CLASS="TableRowColor">\r
167 <TD WIDTH="15%"><B><A HREF="../../../compbio/data/sequence/UnknownFileFormatException.html" title="class in compbio.data.sequence">UnknownFileFormatException</A></B></TD>\r
168 <TD>&nbsp;</TD>\r
169 </TR>\r
170 </TABLE>\r
171 &nbsp;\r
172 \r
173 <P>\r
174 <A NAME="package_description"><!-- --></A><H2>\r
175 Package compbio.data.sequence Description\r
176 </H2>\r
177 \r
178 <P>\r
179 A data model for multiple sequence alignment web services and utility methods
180  that work on the objects of this model.  
181  Classes in this package have no dependencies to other sources in the project. 
182  They form a base layer of JAva Bioinformatics Analysis Web Services.\r
183 <P>\r
184 \r
185 <P>\r
186 <DL>\r
187 <DT><B>Version:</B></DT>\r
188   <DD>1.0     January 2010</DD>\r
189 <DT><B>Author:</B></DT>\r
190   <DD>Petr Troshin</DD>\r
191 </DL>\r
192 <HR>\r
193 \r
194 \r
195 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
196 <A NAME="navbar_bottom"><!-- --></A>\r
197 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
198 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
199 <TR>\r
200 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
201 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
202 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
203   <TR ALIGN="center" VALIGN="top">\r
204   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
205   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>\r
206   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>\r
207   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
208   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
209   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
210   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
211   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
212   </TR>\r
213 </TABLE>\r
214 </TD>\r
215 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
216 </EM>\r
217 </TD>\r
218 </TR>\r
219 \r
220 <TR>\r
221 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
222 &nbsp;<A HREF="../../../compbio/data/msa/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;\r
223 &nbsp;<A HREF="../../../compbio/metadata/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>\r
224 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
225   <A HREF="../../../index.html?compbio/data/sequence/package-summary.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
226 &nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
227 &nbsp;<SCRIPT type="text/javascript">\r
228   <!--\r
229   if(window==top) {\r
230     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
231   }\r
232   //-->\r
233 </SCRIPT>\r
234 <NOSCRIPT>\r
235   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
236 </NOSCRIPT>\r
237 \r
238 \r
239 </FONT></TD>\r
240 </TR>\r
241 </TABLE>\r
242 <A NAME="skip-navbar_bottom"></A>\r
243 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
244 \r
245 <HR>\r
246 \r
247 </BODY>\r
248 </HTML>\r