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:32:49 BST 2017 -->
6 <title>FastaSequence</title>
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="FastaSequence";
21 var methods = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10};
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/FastaSequence.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/FastaReader.html" title="class in compbio.data.sequence"><span class="typeNameLink">Prev Class</span></a></li>
53 <li><a href="../../../compbio/data/sequence/GlobProtResult.html" title="enum in compbio.data.sequence"><span class="typeNameLink">Next Class</span></a></li>
56 <li><a href="../../../index.html?compbio/data/sequence/FastaSequence.html" target="_top">Frames</a></li>
57 <li><a href="FastaSequence.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 FastaSequence" class="title">Class FastaSequence</h2>
98 <div class="contentContainer">
99 <ul class="inheritance">
100 <li>java.lang.Object</li>
102 <ul class="inheritance">
103 <li>compbio.data.sequence.FastaSequence</li>
107 <div class="description">
108 <ul class="blockList">
109 <li class="blockList">
113 public class <span class="typeNameLabel">FastaSequence</span>
114 extends java.lang.Object</pre>
115 <div class="block">A FASTA formatted sequence. Please note that this class does not make any
116 assumptions as to what sequence it stores e.g. it could be nucleotide,
117 protein or even gapped alignment sequence! The only guarantee it makes is
118 that the sequence does not contain white space characters e.g. spaces, new
121 <dt><span class="simpleTagLabel">Version:</span></dt>
122 <dd>1.0 September 2009</dd>
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/FastaSequence.html#id">id</a></span></code>
147 <div class="block">Sequence id</div>
150 <tr class="rowColor">
151 <td class="colFirst"><code>private java.lang.String</code></td>
152 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/FastaSequence.html#sequence">sequence</a></span></code>
153 <div class="block">Returns the string representation of sequence</div>
159 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
160 <ul class="blockList">
161 <li class="blockList"><a name="constructor.summary">
164 <h3>Constructor Summary</h3>
165 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
166 <caption><span>Constructors</span><span class="tabEnd"> </span></caption>
168 <th class="colOne" scope="col">Constructor and Description</th>
170 <tr class="altColor">
171 <td class="colOne"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/FastaSequence.html#FastaSequence--">FastaSequence</a></span>()</code> </td>
173 <tr class="rowColor">
174 <td class="colOne"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/FastaSequence.html#FastaSequence-java.lang.String-java.lang.String-">FastaSequence</a></span>(java.lang.String id,
175 java.lang.String sequence)</code>
176 <div class="block">Upon construction the any whitespace characters are removed from the
183 <!-- ========== METHOD SUMMARY =========== -->
184 <ul class="blockList">
185 <li class="blockList"><a name="method.summary">
188 <h3>Method Summary</h3>
189 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
190 <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>
192 <th class="colFirst" scope="col">Modifier and Type</th>
193 <th class="colLast" scope="col">Method and Description</th>
195 <tr id="i0" class="altColor">
196 <td class="colFirst"><code>static int</code></td>
197 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/FastaSequence.html#countMatchesInSequence-java.lang.String-java.lang.String-">countMatchesInSequence</a></span>(java.lang.String theString,
198 java.lang.String theRegExp)</code> </td>
200 <tr id="i1" class="rowColor">
201 <td class="colFirst"><code>boolean</code></td>
202 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/FastaSequence.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object obj)</code> </td>
204 <tr id="i2" class="altColor">
205 <td class="colFirst"><code>java.lang.String</code></td>
206 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/FastaSequence.html#getFormatedSequence-int-">getFormatedSequence</a></span>(int width)</code>
207 <div class="block">Format sequence per width letter in one string.</div>
210 <tr id="i3" class="rowColor">
211 <td class="colFirst"><code>java.lang.String</code></td>
212 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/FastaSequence.html#getFormattedFasta--">getFormattedFasta</a></span>()</code> </td>
214 <tr id="i4" class="altColor">
215 <td class="colFirst"><code>java.lang.String</code></td>
216 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/FastaSequence.html#getId--">getId</a></span>()</code>
217 <div class="block">Gets the value of id</div>
220 <tr id="i5" class="rowColor">
221 <td class="colFirst"><code>int</code></td>
222 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/FastaSequence.html#getLength--">getLength</a></span>()</code> </td>
224 <tr id="i6" class="altColor">
225 <td class="colFirst"><code>java.lang.String</code></td>
226 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/FastaSequence.html#getOnelineFasta--">getOnelineFasta</a></span>()</code> </td>
228 <tr id="i7" class="rowColor">
229 <td class="colFirst"><code>java.lang.String</code></td>
230 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/FastaSequence.html#getSequence--">getSequence</a></span>()</code>
231 <div class="block">Gets the value of sequence</div>
234 <tr id="i8" class="altColor">
235 <td class="colFirst"><code>int</code></td>
236 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/FastaSequence.html#hashCode--">hashCode</a></span>()</code> </td>
238 <tr id="i9" class="rowColor">
239 <td class="colFirst"><code>java.lang.String</code></td>
240 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/FastaSequence.html#toString--">toString</a></span>()</code>
241 <div class="block">Same as oneLineFasta</div>
245 <ul class="blockList">
246 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
249 <h3>Methods inherited from class java.lang.Object</h3>
250 <code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
257 <div class="details">
258 <ul class="blockList">
259 <li class="blockList">
260 <!-- ============ FIELD DETAIL =========== -->
261 <ul class="blockList">
262 <li class="blockList"><a name="field.detail">
265 <h3>Field Detail</h3>
269 <ul class="blockList">
270 <li class="blockList">
272 <pre>private java.lang.String id</pre>
273 <div class="block">Sequence id</div>
279 <ul class="blockListLast">
280 <li class="blockList">
282 <pre>private java.lang.String sequence</pre>
283 <div class="block">Returns the string representation of sequence</div>
288 <!-- ========= CONSTRUCTOR DETAIL ======== -->
289 <ul class="blockList">
290 <li class="blockList"><a name="constructor.detail">
293 <h3>Constructor Detail</h3>
294 <a name="FastaSequence--">
297 <ul class="blockList">
298 <li class="blockList">
299 <h4>FastaSequence</h4>
300 <pre>FastaSequence()</pre>
303 <a name="FastaSequence-java.lang.String-java.lang.String-">
306 <ul class="blockListLast">
307 <li class="blockList">
308 <h4>FastaSequence</h4>
309 <pre>public FastaSequence(java.lang.String id,
310 java.lang.String sequence)</pre>
311 <div class="block">Upon construction the any whitespace characters are removed from the
314 <dt><span class="paramLabel">Parameters:</span></dt>
315 <dd><code>id</code> - </dd>
316 <dd><code>sequence</code> - </dd>
322 <!-- ============ METHOD DETAIL ========== -->
323 <ul class="blockList">
324 <li class="blockList"><a name="method.detail">
327 <h3>Method Detail</h3>
331 <ul class="blockList">
332 <li class="blockList">
334 <pre>public java.lang.String getId()</pre>
335 <div class="block">Gets the value of id</div>
337 <dt><span class="returnLabel">Returns:</span></dt>
338 <dd>the value of id</dd>
342 <a name="getSequence--">
345 <ul class="blockList">
346 <li class="blockList">
348 <pre>public java.lang.String getSequence()</pre>
349 <div class="block">Gets the value of sequence</div>
351 <dt><span class="returnLabel">Returns:</span></dt>
352 <dd>the value of sequence</dd>
356 <a name="countMatchesInSequence-java.lang.String-java.lang.String-">
359 <ul class="blockList">
360 <li class="blockList">
361 <h4>countMatchesInSequence</h4>
362 <pre>public static int countMatchesInSequence(java.lang.String theString,
363 java.lang.String theRegExp)</pre>
366 <a name="getFormattedFasta--">
369 <ul class="blockList">
370 <li class="blockList">
371 <h4>getFormattedFasta</h4>
372 <pre>public java.lang.String getFormattedFasta()</pre>
375 <a name="getOnelineFasta--">
378 <ul class="blockList">
379 <li class="blockList">
380 <h4>getOnelineFasta</h4>
381 <pre>public java.lang.String getOnelineFasta()</pre>
383 <dt><span class="returnLabel">Returns:</span></dt>
384 <dd>one line name, next line sequence, no matter what the sequence
389 <a name="getFormatedSequence-int-">
392 <ul class="blockList">
393 <li class="blockList">
394 <h4>getFormatedSequence</h4>
395 <pre>public java.lang.String getFormatedSequence(int width)</pre>
396 <div class="block">Format sequence per width letter in one string. Without spaces.</div>
398 <dt><span class="returnLabel">Returns:</span></dt>
399 <dd>multiple line formated sequence, one line width letters length</dd>
403 <a name="getLength--">
406 <ul class="blockList">
407 <li class="blockList">
409 <pre>public int getLength()</pre>
411 <dt><span class="returnLabel">Returns:</span></dt>
412 <dd>sequence length</dd>
416 <a name="toString--">
419 <ul class="blockList">
420 <li class="blockList">
422 <pre>public java.lang.String toString()</pre>
423 <div class="block">Same as oneLineFasta</div>
425 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
426 <dd><code>toString</code> in class <code>java.lang.Object</code></dd>
430 <a name="hashCode--">
433 <ul class="blockList">
434 <li class="blockList">
436 <pre>public int hashCode()</pre>
438 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
439 <dd><code>hashCode</code> in class <code>java.lang.Object</code></dd>
443 <a name="equals-java.lang.Object-">
446 <ul class="blockListLast">
447 <li class="blockList">
449 <pre>public boolean equals(java.lang.Object obj)</pre>
451 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
452 <dd><code>equals</code> in class <code>java.lang.Object</code></dd>
462 <!-- ========= END OF CLASS DATA ========= -->
463 <!-- ======= START OF BOTTOM NAVBAR ====== -->
464 <div class="bottomNav"><a name="navbar.bottom">
467 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
468 <a name="navbar.bottom.firstrow">
471 <ul class="navList" title="Navigation">
472 <li><a href="../../../overview-summary.html">Overview</a></li>
473 <li><a href="package-summary.html">Package</a></li>
474 <li class="navBarCell1Rev">Class</li>
475 <li><a href="class-use/FastaSequence.html">Use</a></li>
476 <li><a href="package-tree.html">Tree</a></li>
477 <li><a href="../../../deprecated-list.html">Deprecated</a></li>
478 <li><a href="../../../index-files/index-1.html">Index</a></li>
479 <li><a href="../../../help-doc.html">Help</a></li>
484 <li><a href="../../../compbio/data/sequence/FastaReader.html" title="class in compbio.data.sequence"><span class="typeNameLink">Prev Class</span></a></li>
485 <li><a href="../../../compbio/data/sequence/GlobProtResult.html" title="enum in compbio.data.sequence"><span class="typeNameLink">Next Class</span></a></li>
488 <li><a href="../../../index.html?compbio/data/sequence/FastaSequence.html" target="_top">Frames</a></li>
489 <li><a href="FastaSequence.html" target="_top">No Frames</a></li>
491 <ul class="navList" id="allclasses_navbar_bottom">
492 <li><a href="../../../allclasses-noframe.html">All Classes</a></li>
495 <script type="text/javascript"><!--
496 allClassesLink = document.getElementById("allclasses_navbar_bottom");
498 allClassesLink.style.display = "block";
501 allClassesLink.style.display = "none";
507 <ul class="subNavList">
508 <li>Summary: </li>
509 <li>Nested | </li>
510 <li><a href="#field.summary">Field</a> | </li>
511 <li><a href="#constructor.summary">Constr</a> | </li>
512 <li><a href="#method.summary">Method</a></li>
514 <ul class="subNavList">
515 <li>Detail: </li>
516 <li><a href="#field.detail">Field</a> | </li>
517 <li><a href="#constructor.detail">Constr</a> | </li>
518 <li><a href="#method.detail">Method</a></li>
521 <a name="skip.navbar.bottom">
524 <!-- ======== END OF BOTTOM NAVBAR ======= -->