updated javadoc
[jabaws.git] / website / 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">\r
2 <!--NewPage-->\r
3 <HTML>\r
4 <HEAD>\r
5 <!-- Generated by javadoc (build 1.6.0_24) on Fri Aug 12 14:32:35 BST 2011 -->\r
6 <TITLE>\r
7 PropertyHelperManager\r
8 </TITLE>\r
9 \r
10 <META NAME="date" CONTENT="2011-08-12">\r
11 \r
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">\r
13 \r
14 <SCRIPT type="text/javascript">\r
15 function windowTitle()\r
16 {\r
17     if (location.href.indexOf('is-external=true') == -1) {\r
18         parent.document.title="PropertyHelperManager";\r
19     }\r
20 }\r
21 </SCRIPT>\r
22 <NOSCRIPT>\r
23 </NOSCRIPT>\r
24 \r
25 </HEAD>\r
26 \r
27 <BODY BGCOLOR="white" onload="windowTitle();">\r
28 <HR>\r
29 \r
30 \r
31 <!-- ========= START OF TOP NAVBAR ======= -->\r
32 <A NAME="navbar_top"><!-- --></A>\r
33 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>\r
34 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
35 <TR>\r
36 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
37 <A NAME="navbar_top_firstrow"><!-- --></A>\r
38 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
39   <TR ALIGN="center" VALIGN="top">\r
40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
42   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/PropertyHelperManager.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
44   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
45   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
46   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
47   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
48   </TR>\r
49 </TABLE>\r
50 </TD>\r
51 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
52 </EM>\r
53 </TD>\r
54 </TR>\r
55 \r
56 <TR>\r
57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
58 &nbsp;<A HREF="../../../compbio/engine/conf/DirectoryManager.html" title="class in compbio.engine.conf"><B>PREV CLASS</B></A>&nbsp;\r
59 &nbsp;<A HREF="../../../compbio/engine/conf/RunnerConfigMarshaller.html" title="class in compbio.engine.conf"><B>NEXT CLASS</B></A></FONT></TD>\r
60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
61   <A HREF="../../../index.html?compbio/engine/conf/PropertyHelperManager.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
62 &nbsp;<A HREF="PropertyHelperManager.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
63 &nbsp;<SCRIPT type="text/javascript">\r
64   <!--\r
65   if(window==top) {\r
66     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
67   }\r
68   //-->\r
69 </SCRIPT>\r
70 <NOSCRIPT>\r
71   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
72 </NOSCRIPT>\r
73 \r
74 \r
75 </FONT></TD>\r
76 </TR>\r
77 <TR>\r
78 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
79   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
80 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
81 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
82 </TR>\r
83 </TABLE>\r
84 <A NAME="skip-navbar_top"></A>\r
85 <!-- ========= END OF TOP NAVBAR ========= -->\r
86 \r
87 <HR>\r
88 <!-- ======== START OF CLASS DATA ======== -->\r
89 <H2>\r
90 <FONT SIZE="-1">\r
91 compbio.engine.conf</FONT>\r
92 <BR>\r
93 Class PropertyHelperManager</H2>\r
94 <PRE>\r
95 <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>\r
96   <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>compbio.engine.conf.PropertyHelperManager</B>\r
97 </PRE>\r
98 <HR>\r
99 <DL>\r
100 <DT><PRE>public final class <B>PropertyHelperManager</B><DT>extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL>\r
101 </PRE>\r
102 \r
103 <P>\r
104 <HR>\r
105 \r
106 <P>\r
107 <!-- =========== FIELD SUMMARY =========== -->\r
108 \r
109 <A NAME="field_summary"><!-- --></A>\r
110 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
111 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
112 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
113 <B>Field Summary</B></FONT></TH>\r
114 </TR>\r
115 <TR BGCOLOR="white" CLASS="TableRowColor">\r
116 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
117 <CODE>static&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>\r
118 <TD><CODE><B><A HREF="../../../compbio/engine/conf/PropertyHelperManager.html#confDir">confDir</A></B></CODE>\r
119 \r
120 <BR>\r
121 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
122 </TR>\r
123 </TABLE>\r
124 &nbsp;\r
125 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
126 \r
127 <A NAME="constructor_summary"><!-- --></A>\r
128 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
129 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
130 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
131 <B>Constructor Summary</B></FONT></TH>\r
132 </TR>\r
133 <TR BGCOLOR="white" CLASS="TableRowColor">\r
134 <TD><CODE><B><A HREF="../../../compbio/engine/conf/PropertyHelperManager.html#PropertyHelperManager()">PropertyHelperManager</A></B>()</CODE>\r
135 \r
136 <BR>\r
137 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
138 </TR>\r
139 </TABLE>\r
140 &nbsp;\r
141 <!-- ========== METHOD SUMMARY =========== -->\r
142 \r
143 <A NAME="method_summary"><!-- --></A>\r
144 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
145 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
146 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
147 <B>Method Summary</B></FONT></TH>\r
148 </TR>\r
149 <TR BGCOLOR="white" CLASS="TableRowColor">\r
150 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
151 <CODE>static&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>\r
152 <TD><CODE><B><A HREF="../../../compbio/engine/conf/PropertyHelperManager.html#getLocalPath()">getLocalPath</A></B>()</CODE>\r
153 \r
154 <BR>\r
155 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Method return the absolute path to the project root directory.</TD>\r
156 </TR>\r
157 <TR BGCOLOR="white" CLASS="TableRowColor">\r
158 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
159 <CODE>static&nbsp;compbio.util.PropertyHelper</CODE></FONT></TD>\r
160 <TD><CODE><B><A HREF="../../../compbio/engine/conf/PropertyHelperManager.html#getPropertyHelper()">getPropertyHelper</A></B>()</CODE>\r
161 \r
162 <BR>\r
163 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Ways to fix path problem: 1) find a path to WEB-INF directory based on
164  the path to a known class.</TD>\r
165 </TR>\r
166 </TABLE>\r
167 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
168 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
169 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
170 <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>\r
171 </TR>\r
172 <TR BGCOLOR="white" CLASS="TableRowColor">\r
173 <TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>\r
174 </TR>\r
175 </TABLE>\r
176 &nbsp;\r
177 <P>\r
178 \r
179 <!-- ============ FIELD DETAIL =========== -->\r
180 \r
181 <A NAME="field_detail"><!-- --></A>\r
182 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
183 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
184 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
185 <B>Field Detail</B></FONT></TH>\r
186 </TR>\r
187 </TABLE>\r
188 \r
189 <A NAME="confDir"><!-- --></A><H3>\r
190 confDir</H3>\r
191 <PRE>\r
192 public static final <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>confDir</B></PRE>\r
193 <DL>\r
194 <DL>\r
195 </DL>\r
196 </DL>\r
197 \r
198 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
199 \r
200 <A NAME="constructor_detail"><!-- --></A>\r
201 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
202 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
203 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
204 <B>Constructor Detail</B></FONT></TH>\r
205 </TR>\r
206 </TABLE>\r
207 \r
208 <A NAME="PropertyHelperManager()"><!-- --></A><H3>\r
209 PropertyHelperManager</H3>\r
210 <PRE>\r
211 public <B>PropertyHelperManager</B>()</PRE>\r
212 <DL>\r
213 </DL>\r
214 \r
215 <!-- ============ METHOD DETAIL ========== -->\r
216 \r
217 <A NAME="method_detail"><!-- --></A>\r
218 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
219 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
220 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
221 <B>Method Detail</B></FONT></TH>\r
222 </TR>\r
223 </TABLE>\r
224 \r
225 <A NAME="getPropertyHelper()"><!-- --></A><H3>\r
226 getPropertyHelper</H3>\r
227 <PRE>\r
228 public static compbio.util.PropertyHelper <B>getPropertyHelper</B>()</PRE>\r
229 <DL>\r
230 <DD>Ways to fix path problem: 1) find a path to WEB-INF directory based on
231  the path to a known class. Then prepend this absolute path to the rest of
232  paths pros: no input from user cons: relocation of the source may cause
233  problems 2) Require users to add configuration directories to the class
234  path and then load entries from it. pros: cons: Many paths needs to be
235  added. Put significant burden on the user. Hard to tell web appl server
236  to add these entries to its class path. 3) Ask for project source
237  directory explicitly in the configuration. pros cons: similar to 1, but
238  this initial configuration file must reside in well known location! Why
239  ask users what can be found automatically? 4) Have everything in the
240  location already in class path for tomcat. cons: only classes and
241  lib/*.jar are added, eclipse will remove non classses from classes dir.
242  
243  Try 1 - succeed.\r
244 <P>\r
245 <DD><DL>\r
246 \r
247 <DT><B>Returns:</B><DD>an instance</DL>\r
248 </DD>\r
249 </DL>\r
250 <HR>\r
251 \r
252 <A NAME="getLocalPath()"><!-- --></A><H3>\r
253 getLocalPath</H3>\r
254 <PRE>\r
255 public static <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getLocalPath</B>()</PRE>\r
256 <DL>\r
257 <DD>Method return the absolute path to the project root directory. It assumes
258  the following structure of the project project root conf settings
259  binaries WEB-INF classes compbio engine conf If the structure changes it
260  must be reflected in this method\r
261 <P>\r
262 <DD><DL>\r
263 \r
264 <DT><B>Returns:</B><DD>the local path\r
265 <DT><B>Throws:</B>\r
266 <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">RuntimeException</A></CODE> - if cannot determine the local path</DL>\r
267 </DD>\r
268 </DL>\r
269 <!-- ========= END OF CLASS DATA ========= -->\r
270 <HR>\r
271 \r
272 \r
273 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
274 <A NAME="navbar_bottom"><!-- --></A>\r
275 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
276 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
277 <TR>\r
278 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
279 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
280 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
281   <TR ALIGN="center" VALIGN="top">\r
282   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
283   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
284   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
285   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/PropertyHelperManager.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
286   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
287   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
288   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
289   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
290   </TR>\r
291 </TABLE>\r
292 </TD>\r
293 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
294 </EM>\r
295 </TD>\r
296 </TR>\r
297 \r
298 <TR>\r
299 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
300 &nbsp;<A HREF="../../../compbio/engine/conf/DirectoryManager.html" title="class in compbio.engine.conf"><B>PREV CLASS</B></A>&nbsp;\r
301 &nbsp;<A HREF="../../../compbio/engine/conf/RunnerConfigMarshaller.html" title="class in compbio.engine.conf"><B>NEXT CLASS</B></A></FONT></TD>\r
302 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
303   <A HREF="../../../index.html?compbio/engine/conf/PropertyHelperManager.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
304 &nbsp;<A HREF="PropertyHelperManager.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
305 &nbsp;<SCRIPT type="text/javascript">\r
306   <!--\r
307   if(window==top) {\r
308     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
309   }\r
310   //-->\r
311 </SCRIPT>\r
312 <NOSCRIPT>\r
313   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
314 </NOSCRIPT>\r
315 \r
316 \r
317 </FONT></TD>\r
318 </TR>\r
319 <TR>\r
320 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
321   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
322 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
323 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
324 </TR>\r
325 </TABLE>\r
326 <A NAME="skip-navbar_bottom"></A>\r
327 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
328 \r
329 <HR>\r
330 \r
331 </BODY>\r
332 </HTML>\r