JWS-109 & JWS-116 Regenerated the JABAWS JavaDoc (with eclipse java 8) and moved...
[jabaws.git] / website / docs / full_javadoc / compbio / ws / server / GAUtils.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>GAUtils</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="GAUtils";
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/GAUtils.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/ws/server/DisemblWS.html" title="class in compbio.ws.server"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
53 <li><a href="../../../compbio/ws/server/GenericMetadataService.html" title="class in compbio.ws.server"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
54 </ul>
55 <ul class="navList">
56 <li><a href="../../../index.html?compbio/ws/server/GAUtils.html" target="_top">Frames</a></li>
57 <li><a href="GAUtils.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.ws.server</div>
96 <h2 title="Class GAUtils" class="title">Class GAUtils</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.ws.server.GAUtils</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 class <span class="typeNameLabel">GAUtils</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>private static compbio.stat.ga.AnalyticsConfigData</code></td>
134 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/server/GAUtils.html#config">config</a></span></code>&nbsp;</td>
135 </tr>
136 <tr class="rowColor">
137 <td class="colFirst"><code>(package private) static boolean</code></td>
138 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/server/GAUtils.html#IS_GA_ENABLED">IS_GA_ENABLED</a></span></code>&nbsp;</td>
139 </tr>
140 <tr class="altColor">
141 <td class="colFirst"><code>private static org.apache.log4j.Logger</code></td>
142 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/server/GAUtils.html#log">log</a></span></code>&nbsp;</td>
143 </tr>
144 <tr class="rowColor">
145 <td class="colFirst"><code>(package private) static compbio.util.PropertyHelper</code></td>
146 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/server/GAUtils.html#PROP_HELPER">PROP_HELPER</a></span></code>&nbsp;</td>
147 </tr>
148 <tr class="altColor">
149 <td class="colFirst"><code>private static java.lang.String</code></td>
150 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/server/GAUtils.html#SERVER_ADDRESS">SERVER_ADDRESS</a></span></code>&nbsp;</td>
151 </tr>
152 <tr class="rowColor">
153 <td class="colFirst"><code>private static compbio.stat.ga.GoogleAnalyticsTracker</code></td>
154 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/server/GAUtils.html#TRACKER">TRACKER</a></span></code>&nbsp;</td>
155 </tr>
156 <tr class="altColor">
157 <td class="colFirst"><code>(package private) static java.lang.String</code></td>
158 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/server/GAUtils.html#VERSION_TYPE">VERSION_TYPE</a></span></code>&nbsp;</td>
159 </tr>
160 </table>
161 </li>
162 </ul>
163 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
164 <ul class="blockList">
165 <li class="blockList"><a name="constructor.summary">
166 <!--   -->
167 </a>
168 <h3>Constructor Summary</h3>
169 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
170 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
171 <tr>
172 <th class="colOne" scope="col">Constructor and Description</th>
173 </tr>
174 <tr class="altColor">
175 <td class="colOne"><code><span class="memberNameLink"><a href="../../../compbio/ws/server/GAUtils.html#GAUtils--">GAUtils</a></span>()</code>&nbsp;</td>
176 </tr>
177 </table>
178 </li>
179 </ul>
180 <!-- ========== METHOD SUMMARY =========== -->
181 <ul class="blockList">
182 <li class="blockList"><a name="method.summary">
183 <!--   -->
184 </a>
185 <h3>Method Summary</h3>
186 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
187 <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>
188 <tr>
189 <th class="colFirst" scope="col">Modifier and Type</th>
190 <th class="colLast" scope="col">Method and Description</th>
191 </tr>
192 <tr id="i0" class="altColor">
193 <td class="colFirst"><code>private static boolean</code></td>
194 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/server/GAUtils.html#anonymizeIP--">anonymizeIP</a></span>()</code>&nbsp;</td>
195 </tr>
196 <tr id="i1" class="rowColor">
197 <td class="colFirst"><code>private static java.lang.String</code></td>
198 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/server/GAUtils.html#getServerIP--">getServerIP</a></span>()</code>&nbsp;</td>
199 </tr>
200 <tr id="i2" class="altColor">
201 <td class="colFirst"><code>private static boolean</code></td>
202 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/server/GAUtils.html#isGoogleAnalyticsEnabled--">isGoogleAnalyticsEnabled</a></span>()</code>&nbsp;</td>
203 </tr>
204 <tr id="i3" class="rowColor">
205 <td class="colFirst"><code>(package private) static void</code></td>
206 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/server/GAUtils.html#reportUsage-compbio.ws.client.Services-">reportUsage</a></span>(<a href="../../../compbio/ws/client/Services.html" title="enum in compbio.ws.client">Services</a>&nbsp;service)</code>&nbsp;</td>
207 </tr>
208 <tr id="i4" class="altColor">
209 <td class="colFirst"><code>(package private) static void</code></td>
210 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/server/GAUtils.html#reportUsage-compbio.ws.client.Services-java.lang.String-">reportUsage</a></span>(<a href="../../../compbio/ws/client/Services.html" title="enum in compbio.ws.client">Services</a>&nbsp;service,
211            java.lang.String&nbsp;CLIENT_ADDRESS)</code>&nbsp;</td>
212 </tr>
213 </table>
214 <ul class="blockList">
215 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
216 <!--   -->
217 </a>
218 <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
219 <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
220 </ul>
221 </li>
222 </ul>
223 </li>
224 </ul>
225 </div>
226 <div class="details">
227 <ul class="blockList">
228 <li class="blockList">
229 <!-- ============ FIELD DETAIL =========== -->
230 <ul class="blockList">
231 <li class="blockList"><a name="field.detail">
232 <!--   -->
233 </a>
234 <h3>Field Detail</h3>
235 <a name="VERSION_TYPE">
236 <!--   -->
237 </a>
238 <ul class="blockList">
239 <li class="blockList">
240 <h4>VERSION_TYPE</h4>
241 <pre>static final&nbsp;java.lang.String VERSION_TYPE</pre>
242 <dl>
243 <dt><span class="seeLabel">See Also:</span></dt>
244 <dd><a href="../../../constant-values.html#compbio.ws.server.GAUtils.VERSION_TYPE">Constant Field Values</a></dd>
245 </dl>
246 </li>
247 </ul>
248 <a name="log">
249 <!--   -->
250 </a>
251 <ul class="blockList">
252 <li class="blockList">
253 <h4>log</h4>
254 <pre>private static final&nbsp;org.apache.log4j.Logger log</pre>
255 </li>
256 </ul>
257 <a name="PROP_HELPER">
258 <!--   -->
259 </a>
260 <ul class="blockList">
261 <li class="blockList">
262 <h4>PROP_HELPER</h4>
263 <pre>static&nbsp;compbio.util.PropertyHelper PROP_HELPER</pre>
264 </li>
265 </ul>
266 <a name="config">
267 <!--   -->
268 </a>
269 <ul class="blockList">
270 <li class="blockList">
271 <h4>config</h4>
272 <pre>private static&nbsp;compbio.stat.ga.AnalyticsConfigData config</pre>
273 </li>
274 </ul>
275 <a name="TRACKER">
276 <!--   -->
277 </a>
278 <ul class="blockList">
279 <li class="blockList">
280 <h4>TRACKER</h4>
281 <pre>private static&nbsp;compbio.stat.ga.GoogleAnalyticsTracker TRACKER</pre>
282 </li>
283 </ul>
284 <a name="IS_GA_ENABLED">
285 <!--   -->
286 </a>
287 <ul class="blockList">
288 <li class="blockList">
289 <h4>IS_GA_ENABLED</h4>
290 <pre>static final&nbsp;boolean IS_GA_ENABLED</pre>
291 </li>
292 </ul>
293 <a name="SERVER_ADDRESS">
294 <!--   -->
295 </a>
296 <ul class="blockListLast">
297 <li class="blockList">
298 <h4>SERVER_ADDRESS</h4>
299 <pre>private static&nbsp;java.lang.String SERVER_ADDRESS</pre>
300 </li>
301 </ul>
302 </li>
303 </ul>
304 <!-- ========= CONSTRUCTOR DETAIL ======== -->
305 <ul class="blockList">
306 <li class="blockList"><a name="constructor.detail">
307 <!--   -->
308 </a>
309 <h3>Constructor Detail</h3>
310 <a name="GAUtils--">
311 <!--   -->
312 </a>
313 <ul class="blockListLast">
314 <li class="blockList">
315 <h4>GAUtils</h4>
316 <pre>public&nbsp;GAUtils()</pre>
317 </li>
318 </ul>
319 </li>
320 </ul>
321 <!-- ============ METHOD DETAIL ========== -->
322 <ul class="blockList">
323 <li class="blockList"><a name="method.detail">
324 <!--   -->
325 </a>
326 <h3>Method Detail</h3>
327 <a name="isGoogleAnalyticsEnabled--">
328 <!--   -->
329 </a>
330 <ul class="blockList">
331 <li class="blockList">
332 <h4>isGoogleAnalyticsEnabled</h4>
333 <pre>private static&nbsp;boolean&nbsp;isGoogleAnalyticsEnabled()</pre>
334 </li>
335 </ul>
336 <a name="getServerIP--">
337 <!--   -->
338 </a>
339 <ul class="blockList">
340 <li class="blockList">
341 <h4>getServerIP</h4>
342 <pre>private static&nbsp;java.lang.String&nbsp;getServerIP()</pre>
343 </li>
344 </ul>
345 <a name="anonymizeIP--">
346 <!--   -->
347 </a>
348 <ul class="blockList">
349 <li class="blockList">
350 <h4>anonymizeIP</h4>
351 <pre>private static&nbsp;boolean&nbsp;anonymizeIP()</pre>
352 </li>
353 </ul>
354 <a name="reportUsage-compbio.ws.client.Services-">
355 <!--   -->
356 </a>
357 <ul class="blockList">
358 <li class="blockList">
359 <h4>reportUsage</h4>
360 <pre>static&nbsp;void&nbsp;reportUsage(<a href="../../../compbio/ws/client/Services.html" title="enum in compbio.ws.client">Services</a>&nbsp;service)</pre>
361 </li>
362 </ul>
363 <a name="reportUsage-compbio.ws.client.Services-java.lang.String-">
364 <!--   -->
365 </a>
366 <ul class="blockListLast">
367 <li class="blockList">
368 <h4>reportUsage</h4>
369 <pre>static&nbsp;void&nbsp;reportUsage(<a href="../../../compbio/ws/client/Services.html" title="enum in compbio.ws.client">Services</a>&nbsp;service,
370                         java.lang.String&nbsp;CLIENT_ADDRESS)</pre>
371 </li>
372 </ul>
373 </li>
374 </ul>
375 </li>
376 </ul>
377 </div>
378 </div>
379 <!-- ========= END OF CLASS DATA ========= -->
380 <!-- ======= START OF BOTTOM NAVBAR ====== -->
381 <div class="bottomNav"><a name="navbar.bottom">
382 <!--   -->
383 </a>
384 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
385 <a name="navbar.bottom.firstrow">
386 <!--   -->
387 </a>
388 <ul class="navList" title="Navigation">
389 <li><a href="../../../overview-summary.html">Overview</a></li>
390 <li><a href="package-summary.html">Package</a></li>
391 <li class="navBarCell1Rev">Class</li>
392 <li><a href="class-use/GAUtils.html">Use</a></li>
393 <li><a href="package-tree.html">Tree</a></li>
394 <li><a href="../../../deprecated-list.html">Deprecated</a></li>
395 <li><a href="../../../index-files/index-1.html">Index</a></li>
396 <li><a href="../../../help-doc.html">Help</a></li>
397 </ul>
398 </div>
399 <div class="subNav">
400 <ul class="navList">
401 <li><a href="../../../compbio/ws/server/DisemblWS.html" title="class in compbio.ws.server"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
402 <li><a href="../../../compbio/ws/server/GenericMetadataService.html" title="class in compbio.ws.server"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
403 </ul>
404 <ul class="navList">
405 <li><a href="../../../index.html?compbio/ws/server/GAUtils.html" target="_top">Frames</a></li>
406 <li><a href="GAUtils.html" target="_top">No&nbsp;Frames</a></li>
407 </ul>
408 <ul class="navList" id="allclasses_navbar_bottom">
409 <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
410 </ul>
411 <div>
412 <script type="text/javascript"><!--
413   allClassesLink = document.getElementById("allclasses_navbar_bottom");
414   if(window==top) {
415     allClassesLink.style.display = "block";
416   }
417   else {
418     allClassesLink.style.display = "none";
419   }
420   //-->
421 </script>
422 </div>
423 <div>
424 <ul class="subNavList">
425 <li>Summary:&nbsp;</li>
426 <li>Nested&nbsp;|&nbsp;</li>
427 <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
428 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
429 <li><a href="#method.summary">Method</a></li>
430 </ul>
431 <ul class="subNavList">
432 <li>Detail:&nbsp;</li>
433 <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
434 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
435 <li><a href="#method.detail">Method</a></li>
436 </ul>
437 </div>
438 <a name="skip.navbar.bottom">
439 <!--   -->
440 </a></div>
441 <!-- ======== END OF BOTTOM NAVBAR ======= -->
442 </body>
443 </html>