Debian Codegraph @

doc/artificialFastqGenerator/Nucleobase.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>Nucleobase</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="Nucleobase";
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/Nucleobase.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/Main.html" title="class in artificialFastqGenerator"><span class="strong">Prev Class</span></a></li>
39 <li><a href="../artificialFastqGenerator/NucleobaseAndReadFactory.html" title="class in artificialFastqGenerator"><span class="strong">Next Class</span></a></li>
40 </ul>
41 <ul class="navList">
42 <li><a href="../index.html?artificialFastqGenerator/Nucleobase.html" target="_top">Frames</a></li>
43 <li><a href="Nucleobase.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 Nucleobase" class="title">Class Nucleobase</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>artificialFastqGenerator.Nucleobase</li>
90 </ul>
91 </li>
92 </ul>
93 <div class="description">
94 <ul class="blockList">
95 <li class="blockList">
96 <hr>
97 <br>
98 <pre>public class <span class="strong">Nucleobase</span>
99 extends java.lang.Object</pre>
100 <div class="block">An instance of the Nucleobase class corresponds to a nucleobase in the human reference genome. It has fields for its
101 genotype, unique integer ID, target coverage, covering reads (i.e. those reads in which it is contained), and coverage.
102
103 Copyright (C) 2012 The Institute of Cancer Research (ICR).
104
105 This file is part of ArtificialFastqGenerator v1.0.0.
106
107 ArtificialFastqGenerator is free software: you can redistribute it and/or modify it under the terms of the GNU General
108 Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any
109 later version.
110
111 This program is distributed in the hope that it will be useful but WITHOUT ANY WARRANTY; without even the implied warranty
112 of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
113
114 You should have received a copy of the GNU Public License along with this program. If not, see
115 <http://www.gnu.org/licenses/>
116
117 Authour's contact email: [email protected]</div>
118 </li>
119 </ul>
120 </div>
121 <div class="summary">
122 <ul class="blockList">
123 <li class="blockList">
124 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
125 <ul class="blockList">
126 <li class="blockList"><a name="constructor_summary">
127 <!-- -->
128 </a>
129 <h3>Constructor Summary</h3>
130 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
131 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
132 <tr>
133 <th class="colOne" scope="col">Constructor and Description</th>
134 </tr>
135 <tr class="altColor">
136 <td class="colOne"><code><strong><a href="../artificialFastqGenerator/Nucleobase.html#Nucleobase(char, long, int)">Nucleobase</a></strong>(char&nbsp;genotype,
137 long&nbsp;uniqueID,
138 int&nbsp;targetCoverage)</code>
139 <div class="block">Initialise a new Nucleobase object.</div>
140 </td>
141 </tr>
142 </table>
143 </li>
144 </ul>
145 <!-- ========== METHOD SUMMARY =========== -->
146 <ul class="blockList">
147 <li class="blockList"><a name="method_summary">
148 <!-- -->
149 </a>
150 <h3>Method Summary</h3>
151 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
152 <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
153 <tr>
154 <th class="colFirst" scope="col">Modifier and Type</th>
155 <th class="colLast" scope="col">Method and Description</th>
156 </tr>
157 <tr class="altColor">
158 <td class="colFirst"><code>void</code></td>
159 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Nucleobase.html#addCoveringRead(artificialFastqGenerator.Read)">addCoveringRead</a></strong>(<a href="../artificialFastqGenerator/Read.html" title="class in artificialFastqGenerator">Read</a>&nbsp;read)</code>
160 <div class="block">Add a read to the list of reads which cover this nucleobase.</div>
161 </td>
162 </tr>
163 <tr class="rowColor">
164 <td class="colFirst"><code>char</code></td>
165 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Nucleobase.html#getComplementGenotype()">getComplementGenotype</a></strong>()</code>
166 <div class="block">GEt the complement of the nucleobase's genotype.</div>
167 </td>
168 </tr>
169 <tr class="altColor">
170 <td class="colFirst"><code>int</code></td>
171 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Nucleobase.html#getCoverage()">getCoverage</a></strong>()</code>
172 <div class="block">Get the coverage for this nucleobase i.e.</div>
173 </td>
174 </tr>
175 <tr class="rowColor">
176 <td class="colFirst"><code>java.util.ArrayList&lt;<a href="../artificialFastqGenerator/Read.html" title="class in artificialFastqGenerator">Read</a>&gt;</code></td>
177 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Nucleobase.html#getCoveringReads()">getCoveringReads</a></strong>()</code>
178 <div class="block">Get the list of covering reads - the reads which include this nucleobase.</div>
179 </td>
180 </tr>
181 <tr class="altColor">
182 <td class="colFirst"><code>char</code></td>
183 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Nucleobase.html#getGenotype()">getGenotype</a></strong>()</code>
184 <div class="block">Get the nucleobase's genotype.</div>
185 </td>
186 </tr>
187 <tr class="rowColor">
188 <td class="colFirst"><code>int</code></td>
189 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Nucleobase.html#getTargetCoverage()">getTargetCoverage</a></strong>()</code>
190 <div class="block">Get the target coverage for this nucleobase (the number of reads that we want to
191 include this nucleobase).</div>
192 </td>
193 </tr>
194 <tr class="altColor">
195 <td class="colFirst"><code>long</code></td>
196 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Nucleobase.html#getUniqueID()">getUniqueID</a></strong>()</code>
197 <div class="block">Get the nucleobase's unique integer ID.</div>
198 </td>
199 </tr>
200 <tr class="rowColor">
201 <td class="colFirst"><code>boolean</code></td>
202 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Nucleobase.html#hasTargetCoverage()">hasTargetCoverage</a></strong>()</code>
203 <div class="block">Checks whether a nucleobase's coverage matches its target coverage.</div>
204 </td>
205 </tr>
206 <tr class="altColor">
207 <td class="colFirst"><code>void</code></td>
208 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Nucleobase.html#setGenotype(char)">setGenotype</a></strong>(char&nbsp;genotype)</code>
209 <div class="block">Set the nucleobase's genotype.</div>
210 </td>
211 </tr>
212 <tr class="rowColor">
213 <td class="colFirst"><code>void</code></td>
214 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Nucleobase.html#setTargetCoverage(int)">setTargetCoverage</a></strong>(int&nbsp;targetCoverage)</code>
215 <div class="block">Set the target coverage for this nucleobase (the number of reads we want to include
216 this nucleobase).</div>
217 </td>
218 </tr>
219 <tr class="altColor">
220 <td class="colFirst"><code>java.lang.String</code></td>
221 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Nucleobase.html#toString()">toString</a></strong>()</code>&nbsp;</td>
222 </tr>
223 </table>
224 <ul class="blockList">
225 <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
226 <!-- -->
227 </a>
228 <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
229 <code>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
230 </ul>
231 </li>
232 </ul>
233 </li>
234 </ul>
235 </div>
236 <div class="details">
237 <ul class="blockList">
238 <li class="blockList">
239 <!-- ========= CONSTRUCTOR DETAIL ======== -->
240 <ul class="blockList">
241 <li class="blockList"><a name="constructor_detail">
242 <!-- -->
243 </a>
244 <h3>Constructor Detail</h3>
245 <a name="Nucleobase(char, long, int)">
246 <!-- -->
247 </a>
248 <ul class="blockListLast">
249 <li class="blockList">
250 <h4>Nucleobase</h4>
251 <pre>public&nbsp;Nucleobase(char&nbsp;genotype,
252 long&nbsp;uniqueID,
253 int&nbsp;targetCoverage)</pre>
254 <div class="block">Initialise a new Nucleobase object.</div>
255 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>genotype</code> - - the nucleobase's genotype.</dd><dd><code>uniqueID</code> - - the nucleobase's unique integer ID.</dd><dd><code>targetCoverage</code> - - the nucleobase's target coverage.</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="getGenotype()">
267 <!-- -->
268 </a>
269 <ul class="blockList">
270 <li class="blockList">
271 <h4>getGenotype</h4>
272 <pre>public&nbsp;char&nbsp;getGenotype()</pre>
273 <div class="block">Get the nucleobase's genotype.</div>
274 <dl><dt><span class="strong">Returns:</span></dt><dd>genotype - the nucleobase's genotype.</dd></dl>
275 </li>
276 </ul>
277 <a name="getComplementGenotype()">
278 <!-- -->
279 </a>
280 <ul class="blockList">
281 <li class="blockList">
282 <h4>getComplementGenotype</h4>
283 <pre>public&nbsp;char&nbsp;getComplementGenotype()</pre>
284 <div class="block">GEt the complement of the nucleobase's genotype.</div>
285 <dl><dt><span class="strong">Returns:</span></dt><dd>complementGenotype - the complement of the nucleobase's genotype.</dd></dl>
286 </li>
287 </ul>
288 <a name="setGenotype(char)">
289 <!-- -->
290 </a>
291 <ul class="blockList">
292 <li class="blockList">
293 <h4>setGenotype</h4>
294 <pre>public&nbsp;void&nbsp;setGenotype(char&nbsp;genotype)</pre>
295 <div class="block">Set the nucleobase's genotype.</div>
296 </li>
297 </ul>
298 <a name="addCoveringRead(artificialFastqGenerator.Read)">
299 <!-- -->
300 </a>
301 <ul class="blockList">
302 <li class="blockList">
303 <h4>addCoveringRead</h4>
304 <pre>public&nbsp;void&nbsp;addCoveringRead(<a href="../artificialFastqGenerator/Read.html" title="class in artificialFastqGenerator">Read</a>&nbsp;read)</pre>
305 <div class="block">Add a read to the list of reads which cover this nucleobase.</div>
306 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>read</code> - - the read which covers this nucleobase.</dd></dl>
307 </li>
308 </ul>
309 <a name="getCoverage()">
310 <!-- -->
311 </a>
312 <ul class="blockList">
313 <li class="blockList">
314 <h4>getCoverage</h4>
315 <pre>public&nbsp;int&nbsp;getCoverage()</pre>
316 <div class="block">Get the coverage for this nucleobase i.e. the number of reads which include it.</div>
317 <dl><dt><span class="strong">Returns:</span></dt><dd>coverage - coverage of the nucleobase.</dd></dl>
318 </li>
319 </ul>
320 <a name="getCoveringReads()">
321 <!-- -->
322 </a>
323 <ul class="blockList">
324 <li class="blockList">
325 <h4>getCoveringReads</h4>
326 <pre>public&nbsp;java.util.ArrayList&lt;<a href="../artificialFastqGenerator/Read.html" title="class in artificialFastqGenerator">Read</a>&gt;&nbsp;getCoveringReads()</pre>
327 <div class="block">Get the list of covering reads - the reads which include this nucleobase.</div>
328 <dl><dt><span class="strong">Returns:</span></dt><dd>coveringReads - the ArrayList containing the reads which cover this nucleobase.</dd></dl>
329 </li>
330 </ul>
331 <a name="getUniqueID()">
332 <!-- -->
333 </a>
334 <ul class="blockList">
335 <li class="blockList">
336 <h4>getUniqueID</h4>
337 <pre>public&nbsp;long&nbsp;getUniqueID()</pre>
338 <div class="block">Get the nucleobase's unique integer ID.</div>
339 <dl><dt><span class="strong">Returns:</span></dt><dd>uniqueID - the nucleobase's unique integer ID.</dd></dl>
340 </li>
341 </ul>
342 <a name="getTargetCoverage()">
343 <!-- -->
344 </a>
345 <ul class="blockList">
346 <li class="blockList">
347 <h4>getTargetCoverage</h4>
348 <pre>public&nbsp;int&nbsp;getTargetCoverage()</pre>
349 <div class="block">Get the target coverage for this nucleobase (the number of reads that we want to
350 include this nucleobase).</div>
351 <dl><dt><span class="strong">Returns:</span></dt><dd>targetCoverage - the nucleobase's target coverage.</dd></dl>
352 </li>
353 </ul>
354 <a name="setTargetCoverage(int)">
355 <!-- -->
356 </a>
357 <ul class="blockList">
358 <li class="blockList">
359 <h4>setTargetCoverage</h4>
360 <pre>public&nbsp;void&nbsp;setTargetCoverage(int&nbsp;targetCoverage)</pre>
361 <div class="block">Set the target coverage for this nucleobase (the number of reads we want to include
362 this nucleobase).</div>
363 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>targetCoverage</code> - - the nucleobase's target coverage.</dd></dl>
364 </li>
365 </ul>
366 <a name="hasTargetCoverage()">
367 <!-- -->
368 </a>
369 <ul class="blockList">
370 <li class="blockList">
371 <h4>hasTargetCoverage</h4>
372 <pre>public&nbsp;boolean&nbsp;hasTargetCoverage()</pre>
373 <div class="block">Checks whether a nucleobase's coverage matches its target coverage.</div>
374 <dl><dt><span class="strong">Returns:</span></dt><dd>coverageMatchesTarget - true if the coverage is >= than the target, else false.</dd></dl>
375 </li>
376 </ul>
377 <a name="toString()">
378 <!-- -->
379 </a>
380 <ul class="blockListLast">
381 <li class="blockList">
382 <h4>toString</h4>
383 <pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
384 <dl>
385 <dt><strong>Overrides:</strong></dt>
386 <dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
387 </dl>
388 </li>
389 </ul>
390 </li>
391 </ul>
392 </li>
393 </ul>
394 </div>
395 </div>
396 <!-- ========= END OF CLASS DATA ========= -->
397 <!-- ======= START OF BOTTOM NAVBAR ====== -->
398 <div class="bottomNav"><a name="navbar_bottom">
399 <!-- -->
400 </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
401 <!-- -->
402 </a>
403 <ul class="navList" title="Navigation">
404 <li><a href="../artificialFastqGenerator/package-summary.html">Package</a></li>
405 <li class="navBarCell1Rev">Class</li>
406 <li><a href="class-use/Nucleobase.html">Use</a></li>
407 <li><a href="package-tree.html">Tree</a></li>
408 <li><a href="../deprecated-list.html">Deprecated</a></li>
409 <li><a href="../index-files/index-1.html">Index</a></li>
410 <li><a href="../help-doc.html">Help</a></li>
411 </ul>
412 </div>
413 <div class="subNav">
414 <ul class="navList">
415 <li><a href="../artificialFastqGenerator/Main.html" title="class in artificialFastqGenerator"><span class="strong">Prev Class</span></a></li>
416 <li><a href="../artificialFastqGenerator/NucleobaseAndReadFactory.html" title="class in artificialFastqGenerator"><span class="strong">Next Class</span></a></li>
417 </ul>
418 <ul class="navList">
419 <li><a href="../index.html?artificialFastqGenerator/Nucleobase.html" target="_top">Frames</a></li>
420 <li><a href="Nucleobase.html" target="_top">No Frames</a></li>
421 </ul>
422 <ul class="navList" id="allclasses_navbar_bottom">
423 <li><a href="../allclasses-noframe.html">All Classes</a></li>
424 </ul>
425 <div>
426 <script type="text/javascript"><!--
427 allClassesLink = document.getElementById("allclasses_navbar_bottom");
428 if(window==top) {
429 allClassesLink.style.display = "block";
430 }
431 else {
432 allClassesLink.style.display = "none";
433 }
434 //-->
435 </script>
436 </div>
437 <div>
438 <ul class="subNavList">
439 <li>Summary:&nbsp;</li>
440 <li>Nested&nbsp;|&nbsp;</li>
441 <li>Field&nbsp;|&nbsp;</li>
442 <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
443 <li><a href="#method_summary">Method</a></li>
444 </ul>
445 <ul class="subNavList">
446 <li>Detail:&nbsp;</li>
447 <li>Field&nbsp;|&nbsp;</li>
448 <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
449 <li><a href="#method_detail">Method</a></li>
450 </ul>
451 </div>
452 <a name="skip-navbar_bottom">
453 <!-- -->
454 </a></div>
455 <!-- ======== END OF BOTTOM NAVBAR ======= -->
456 </body>
457 </html>