Debian Codegraph @

doc/artificialFastqGenerator/Read.html

raw
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <!-- NewPage -->
3 <html lang="en">
4 <head>
5 <!-- Generated by javadoc (version 1.7.0_51) on Wed Oct 01 16:41:56 BST 2014 -->
6 <title>Read</title>
7 <meta name="date" content="2014-10-01">
8 <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
9 </head>
10 <body>
11 <script type="text/javascript"><!--
12 if (location.href.indexOf('is-external=true') == -1) {
13 parent.document.title="Read";
14 }
15 //-->
16 </script>
17 <noscript>
18 <div>JavaScript is disabled on your browser.</div>
19 </noscript>
20 <!-- ========= START OF TOP NAVBAR ======= -->
21 <div class="topNav"><a name="navbar_top">
22 <!-- -->
23 </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
24 <!-- -->
25 </a>
26 <ul class="navList" title="Navigation">
27 <li><a href="../artificialFastqGenerator/package-summary.html">Package</a></li>
28 <li class="navBarCell1Rev">Class</li>
29 <li><a href="class-use/Read.html">Use</a></li>
30 <li><a href="package-tree.html">Tree</a></li>
31 <li><a href="../deprecated-list.html">Deprecated</a></li>
32 <li><a href="../index-files/index-1.html">Index</a></li>
33 <li><a href="../help-doc.html">Help</a></li>
34 </ul>
35 </div>
36 <div class="subNav">
37 <ul class="navList">
38 <li><a href="../artificialFastqGenerator/QualityScoreAndErrorGenerator.html" title="class in artificialFastqGenerator"><span class="strong">Prev Class</span></a></li>
39 <li>Next Class</li>
40 </ul>
41 <ul class="navList">
42 <li><a href="../index.html?artificialFastqGenerator/Read.html" target="_top">Frames</a></li>
43 <li><a href="Read.html" target="_top">No Frames</a></li>
44 </ul>
45 <ul class="navList" id="allclasses_navbar_top">
46 <li><a href="../allclasses-noframe.html">All Classes</a></li>
47 </ul>
48 <div>
49 <script type="text/javascript"><!--
50 allClassesLink = document.getElementById("allclasses_navbar_top");
51 if(window==top) {
52 allClassesLink.style.display = "block";
53 }
54 else {
55 allClassesLink.style.display = "none";
56 }
57 //-->
58 </script>
59 </div>
60 <div>
61 <ul class="subNavList">
62 <li>Summary:&nbsp;</li>
63 <li>Nested&nbsp;|&nbsp;</li>
64 <li>Field&nbsp;|&nbsp;</li>
65 <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
66 <li><a href="#method_summary">Method</a></li>
67 </ul>
68 <ul class="subNavList">
69 <li>Detail:&nbsp;</li>
70 <li>Field&nbsp;|&nbsp;</li>
71 <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
72 <li><a href="#method_detail">Method</a></li>
73 </ul>
74 </div>
75 <a name="skip-navbar_top">
76 <!-- -->
77 </a></div>
78 <!-- ========= END OF TOP NAVBAR ========= -->
79 <!-- ======== START OF CLASS DATA ======== -->
80 <div class="header">
81 <div class="subTitle">artificialFastqGenerator</div>
82 <h2 title="Class Read" class="title">Class Read</h2>
83 </div>
84 <div class="contentContainer">
85 <ul class="inheritance">
86 <li>java.lang.Object</li>
87 <li>
88 <ul class="inheritance">
89 <li><a href="../artificialFastqGenerator/AbstractRead.html" title="class in artificialFastqGenerator">artificialFastqGenerator.AbstractRead</a></li>
90 <li>
91 <ul class="inheritance">
92 <li>artificialFastqGenerator.Read</li>
93 </ul>
94 </li>
95 </ul>
96 </li>
97 </ul>
98 <div class="description">
99 <ul class="blockList">
100 <li class="blockList">
101 <hr>
102 <br>
103 <pre>public class <span class="strong">Read</span>
104 extends <a href="../artificialFastqGenerator/AbstractRead.html" title="class in artificialFastqGenerator">AbstractRead</a></pre>
105 <div class="block">An instance of this class corresponds to a read in an artificial fastq file. It has fields for its Nucleobase sequence,
106 unique integer ID, the other read in the pair, its encoded quality scores, and the genotypes which actually get read (i.e.
107 may contain error).
108
109 Copyright (C) 2012 The Institute of Cancer Research (ICR).
110
111 This file is part of ArtificialFastqGenerator v1.0.0.
112
113 ArtificialFastqGenerator is free software: you can redistribute it and/or modify it under the terms of the GNU General
114 Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any
115 later version.
116
117 This program is distributed in the hope that it will be useful but WITHOUT ANY WARRANTY; without even the implied warranty
118 of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
119
120 You should have received a copy of the GNU Public License along with this
121 program. If not, see <http://www.gnu.org/licenses/>
122
123 Authour's contact email: [email protected]</div>
124 </li>
125 </ul>
126 </div>
127 <div class="summary">
128 <ul class="blockList">
129 <li class="blockList">
130 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
131 <ul class="blockList">
132 <li class="blockList"><a name="constructor_summary">
133 <!-- -->
134 </a>
135 <h3>Constructor Summary</h3>
136 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
137 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
138 <tr>
139 <th class="colOne" scope="col">Constructor and Description</th>
140 </tr>
141 <tr class="altColor">
142 <td class="colOne"><code><strong><a href="../artificialFastqGenerator/Read.html#Read(java.util.ArrayList, long, artificialFastqGenerator.Read, boolean, char[], char[], int, int)">Read</a></strong>(java.util.ArrayList&lt;<a href="../artificialFastqGenerator/Nucleobase.html" title="class in artificialFastqGenerator">Nucleobase</a>&gt;&nbsp;sequence,
143 long&nbsp;uniqueID,
144 <a href="../artificialFastqGenerator/Read.html" title="class in artificialFastqGenerator">Read</a>&nbsp;pairedEndRead,
145 boolean&nbsp;leftPEAndNeedsWriting,
146 char[]&nbsp;encodedQualityScores,
147 char[]&nbsp;genotypesThatAreRead,
148 int&nbsp;xCoordinate,
149 int&nbsp;yCoordinate)</code>
150 <div class="block">Initialise a new Read object.</div>
151 </td>
152 </tr>
153 </table>
154 </li>
155 </ul>
156 <!-- ========== METHOD SUMMARY =========== -->
157 <ul class="blockList">
158 <li class="blockList"><a name="method_summary">
159 <!-- -->
160 </a>
161 <h3>Method Summary</h3>
162 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
163 <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
164 <tr>
165 <th class="colFirst" scope="col">Modifier and Type</th>
166 <th class="colLast" scope="col">Method and Description</th>
167 </tr>
168 <tr class="altColor">
169 <td class="colFirst"><code>java.lang.String</code></td>
170 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Read.html#getDebugString()">getDebugString</a></strong>()</code>
171 <div class="block">Get the debug string for this read object.</div>
172 </td>
173 </tr>
174 <tr class="rowColor">
175 <td class="colFirst"><code><a href="../artificialFastqGenerator/Read.html" title="class in artificialFastqGenerator">Read</a></code></td>
176 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Read.html#getPairedEndRead()">getPairedEndRead</a></strong>()</code>
177 <div class="block">Get the read with which this read object forms a pair.</div>
178 </td>
179 </tr>
180 <tr class="altColor">
181 <td class="colFirst"><code>boolean</code></td>
182 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Read.html#isLeftReadAndNeedsWriting()">isLeftReadAndNeedsWriting</a></strong>()</code>
183 <div class="block">Get whether the Read object is a left read and needs writing.</div>
184 </td>
185 </tr>
186 <tr class="rowColor">
187 <td class="colFirst"><code>void</code></td>
188 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Read.html#setLeftReadAndNeedsWriting(boolean)">setLeftReadAndNeedsWriting</a></strong>(boolean&nbsp;trueOrFalse)</code>
189 <div class="block">Set whether the Read object is a left read and needs writing.</div>
190 </td>
191 </tr>
192 <tr class="altColor">
193 <td class="colFirst"><code>void</code></td>
194 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Read.html#setPairedEndRead(artificialFastqGenerator.Read)">setPairedEndRead</a></strong>(<a href="../artificialFastqGenerator/Read.html" title="class in artificialFastqGenerator">Read</a>&nbsp;pairedEndRead)</code>
195 <div class="block">Set the read with which this read object forms a pair.</div>
196 </td>
197 </tr>
198 <tr class="rowColor">
199 <td class="colFirst"><code>java.lang.String</code></td>
200 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Read.html#toString()">toString</a></strong>()</code>
201 <div class="block">Get the string that represents this read object.</div>
202 </td>
203 </tr>
204 <tr class="altColor">
205 <td class="colFirst"><code>void</code></td>
206 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Read.html#updateNucleobaseCoverage(artificialFastqGenerator.Read)">updateNucleobaseCoverage</a></strong>(<a href="../artificialFastqGenerator/Read.html" title="class in artificialFastqGenerator">Read</a>&nbsp;read)</code>
207 <div class="block">For each of the reference genome nucleobases in this read, add
208 the read into the nucleobase's covering reads ArrayList.</div>
209 </td>
210 </tr>
211 </table>
212 <ul class="blockList">
213 <li class="blockList"><a name="methods_inherited_from_class_artificialFastqGenerator.AbstractRead">
214 <!-- -->
215 </a>
216 <h3>Methods inherited from class&nbsp;artificialFastqGenerator.<a href="../artificialFastqGenerator/AbstractRead.html" title="class in artificialFastqGenerator">AbstractRead</a></h3>
217 <code><a href="../artificialFastqGenerator/AbstractRead.html#getSequence()">getSequence</a>, <a href="../artificialFastqGenerator/AbstractRead.html#setSequence(java.util.ArrayList)">setSequence</a></code></li>
218 </ul>
219 <ul class="blockList">
220 <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
221 <!-- -->
222 </a>
223 <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
224 <code>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
225 </ul>
226 </li>
227 </ul>
228 </li>
229 </ul>
230 </div>
231 <div class="details">
232 <ul class="blockList">
233 <li class="blockList">
234 <!-- ========= CONSTRUCTOR DETAIL ======== -->
235 <ul class="blockList">
236 <li class="blockList"><a name="constructor_detail">
237 <!-- -->
238 </a>
239 <h3>Constructor Detail</h3>
240 <a name="Read(java.util.ArrayList, long, artificialFastqGenerator.Read, boolean, char[], char[], int, int)">
241 <!-- -->
242 </a>
243 <ul class="blockListLast">
244 <li class="blockList">
245 <h4>Read</h4>
246 <pre>public&nbsp;Read(java.util.ArrayList&lt;<a href="../artificialFastqGenerator/Nucleobase.html" title="class in artificialFastqGenerator">Nucleobase</a>&gt;&nbsp;sequence,
247 long&nbsp;uniqueID,
248 <a href="../artificialFastqGenerator/Read.html" title="class in artificialFastqGenerator">Read</a>&nbsp;pairedEndRead,
249 boolean&nbsp;leftPEAndNeedsWriting,
250 char[]&nbsp;encodedQualityScores,
251 char[]&nbsp;genotypesThatAreRead,
252 int&nbsp;xCoordinate,
253 int&nbsp;yCoordinate)</pre>
254 <div class="block">Initialise a new Read object.</div>
255 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>sequence</code> - - the sequence of nucleobases in this read.</dd><dd><code>uniqueID</code> - - the read's unique integer ID.</dd><dd><code>pairedEndRead</code> - - the other read with which this one forms a pair.</dd><dd><code>leftPEAndNeedsWriting</code> - - true if the read is a left read and needs writing, else false.</dd><dd><code>encodedQualityScores</code> - - the encoded quality scores for this read.</dd><dd><code>genotypesThatAreRead</code> - - the genotypes that get read.</dd><dd><code>xCoordinate</code> - - the read's x-coordinate.</dd><dd><code>yCoordinate</code> - - the read's y-coordinate.</dd></dl>
256 </li>
257 </ul>
258 </li>
259 </ul>
260 <!-- ============ METHOD DETAIL ========== -->
261 <ul class="blockList">
262 <li class="blockList"><a name="method_detail">
263 <!-- -->
264 </a>
265 <h3>Method Detail</h3>
266 <a name="setLeftReadAndNeedsWriting(boolean)">
267 <!-- -->
268 </a>
269 <ul class="blockList">
270 <li class="blockList">
271 <h4>setLeftReadAndNeedsWriting</h4>
272 <pre>public&nbsp;void&nbsp;setLeftReadAndNeedsWriting(boolean&nbsp;trueOrFalse)</pre>
273 <div class="block">Set whether the Read object is a left read and needs writing.</div>
274 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>trueOrFalse</code> - - true if the read is a left read and needs writing, else false.</dd></dl>
275 </li>
276 </ul>
277 <a name="isLeftReadAndNeedsWriting()">
278 <!-- -->
279 </a>
280 <ul class="blockList">
281 <li class="blockList">
282 <h4>isLeftReadAndNeedsWriting</h4>
283 <pre>public&nbsp;boolean&nbsp;isLeftReadAndNeedsWriting()</pre>
284 <div class="block">Get whether the Read object is a left read and needs writing.</div>
285 <dl><dt><span class="strong">Returns:</span></dt><dd>leftPEAndNeedsWriting - whether the read is a left read and needs writing (hasn't been written yet), else false.</dd></dl>
286 </li>
287 </ul>
288 <a name="getPairedEndRead()">
289 <!-- -->
290 </a>
291 <ul class="blockList">
292 <li class="blockList">
293 <h4>getPairedEndRead</h4>
294 <pre>public&nbsp;<a href="../artificialFastqGenerator/Read.html" title="class in artificialFastqGenerator">Read</a>&nbsp;getPairedEndRead()</pre>
295 <div class="block">Get the read with which this read object forms a pair.</div>
296 <dl><dt><span class="strong">Returns:</span></dt><dd>pairedEndRead - the read with which this read forms a pair.</dd></dl>
297 </li>
298 </ul>
299 <a name="setPairedEndRead(artificialFastqGenerator.Read)">
300 <!-- -->
301 </a>
302 <ul class="blockList">
303 <li class="blockList">
304 <h4>setPairedEndRead</h4>
305 <pre>public&nbsp;void&nbsp;setPairedEndRead(<a href="../artificialFastqGenerator/Read.html" title="class in artificialFastqGenerator">Read</a>&nbsp;pairedEndRead)</pre>
306 <div class="block">Set the read with which this read object forms a pair.</div>
307 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>pairedEndRead</code> - - the read with which this read forms a pair.</dd></dl>
308 </li>
309 </ul>
310 <a name="updateNucleobaseCoverage(artificialFastqGenerator.Read)">
311 <!-- -->
312 </a>
313 <ul class="blockList">
314 <li class="blockList">
315 <h4>updateNucleobaseCoverage</h4>
316 <pre>public&nbsp;void&nbsp;updateNucleobaseCoverage(<a href="../artificialFastqGenerator/Read.html" title="class in artificialFastqGenerator">Read</a>&nbsp;read)</pre>
317 <div class="block">For each of the reference genome nucleobases in this read, add
318 the read into the nucleobase's covering reads ArrayList.</div>
319 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>read</code> - - this read.</dd></dl>
320 </li>
321 </ul>
322 <a name="toString()">
323 <!-- -->
324 </a>
325 <ul class="blockList">
326 <li class="blockList">
327 <h4>toString</h4>
328 <pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
329 <div class="block">Get the string that represents this read object.</div>
330 <dl>
331 <dt><strong>Overrides:</strong></dt>
332 <dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
333 <dt><span class="strong">Returns:</span></dt><dd>returnString - the string that represents this read object.</dd></dl>
334 </li>
335 </ul>
336 <a name="getDebugString()">
337 <!-- -->
338 </a>
339 <ul class="blockListLast">
340 <li class="blockList">
341 <h4>getDebugString</h4>
342 <pre>public&nbsp;java.lang.String&nbsp;getDebugString()</pre>
343 <div class="block">Get the debug string for this read object.</div>
344 <dl><dt><span class="strong">Returns:</span></dt><dd>returnString - the debug string that represents this read object.</dd></dl>
345 </li>
346 </ul>
347 </li>
348 </ul>
349 </li>
350 </ul>
351 </div>
352 </div>
353 <!-- ========= END OF CLASS DATA ========= -->
354 <!-- ======= START OF BOTTOM NAVBAR ====== -->
355 <div class="bottomNav"><a name="navbar_bottom">
356 <!-- -->
357 </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
358 <!-- -->
359 </a>
360 <ul class="navList" title="Navigation">
361 <li><a href="../artificialFastqGenerator/package-summary.html">Package</a></li>
362 <li class="navBarCell1Rev">Class</li>
363 <li><a href="class-use/Read.html">Use</a></li>
364 <li><a href="package-tree.html">Tree</a></li>
365 <li><a href="../deprecated-list.html">Deprecated</a></li>
366 <li><a href="../index-files/index-1.html">Index</a></li>
367 <li><a href="../help-doc.html">Help</a></li>
368 </ul>
369 </div>
370 <div class="subNav">
371 <ul class="navList">
372 <li><a href="../artificialFastqGenerator/QualityScoreAndErrorGenerator.html" title="class in artificialFastqGenerator"><span class="strong">Prev Class</span></a></li>
373 <li>Next Class</li>
374 </ul>
375 <ul class="navList">
376 <li><a href="../index.html?artificialFastqGenerator/Read.html" target="_top">Frames</a></li>
377 <li><a href="Read.html" target="_top">No Frames</a></li>
378 </ul>
379 <ul class="navList" id="allclasses_navbar_bottom">
380 <li><a href="../allclasses-noframe.html">All Classes</a></li>
381 </ul>
382 <div>
383 <script type="text/javascript"><!--
384 allClassesLink = document.getElementById("allclasses_navbar_bottom");
385 if(window==top) {
386 allClassesLink.style.display = "block";
387 }
388 else {
389 allClassesLink.style.display = "none";
390 }
391 //-->
392 </script>
393 </div>
394 <div>
395 <ul class="subNavList">
396 <li>Summary:&nbsp;</li>
397 <li>Nested&nbsp;|&nbsp;</li>
398 <li>Field&nbsp;|&nbsp;</li>
399 <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
400 <li><a href="#method_summary">Method</a></li>
401 </ul>
402 <ul class="subNavList">
403 <li>Detail:&nbsp;</li>
404 <li>Field&nbsp;|&nbsp;</li>
405 <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
406 <li><a href="#method_detail">Method</a></li>
407 </ul>
408 </div>
409 <a name="skip-navbar_bottom">
410 <!-- -->
411 </a></div>
412 <!-- ======== END OF BOTTOM NAVBAR ======= -->
413 </body>
414 </html>