<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!-- NewPage --> <html lang="en"> <head> <!-- Generated by javadoc (1.8.0_265) on Tue Aug 25 19:30:51 UTC 2020 --> <title>MetacatProfiler (MetaCat API)</title> <meta name="date" content="2020-08-25"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../../../script.js"></script> </head> <body> <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { parent.document.title="MetacatProfiler (MetaCat API)"; } } catch(err) { } //--> var methods = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10}; var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; var tableTab = "tableTab"; var activeTableTab = "activeTableTab"; </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> <div class="topNav"><a name="navbar.top"> <!-- --> </a> <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> <a name="navbar.top.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="class-use/MetacatProfiler.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../index-all.html">Index</a></li> <li><a href="../../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../../edu/ucsb/nceas/metacat/MetacatHandler.html" title="class in edu.ucsb.nceas.metacat"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../../edu/ucsb/nceas/metacat/MetacatProfiler.Profile.html" title="class in edu.ucsb.nceas.metacat"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?edu/ucsb/nceas/metacat/MetacatProfiler.html" target="_top">Frames</a></li> <li><a href="MetacatProfiler.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_top"> <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_top"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li><a href="#nested.class.summary">Nested</a> | </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method.detail">Method</a></li> </ul> </div> <a name="skip.navbar.top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> <!-- ======== START OF CLASS DATA ======== --> <div class="header"> <div class="subTitle">edu.ucsb.nceas.metacat</div> <h2 title="Class MetacatProfiler" class="title">Class MetacatProfiler</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>edu.ucsb.nceas.metacat.MetacatProfiler</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public class <span class="typeNameLabel">MetacatProfiler</span> extends java.lang.Object</pre> <dl> <dt><span class="simpleTagLabel">Author:</span></dt> <dd>berkley Singleton to track metacat profile stats and print them to a CSV file</dd> </dl> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- ======== NESTED CLASS SUMMARY ======== --> <ul class="blockList"> <li class="blockList"><a name="nested.class.summary"> <!-- --> </a> <h3>Nested Class Summary</h3> <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Class and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>class </code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/MetacatProfiler.Profile.html" title="class in edu.ucsb.nceas.metacat">MetacatProfiler.Profile</a></span></code> <div class="block">container class for profile information</div> </td> </tr> </table> </li> </ul> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="method.summary"> <!-- --> </a> <h3>Method Summary</h3> <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> <tr id="i0" class="altColor"> <td class="colFirst"><code>static <a href="../../../../edu/ucsb/nceas/metacat/MetacatProfiler.html" title="class in edu.ucsb.nceas.metacat">MetacatProfiler</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/MetacatProfiler.html#getInstance--">getInstance</a></span>()</code> <div class="block">get a singleton instance</div> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>java.util.Hashtable<java.lang.String,<a href="../../../../edu/ucsb/nceas/metacat/MetacatProfiler.Profile.html" title="class in edu.ucsb.nceas.metacat">MetacatProfiler.Profile</a>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/MetacatProfiler.html#getProfiles--">getProfiles</a></span>()</code> <div class="block">return a hashtable of the profiles</div> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/MetacatProfiler.html#printCSV-java.io.File-">printCSV</a></span>(java.io.File f)</code> <div class="block">print the CSV file with no sorting</div> </td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/MetacatProfiler.html#printLogMsg-java.lang.String-">printLogMsg</a></span>(java.lang.String msg)</code> <div class="block">print a message to the log in real-time</div> </td> </tr> <tr id="i4" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/MetacatProfiler.html#printSortedCSV-java.io.File-java.lang.String-">printSortedCSV</a></span>(java.io.File f, java.lang.String sortKey)</code> <div class="block">print a sorted CSV file.</div> </td> </tr> <tr id="i5" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/MetacatProfiler.html#reset--">reset</a></span>()</code> <div class="block">reset all times in the singleton</div> </td> </tr> <tr id="i6" class="altColor"> <td class="colFirst"><code><a href="../../../../edu/ucsb/nceas/metacat/MetacatProfiler.Profile.html" title="class in edu.ucsb.nceas.metacat">MetacatProfiler.Profile</a>[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/MetacatProfiler.html#sortProfiles-java.lang.String-">sortProfiles</a></span>(java.lang.String sortKey)</code> <div class="block">sort the profiles by "callorder", "callcount" or "total"</div> </td> </tr> <tr id="i7" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/MetacatProfiler.html#startTime-java.lang.String-">startTime</a></span>(java.lang.String profileName)</code> <div class="block">start the timing on a profile</div> </td> </tr> <tr id="i8" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/MetacatProfiler.html#stopTime-java.lang.String-">stopTime</a></span>(java.lang.String profileName)</code> <div class="block">stop the timing on a profile</div> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class java.lang.Object</h3> <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> </ul> </li> </ul> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method.detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="getInstance--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getInstance</h4> <pre>public static <a href="../../../../edu/ucsb/nceas/metacat/MetacatProfiler.html" title="class in edu.ucsb.nceas.metacat">MetacatProfiler</a> getInstance()</pre> <div class="block">get a singleton instance</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> </dl> </li> </ul> <a name="getProfiles--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getProfiles</h4> <pre>public java.util.Hashtable<java.lang.String,<a href="../../../../edu/ucsb/nceas/metacat/MetacatProfiler.Profile.html" title="class in edu.ucsb.nceas.metacat">MetacatProfiler.Profile</a>> getProfiles()</pre> <div class="block">return a hashtable of the profiles</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> </dl> </li> </ul> <a name="reset--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>reset</h4> <pre>public void reset()</pre> <div class="block">reset all times in the singleton</div> </li> </ul> <a name="printLogMsg-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>printLogMsg</h4> <pre>public void printLogMsg(java.lang.String msg)</pre> <div class="block">print a message to the log in real-time</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>msg</code> - </dd> </dl> </li> </ul> <a name="startTime-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>startTime</h4> <pre>public void startTime(java.lang.String profileName)</pre> <div class="block">start the timing on a profile</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>profileName</code> - </dd> </dl> </li> </ul> <a name="stopTime-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>stopTime</h4> <pre>public void stopTime(java.lang.String profileName)</pre> <div class="block">stop the timing on a profile</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>profileName</code> - </dd> </dl> </li> </ul> <a name="sortProfiles-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>sortProfiles</h4> <pre>public <a href="../../../../edu/ucsb/nceas/metacat/MetacatProfiler.Profile.html" title="class in edu.ucsb.nceas.metacat">MetacatProfiler.Profile</a>[] sortProfiles(java.lang.String sortKey)</pre> <div class="block">sort the profiles by "callorder", "callcount" or "total"</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>sortKey</code> - </dd> <dt><span class="returnLabel">Returns:</span></dt> </dl> </li> </ul> <a name="printSortedCSV-java.io.File-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>printSortedCSV</h4> <pre>public void printSortedCSV(java.io.File f, java.lang.String sortKey) throws java.io.IOException</pre> <div class="block">print a sorted CSV file. The sortKey can be "callorder", "callcount" or "total"</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>f</code> - </dd> <dd><code>sortKey</code> - </dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>java.io.IOException</code></dd> </dl> </li> </ul> <a name="printCSV-java.io.File-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>printCSV</h4> <pre>public void printCSV(java.io.File f) throws java.io.IOException</pre> <div class="block">print the CSV file with no sorting</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>f</code> - </dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>java.io.IOException</code></dd> </dl> </li> </ul> </li> </ul> </li> </ul> </div> </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> <div class="bottomNav"><a name="navbar.bottom"> <!-- --> </a> <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> <a name="navbar.bottom.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="class-use/MetacatProfiler.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../index-all.html">Index</a></li> <li><a href="../../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../../edu/ucsb/nceas/metacat/MetacatHandler.html" title="class in edu.ucsb.nceas.metacat"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../../edu/ucsb/nceas/metacat/MetacatProfiler.Profile.html" title="class in edu.ucsb.nceas.metacat"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?edu/ucsb/nceas/metacat/MetacatProfiler.html" target="_top">Frames</a></li> <li><a href="MetacatProfiler.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_bottom"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li><a href="#nested.class.summary">Nested</a> | </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method.detail">Method</a></li> </ul> </div> <a name="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> <p class="legalCopy"><small><i>Copyright © 2020 Regents of the University of California. All Rights Reserved.</i></small></p> </body> </html>