1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
\r
5 <!-- Generated by javadoc (build 1.6.0_14) on Wed Feb 17 16:46:49 GMT 2010 -->
\r
7 PropertyHelperManager
\r
10 <META NAME="date" CONTENT="2010-02-17">
\r
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
\r
14 <SCRIPT type="text/javascript">
\r
15 function windowTitle()
\r
17 if (location.href.indexOf('is-external=true') == -1) {
\r
18 parent.document.title="PropertyHelperManager";
\r
27 <BODY BGCOLOR="white" onload="windowTitle();">
\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
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> </TD>
\r
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
42 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/PropertyHelperManager.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
\r
44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
51 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
58 <A HREF="../../../compbio/engine/conf/DirectoryManager.html" title="class in compbio.engine.conf"><B>PREV CLASS</B></A>
\r
59 <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>
\r
62 <A HREF="PropertyHelperManager.html" target="_top"><B>NO FRAMES</B></A>
\r
63 <SCRIPT type="text/javascript">
\r
66 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
71 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
78 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
79 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
80 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
81 DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
84 <A NAME="skip-navbar_top"></A>
\r
85 <!-- ========= END OF TOP NAVBAR ========= -->
\r
88 <!-- ======== START OF CLASS DATA ======== -->
\r
91 compbio.engine.conf</FONT>
\r
93 Class PropertyHelperManager</H2>
\r
96 <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>compbio.engine.conf.PropertyHelperManager</B>
\r
100 <DT><PRE>public final class <B>PropertyHelperManager</B><DT>extends java.lang.Object</DL>
\r
107 <!-- =========== FIELD SUMMARY =========== -->
\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
115 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
116 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
117 <CODE>static java.lang.String</CODE></FONT></TD>
\r
118 <TD><CODE><B><A HREF="../../../compbio/engine/conf/PropertyHelperManager.html#confDir">confDir</A></B></CODE>
\r
121 </TD>
\r
125 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
\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
133 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
134 <TD><CODE><B><A HREF="../../../compbio/engine/conf/PropertyHelperManager.html#PropertyHelperManager()">PropertyHelperManager</A></B>()</CODE>
\r
137 </TD>
\r
141 <!-- ========== METHOD SUMMARY =========== -->
\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
149 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
150 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
151 <CODE>static java.lang.String</CODE></FONT></TD>
\r
152 <TD><CODE><B><A HREF="../../../compbio/engine/conf/PropertyHelperManager.html#getLocalPath()">getLocalPath</A></B>()</CODE>
\r
155 Method return the absolute path to the project root directory.</TD>
\r
157 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
158 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
159 <CODE>static compbio.util.PropertyHelper</CODE></FONT></TD>
\r
160 <TD><CODE><B><A HREF="../../../compbio/engine/conf/PropertyHelperManager.html#getPropertyHelper()">getPropertyHelper</A></B>()</CODE>
\r
163 Ways to fix path problem: 1) find a path to WEB-INF directory based on
164 the path to a known class.</TD>
\r
167 <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.Object</B></TH>
\r
172 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
173 <TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
\r
179 <!-- ============ FIELD DETAIL =========== -->
\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
189 <A NAME="confDir"><!-- --></A><H3>
\r
192 public static final java.lang.String <B>confDir</B></PRE>
\r
198 <!-- ========= CONSTRUCTOR DETAIL ======== -->
\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
208 <A NAME="PropertyHelperManager()"><!-- --></A><H3>
\r
209 PropertyHelperManager</H3>
\r
211 public <B>PropertyHelperManager</B>()</PRE>
\r
215 <!-- ============ METHOD DETAIL ========== -->
\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
225 <A NAME="getPropertyHelper()"><!-- --></A><H3>
\r
226 getPropertyHelper</H3>
\r
228 public static compbio.util.PropertyHelper <B>getPropertyHelper</B>()</PRE>
\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.
247 <DT><B>Returns:</B><DD></DL>
\r
252 <A NAME="getLocalPath()"><!-- --></A><H3>
\r
255 public static java.lang.String <B>getLocalPath</B>()</PRE>
\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
264 <DT><B>Returns:</B><DD>
\r
266 <DD><CODE>javax.naming.ConfigurationException</CODE></DL>
\r
269 <!-- ========= END OF CLASS DATA ========= -->
\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
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> </TD>
\r
283 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
284 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
285 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/PropertyHelperManager.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
\r
286 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
287 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
288 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
289 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
293 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
299 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
300 <A HREF="../../../compbio/engine/conf/DirectoryManager.html" title="class in compbio.engine.conf"><B>PREV CLASS</B></A>
\r
301 <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>
\r
304 <A HREF="PropertyHelperManager.html" target="_top"><B>NO FRAMES</B></A>
\r
305 <SCRIPT type="text/javascript">
\r
308 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
313 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
320 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
321 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
322 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
323 DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
326 <A NAME="skip-navbar_bottom"></A>
\r
327 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r