website/docs/full_javadoc/compbio/engine/conf/PropertyHelperManager.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:50 BST 2017 -->
   6 <title>PropertyHelperManager</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="PropertyHelperManager";
  16         }
  17     }
  18     catch(err) {
  19     }
  20 //-->
  21 var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9};
  22 var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/PropertyHelperManager.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/engine/conf/DirectoryManager.html" title="class in compbio.engine.conf"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53 <li><a href="../../../compbio/engine/conf/RunnerConfigMarshaller.html" title="class in compbio.engine.conf"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54 </ul>
  55 <ul class="navList">
  56 <li><a href="../../../index.html?compbio/engine/conf/PropertyHelperManager.html" target="_top">Frames</a></li>
  57 <li><a href="PropertyHelperManager.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.engine.conf</div>
  96 <h2 title="Class PropertyHelperManager" class="title">Class PropertyHelperManager</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.engine.conf.PropertyHelperManager</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>public final class <span class="typeNameLabel">PropertyHelperManager</span>
 113 extends java.lang.Object</pre>
 114 </li>
 115 </ul>
 116 </div>
 117 <div class="summary">
 118 <ul class="blockList">
 119 <li class="blockList">
 120 <!-- =========== FIELD SUMMARY =========== -->
 121 <ul class="blockList">
 122 <li class="blockList"><a name="field.summary">
 123 <!--   -->
 124 </a>
 125 <h3>Field Summary</h3>
 126 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
 127 <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
 128 <tr>
 129 <th class="colFirst" scope="col">Modifier and Type</th>
 130 <th class="colLast" scope="col">Field and Description</th>
 131 </tr>
 132 <tr class="altColor">
 133 <td class="colFirst"><code>static java.lang.String</code></td>
 134 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/engine/conf/PropertyHelperManager.html#confDir">confDir</a></span></code>&nbsp;</td>
 135 </tr>
 136 <tr class="rowColor">
 137 <td class="colFirst"><code>private static org.apache.log4j.Logger</code></td>
 138 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/engine/conf/PropertyHelperManager.html#log">log</a></span></code>&nbsp;</td>
 139 </tr>
 140 <tr class="altColor">
 141 <td class="colFirst"><code>private static compbio.util.PropertyHelper</code></td>
 142 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/engine/conf/PropertyHelperManager.html#ph">ph</a></span></code>&nbsp;</td>
 143 </tr>
 144 </table>
 145 </li>
 146 </ul>
 147 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 148 <ul class="blockList">
 149 <li class="blockList"><a name="constructor.summary">
 150 <!--   -->
 151 </a>
 152 <h3>Constructor Summary</h3>
 153 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
 154 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
 155 <tr>
 156 <th class="colOne" scope="col">Constructor and Description</th>
 157 </tr>
 158 <tr class="altColor">
 159 <td class="colOne"><code><span class="memberNameLink"><a href="../../../compbio/engine/conf/PropertyHelperManager.html#PropertyHelperManager--">PropertyHelperManager</a></span>()</code>&nbsp;</td>
 160 </tr>
 161 </table>
 162 </li>
 163 </ul>
 164 <!-- ========== METHOD SUMMARY =========== -->
 165 <ul class="blockList">
 166 <li class="blockList"><a name="method.summary">
 167 <!--   -->
 168 </a>
 169 <h3>Method Summary</h3>
 170 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
 171 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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>
 172 <tr>
 173 <th class="colFirst" scope="col">Modifier and Type</th>
 174 <th class="colLast" scope="col">Method and Description</th>
 175 </tr>
 176 <tr id="i0" class="altColor">
 177 <td class="colFirst"><code>static boolean</code></td>
 178 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/engine/conf/PropertyHelperManager.html#getBooleanProperty-java.lang.String-">getBooleanProperty</a></span>(java.lang.String&nbsp;propValue)</code>&nbsp;</td>
 179 </tr>
 180 <tr id="i1" class="rowColor">
 181 <td class="colFirst"><code>static int</code></td>
 182 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/engine/conf/PropertyHelperManager.html#getIntProperty-java.lang.String-">getIntProperty</a></span>(java.lang.String&nbsp;propValue)</code>&nbsp;</td>
 183 </tr>
 184 <tr id="i2" class="altColor">
 185 <td class="colFirst"><code>static java.lang.String</code></td>
 186 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/engine/conf/PropertyHelperManager.html#getLocalPath--">getLocalPath</a></span>()</code>
 187 <div class="block">Method return the absolute path to the project root directory.</div>
 188 </td>
 189 </tr>
 190 <tr id="i3" class="rowColor">
 191 <td class="colFirst"><code>static compbio.util.PropertyHelper</code></td>
 192 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/engine/conf/PropertyHelperManager.html#getPropertyHelper--">getPropertyHelper</a></span>()</code>
 193 <div class="block">Ways to fix path problem:
 194  1) find a path to WEB-INF directory based on the path to a known class.</div>
 195 </td>
 196 </tr>
 197 <tr id="i4" class="altColor">
 198 <td class="colFirst"><code>(package private) static java.io.File</code></td>
 199 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/engine/conf/PropertyHelperManager.html#getResourceFromClasspath-java.lang.String-">getResourceFromClasspath</a></span>(java.lang.String&nbsp;resourceName)</code>&nbsp;</td>
 200 </tr>
 201 </table>
 202 <ul class="blockList">
 203 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
 204 <!--   -->
 205 </a>
 206 <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
 207 <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
 208 </ul>
 209 </li>
 210 </ul>
 211 </li>
 212 </ul>
 213 </div>
 214 <div class="details">
 215 <ul class="blockList">
 216 <li class="blockList">
 217 <!-- ============ FIELD DETAIL =========== -->
 218 <ul class="blockList">
 219 <li class="blockList"><a name="field.detail">
 220 <!--   -->
 221 </a>
 222 <h3>Field Detail</h3>
 223 <a name="log">
 224 <!--   -->
 225 </a>
 226 <ul class="blockList">
 227 <li class="blockList">
 228 <h4>log</h4>
 229 <pre>private static&nbsp;org.apache.log4j.Logger log</pre>
 230 </li>
 231 </ul>
 232 <a name="ph">
 233 <!--   -->
 234 </a>
 235 <ul class="blockList">
 236 <li class="blockList">
 237 <h4>ph</h4>
 238 <pre>private static&nbsp;compbio.util.PropertyHelper ph</pre>
 239 </li>
 240 </ul>
 241 <a name="confDir">
 242 <!--   -->
 243 </a>
 244 <ul class="blockListLast">
 245 <li class="blockList">
 246 <h4>confDir</h4>
 247 <pre>public static final&nbsp;java.lang.String confDir</pre>
 248 </li>
 249 </ul>
 250 </li>
 251 </ul>
 252 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 253 <ul class="blockList">
 254 <li class="blockList"><a name="constructor.detail">
 255 <!--   -->
 256 </a>
 257 <h3>Constructor Detail</h3>
 258 <a name="PropertyHelperManager--">
 259 <!--   -->
 260 </a>
 261 <ul class="blockListLast">
 262 <li class="blockList">
 263 <h4>PropertyHelperManager</h4>
 264 <pre>public&nbsp;PropertyHelperManager()</pre>
 265 </li>
 266 </ul>
 267 </li>
 268 </ul>
 269 <!-- ============ METHOD DETAIL ========== -->
 270 <ul class="blockList">
 271 <li class="blockList"><a name="method.detail">
 272 <!--   -->
 273 </a>
 274 <h3>Method Detail</h3>
 275 <a name="getPropertyHelper--">
 276 <!--   -->
 277 </a>
 278 <ul class="blockList">
 279 <li class="blockList">
 280 <h4>getPropertyHelper</h4>
 281 <pre>public static&nbsp;compbio.util.PropertyHelper&nbsp;getPropertyHelper()</pre>
 282 <div class="block">Ways to fix path problem:
 283  1) find a path to WEB-INF directory based on the path to a known class.
 284  Then prepend this absolute path to the rest of paths
 285  pros: no input from user
 286  cons: relocation of the source may cause problems
 287
 288  2) Require users to add configuration directories to the class
 289  path and then load entries from it.
 290  pros:
 291  cons: Many paths needs to be added. Put significant burden on the user.
 292  Hard to tell web appl server to add these entries to its class path.
 293
 294  3) Ask for project source directory explicitly in the configuration.
 295  pros:
 296  cons: similar to 1, but this initial configuration file must reside in
 297  well known location! Why ask users what can be found automatically?
 298
 299  4) Have everything in the location already in class path for tomcat.
 300  pros:
 301  cons: only classes and lib/*.jar are added, Eclipse will remove non
 302  classses from classes dir.
 303
 304  Try 1 - succeed.</div>
 305 <dl>
 306 <dt><span class="returnLabel">Returns:</span></dt>
 307 <dd>an instance</dd>
 308 </dl>
 309 </li>
 310 </ul>
 311 <a name="getResourceFromClasspath-java.lang.String-">
 312 <!--   -->
 313 </a>
 314 <ul class="blockList">
 315 <li class="blockList">
 316 <h4>getResourceFromClasspath</h4>
 317 <pre>static&nbsp;java.io.File&nbsp;getResourceFromClasspath(java.lang.String&nbsp;resourceName)</pre>
 318 </li>
 319 </ul>
 320 <a name="getLocalPath--">
 321 <!--   -->
 322 </a>
 323 <ul class="blockList">
 324 <li class="blockList">
 325 <h4>getLocalPath</h4>
 326 <pre>public static&nbsp;java.lang.String&nbsp;getLocalPath()</pre>
 327 <div class="block">Method return the absolute path to the project root directory. It assumes
 328  the following structure of the project:
 329  project-root:
 330  conf/settings
 331  binaries
 332  WEB-INF/classes/compbio/engine/conf/PropertyHelperManager.class
 333  If the structure changes it must be reflected in this method</div>
 334 <dl>
 335 <dt><span class="returnLabel">Returns:</span></dt>
 336 <dd>the local path</dd>
 337 <dt><span class="throwsLabel">Throws:</span></dt>
 338 <dd><code>java.lang.RuntimeException</code> - if cannot determine the local path</dd>
 339 </dl>
 340 </li>
 341 </ul>
 342 <a name="getIntProperty-java.lang.String-">
 343 <!--   -->
 344 </a>
 345 <ul class="blockList">
 346 <li class="blockList">
 347 <h4>getIntProperty</h4>
 348 <pre>public static&nbsp;int&nbsp;getIntProperty(java.lang.String&nbsp;propValue)</pre>
 349 </li>
 350 </ul>
 351 <a name="getBooleanProperty-java.lang.String-">
 352 <!--   -->
 353 </a>
 354 <ul class="blockListLast">
 355 <li class="blockList">
 356 <h4>getBooleanProperty</h4>
 357 <pre>public static&nbsp;boolean&nbsp;getBooleanProperty(java.lang.String&nbsp;propValue)</pre>
 358 </li>
 359 </ul>
 360 </li>
 361 </ul>
 362 </li>
 363 </ul>
 364 </div>
 365 </div>
 366 <!-- ========= END OF CLASS DATA ========= -->
 367 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 368 <div class="bottomNav"><a name="navbar.bottom">
 369 <!--   -->
 370 </a>
 371 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 372 <a name="navbar.bottom.firstrow">
 373 <!--   -->
 374 </a>
 375 <ul class="navList" title="Navigation">
 376 <li><a href="../../../overview-summary.html">Overview</a></li>
 377 <li><a href="package-summary.html">Package</a></li>
 378 <li class="navBarCell1Rev">Class</li>
 379 <li><a href="class-use/PropertyHelperManager.html">Use</a></li>
 380 <li><a href="package-tree.html">Tree</a></li>
 381 <li><a href="../../../deprecated-list.html">Deprecated</a></li>
 382 <li><a href="../../../index-files/index-1.html">Index</a></li>
 383 <li><a href="../../../help-doc.html">Help</a></li>
 384 </ul>
 385 </div>
 386 <div class="subNav">
 387 <ul class="navList">
 388 <li><a href="../../../compbio/engine/conf/DirectoryManager.html" title="class in compbio.engine.conf"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 389 <li><a href="../../../compbio/engine/conf/RunnerConfigMarshaller.html" title="class in compbio.engine.conf"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 390 </ul>
 391 <ul class="navList">
 392 <li><a href="../../../index.html?compbio/engine/conf/PropertyHelperManager.html" target="_top">Frames</a></li>
 393 <li><a href="PropertyHelperManager.html" target="_top">No&nbsp;Frames</a></li>
 394 </ul>
 395 <ul class="navList" id="allclasses_navbar_bottom">
 396 <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
 397 </ul>
 398 <div>
 399 <script type="text/javascript"><!--
 400   allClassesLink = document.getElementById("allclasses_navbar_bottom");
 401   if(window==top) {
 402     allClassesLink.style.display = "block";
 403   }
 404   else {
 405     allClassesLink.style.display = "none";
 406   }
 407   //-->
 408 </script>
 409 </div>
 410 <div>
 411 <ul class="subNavList">
 412 <li>Summary:&nbsp;</li>
 413 <li>Nested&nbsp;|&nbsp;</li>
 414 <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
 415 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
 416 <li><a href="#method.summary">Method</a></li>
 417 </ul>
 418 <ul class="subNavList">
 419 <li>Detail:&nbsp;</li>
 420 <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
 421 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
 422 <li><a href="#method.detail">Method</a></li>
 423 </ul>
 424 </div>
 425 <a name="skip.navbar.bottom">
 426 <!--   -->
 427 </a></div>
 428 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 429 </body>
 430 </html>