website/docs/full_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">
   2 <!-- NewPage -->
   3 <html lang="en">
   4 <head>
   5 <!-- Generated by javadoc (1.8.0_121) on Fri Apr 21 15:32:49 BST 2017 -->
   6 <title>AlignmentMetadata</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>
  10 </head>
  11 <body>
  12 <script type="text/javascript"><!--
  13     try {
  14         if (location.href.indexOf('is-external=true') == -1) {
  15             parent.document.title="AlignmentMetadata";
  16         }
  17     }
  18     catch(err) {
  19     }
  20 //-->
  21 var methods = {"i0":10,"i1":10,"i2":10,"i3":10};
  22 var tabs = {65535:["t0","All 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";
  27 </script>
  28 <noscript>
  29 <div>JavaScript is disabled on your browser.</div>
  30 </noscript>
  31 <!-- ========= START OF TOP NAVBAR ======= -->
  32 <div class="topNav"><a name="navbar.top">
  33 <!--   -->
  34 </a>
  35 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  36 <a name="navbar.top.firstrow">
  37 <!--   -->
  38 </a>
  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/AlignmentMetadata.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>
  48 </ul>
  49 </div>
  50 <div class="subNav">
  51 <ul class="navList">
  52 <li><a href="../../../compbio/data/sequence/Alignment.html" title="class in compbio.data.sequence"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53 <li><a href="../../../compbio/data/sequence/ClustalAlignmentUtil.html" title="class in compbio.data.sequence"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54 </ul>
  55 <ul class="navList">
  56 <li><a href="../../../index.html?compbio/data/sequence/AlignmentMetadata.html" target="_top">Frames</a></li>
  57 <li><a href="AlignmentMetadata.html" target="_top">No&nbsp;Frames</a></li>
  58 </ul>
  59 <ul class="navList" id="allclasses_navbar_top">
  60 <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  61 </ul>
  62 <div>
  63 <script type="text/javascript"><!--
  64   allClassesLink = document.getElementById("allclasses_navbar_top");
  65   if(window==top) {
  66     allClassesLink.style.display = "block";
  67   }
  68   else {
  69     allClassesLink.style.display = "none";
  70   }
  71   //-->
  72 </script>
  73 </div>
  74 <div>
  75 <ul class="subNavList">
  76 <li>Summary:&nbsp;</li>
  77 <li>Nested&nbsp;|&nbsp;</li>
  78 <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
  79 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  80 <li><a href="#method.summary">Method</a></li>
  81 </ul>
  82 <ul class="subNavList">
  83 <li>Detail:&nbsp;</li>
  84 <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
  85 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  86 <li><a href="#method.detail">Method</a></li>
  87 </ul>
  88 </div>
  89 <a name="skip.navbar.top">
  90 <!--   -->
  91 </a></div>
  92 <!-- ========= END OF TOP NAVBAR ========= -->
  93 <!-- ======== START OF CLASS DATA ======== -->
  94 <div class="header">
  95 <div class="subTitle">compbio.data.sequence</div>
  96 <h2 title="Class AlignmentMetadata" class="title">Class AlignmentMetadata</h2>
  97 </div>
  98 <div class="contentContainer">
  99 <ul class="inheritance">
 100 <li>java.lang.Object</li>
 101 <li>
 102 <ul class="inheritance">
 103 <li>compbio.data.sequence.AlignmentMetadata</li>
 104 </ul>
 105 </li>
 106 </ul>
 107 <div class="description">
 108 <ul class="blockList">
 109 <li class="blockList">
 110 <hr>
 111 <br>
 112 <pre>@Immutable
 113 public class <span class="typeNameLabel">AlignmentMetadata</span>
 114 extends java.lang.Object</pre>
 115 <div class="block">Alignment metadata e.g. method/program being used to generate the alignment
 116  and its parameters</div>
 117 <dl>
 118 <dt><span class="simpleTagLabel">Version:</span></dt>
 119 <dd>1.0 September 2009</dd>
 120 <dt><span class="simpleTagLabel">Author:</span></dt>
 121 <dd>pvtroshin</dd>
 122 </dl>
 123 </li>
 124 </ul>
 125 </div>
 126 <div class="summary">
 127 <ul class="blockList">
 128 <li class="blockList">
 129 <!-- =========== FIELD SUMMARY =========== -->
 130 <ul class="blockList">
 131 <li class="blockList"><a name="field.summary">
 132 <!--   -->
 133 </a>
 134 <h3>Field Summary</h3>
 135 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
 136 <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
 137 <tr>
 138 <th class="colFirst" scope="col">Modifier and Type</th>
 139 <th class="colLast" scope="col">Field and Description</th>
 140 </tr>
 141 <tr class="altColor">
 142 <td class="colFirst"><code>private char</code></td>
 143 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/AlignmentMetadata.html#gapchar">gapchar</a></span></code>&nbsp;</td>
 144 </tr>
 145 <tr class="rowColor">
 146 <td class="colFirst"><code>private <a href="../../../compbio/data/sequence/Program.html" title="enum in compbio.data.sequence">Program</a></code></td>
 147 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/AlignmentMetadata.html#program">program</a></span></code>&nbsp;</td>
 148 </tr>
 149 </table>
 150 </li>
 151 </ul>
 152 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 153 <ul class="blockList">
 154 <li class="blockList"><a name="constructor.summary">
 155 <!--   -->
 156 </a>
 157 <h3>Constructor Summary</h3>
 158 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
 159 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
 160 <tr>
 161 <th class="colFirst" scope="col">Modifier</th>
 162 <th class="colLast" scope="col">Constructor and Description</th>
 163 </tr>
 164 <tr class="altColor">
 165 <td class="colFirst"><code>private </code></td>
 166 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/AlignmentMetadata.html#AlignmentMetadata--">AlignmentMetadata</a></span>()</code>&nbsp;</td>
 167 </tr>
 168 <tr class="rowColor">
 169 <td class="colFirst"><code>&nbsp;</code></td>
 170 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/AlignmentMetadata.html#AlignmentMetadata-compbio.data.sequence.Program-char-">AlignmentMetadata</a></span>(<a href="../../../compbio/data/sequence/Program.html" title="enum in compbio.data.sequence">Program</a>&nbsp;program,
 171                  char&nbsp;gapchar)</code>&nbsp;</td>
 172 </tr>
 173 </table>
 174 </li>
 175 </ul>
 176 <!-- ========== METHOD SUMMARY =========== -->
 177 <ul class="blockList">
 178 <li class="blockList"><a name="method.summary">
 179 <!--   -->
 180 </a>
 181 <h3>Method Summary</h3>
 182 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
 183 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
 184 <tr>
 185 <th class="colFirst" scope="col">Modifier and Type</th>
 186 <th class="colLast" scope="col">Method and Description</th>
 187 </tr>
 188 <tr id="i0" class="altColor">
 189 <td class="colFirst"><code>boolean</code></td>
 190 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/AlignmentMetadata.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>&nbsp;</td>
 191 </tr>
 192 <tr id="i1" class="rowColor">
 193 <td class="colFirst"><code>char</code></td>
 194 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/AlignmentMetadata.html#getGapchar--">getGapchar</a></span>()</code>&nbsp;</td>
 195 </tr>
 196 <tr id="i2" class="altColor">
 197 <td class="colFirst"><code><a href="../../../compbio/data/sequence/Program.html" title="enum in compbio.data.sequence">Program</a></code></td>
 198 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/AlignmentMetadata.html#getProgram--">getProgram</a></span>()</code>&nbsp;</td>
 199 </tr>
 200 <tr id="i3" class="rowColor">
 201 <td class="colFirst"><code>int</code></td>
 202 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/AlignmentMetadata.html#hashCode--">hashCode</a></span>()</code>&nbsp;</td>
 203 </tr>
 204 </table>
 205 <ul class="blockList">
 206 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
 207 <!--   -->
 208 </a>
 209 <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
 210 <code>clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait</code></li>
 211 </ul>
 212 </li>
 213 </ul>
 214 </li>
 215 </ul>
 216 </div>
 217 <div class="details">
 218 <ul class="blockList">
 219 <li class="blockList">
 220 <!-- ============ FIELD DETAIL =========== -->
 221 <ul class="blockList">
 222 <li class="blockList"><a name="field.detail">
 223 <!--   -->
 224 </a>
 225 <h3>Field Detail</h3>
 226 <a name="program">
 227 <!--   -->
 228 </a>
 229 <ul class="blockList">
 230 <li class="blockList">
 231 <h4>program</h4>
 232 <pre>private&nbsp;<a href="../../../compbio/data/sequence/Program.html" title="enum in compbio.data.sequence">Program</a> program</pre>
 233 </li>
 234 </ul>
 235 <a name="gapchar">
 236 <!--   -->
 237 </a>
 238 <ul class="blockListLast">
 239 <li class="blockList">
 240 <h4>gapchar</h4>
 241 <pre>private&nbsp;char gapchar</pre>
 242 </li>
 243 </ul>
 244 </li>
 245 </ul>
 246 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 247 <ul class="blockList">
 248 <li class="blockList"><a name="constructor.detail">
 249 <!--   -->
 250 </a>
 251 <h3>Constructor Detail</h3>
 252 <a name="AlignmentMetadata--">
 253 <!--   -->
 254 </a>
 255 <ul class="blockList">
 256 <li class="blockList">
 257 <h4>AlignmentMetadata</h4>
 258 <pre>private&nbsp;AlignmentMetadata()</pre>
 259 </li>
 260 </ul>
 261 <a name="AlignmentMetadata-compbio.data.sequence.Program-char-">
 262 <!--   -->
 263 </a>
 264 <ul class="blockListLast">
 265 <li class="blockList">
 266 <h4>AlignmentMetadata</h4>
 267 <pre>public&nbsp;AlignmentMetadata(<a href="../../../compbio/data/sequence/Program.html" title="enum in compbio.data.sequence">Program</a>&nbsp;program,
 268                          char&nbsp;gapchar)</pre>
 269 </li>
 270 </ul>
 271 </li>
 272 </ul>
 273 <!-- ============ METHOD DETAIL ========== -->
 274 <ul class="blockList">
 275 <li class="blockList"><a name="method.detail">
 276 <!--   -->
 277 </a>
 278 <h3>Method Detail</h3>
 279 <a name="getProgram--">
 280 <!--   -->
 281 </a>
 282 <ul class="blockList">
 283 <li class="blockList">
 284 <h4>getProgram</h4>
 285 <pre>public&nbsp;<a href="../../../compbio/data/sequence/Program.html" title="enum in compbio.data.sequence">Program</a>&nbsp;getProgram()</pre>
 286 </li>
 287 </ul>
 288 <a name="getGapchar--">
 289 <!--   -->
 290 </a>
 291 <ul class="blockList">
 292 <li class="blockList">
 293 <h4>getGapchar</h4>
 294 <pre>public&nbsp;char&nbsp;getGapchar()</pre>
 295 </li>
 296 </ul>
 297 <a name="equals-java.lang.Object-">
 298 <!--   -->
 299 </a>
 300 <ul class="blockList">
 301 <li class="blockList">
 302 <h4>equals</h4>
 303 <pre>public&nbsp;boolean&nbsp;equals(java.lang.Object&nbsp;obj)</pre>
 304 <dl>
 305 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
 306 <dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
 307 </dl>
 308 </li>
 309 </ul>
 310 <a name="hashCode--">
 311 <!--   -->
 312 </a>
 313 <ul class="blockListLast">
 314 <li class="blockList">
 315 <h4>hashCode</h4>
 316 <pre>public&nbsp;int&nbsp;hashCode()</pre>
 317 <dl>
 318 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
 319 <dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
 320 </dl>
 321 </li>
 322 </ul>
 323 </li>
 324 </ul>
 325 </li>
 326 </ul>
 327 </div>
 328 </div>
 329 <!-- ========= END OF CLASS DATA ========= -->
 330 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 331 <div class="bottomNav"><a name="navbar.bottom">
 332 <!--   -->
 333 </a>
 334 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 335 <a name="navbar.bottom.firstrow">
 336 <!--   -->
 337 </a>
 338 <ul class="navList" title="Navigation">
 339 <li><a href="../../../overview-summary.html">Overview</a></li>
 340 <li><a href="package-summary.html">Package</a></li>
 341 <li class="navBarCell1Rev">Class</li>
 342 <li><a href="class-use/AlignmentMetadata.html">Use</a></li>
 343 <li><a href="package-tree.html">Tree</a></li>
 344 <li><a href="../../../deprecated-list.html">Deprecated</a></li>
 345 <li><a href="../../../index-files/index-1.html">Index</a></li>
 346 <li><a href="../../../help-doc.html">Help</a></li>
 347 </ul>
 348 </div>
 349 <div class="subNav">
 350 <ul class="navList">
 351 <li><a href="../../../compbio/data/sequence/Alignment.html" title="class in compbio.data.sequence"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 352 <li><a href="../../../compbio/data/sequence/ClustalAlignmentUtil.html" title="class in compbio.data.sequence"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 353 </ul>
 354 <ul class="navList">
 355 <li><a href="../../../index.html?compbio/data/sequence/AlignmentMetadata.html" target="_top">Frames</a></li>
 356 <li><a href="AlignmentMetadata.html" target="_top">No&nbsp;Frames</a></li>
 357 </ul>
 358 <ul class="navList" id="allclasses_navbar_bottom">
 359 <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
 360 </ul>
 361 <div>
 362 <script type="text/javascript"><!--
 363   allClassesLink = document.getElementById("allclasses_navbar_bottom");
 364   if(window==top) {
 365     allClassesLink.style.display = "block";
 366   }
 367   else {
 368     allClassesLink.style.display = "none";
 369   }
 370   //-->
 371 </script>
 372 </div>
 373 <div>
 374 <ul class="subNavList">
 375 <li>Summary:&nbsp;</li>
 376 <li>Nested&nbsp;|&nbsp;</li>
 377 <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
 378 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
 379 <li><a href="#method.summary">Method</a></li>
 380 </ul>
 381 <ul class="subNavList">
 382 <li>Detail:&nbsp;</li>
 383 <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
 384 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
 385 <li><a href="#method.detail">Method</a></li>
 386 </ul>
 387 </div>
 388 <a name="skip.navbar.bottom">
 389 <!--   -->
 390 </a></div>
 391 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 392 </body>
 393 </html>