| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.9.1) on Fri Sep 09 19:30:40 KST 2022 --> |
| <title>MetricUtils (Nemo Project 0.4 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2022-09-09"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../../jquery/jquery-3.5.1.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="MetricUtils (Nemo Project 0.4 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/MetricUtils.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" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.nemo.runtime.common.metric</a></div> |
| <h2 title="Class MetricUtils" class="title">Class MetricUtils</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.nemo.runtime.common.metric.MetricUtils</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <pre>public final class <span class="typeNameLabel">MetricUtils</span> |
| extends java.lang.Object</pre> |
| <div class="block">Utility class for metrics. |
| TODO #372: This class should later be refactored into a separate metric package.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#POSTGRESQL_METADATA_DB_NAME">POSTGRESQL_METADATA_DB_NAME</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SQLITE_DB_NAME">SQLITE_DB_NAME</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <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="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="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>static java.util.Optional<java.lang.reflect.Method></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMethodFor(java.lang.Class,java.lang.String,java.lang.Class...)">getMethodFor</a></span>​(java.lang.Class<? extends <a href="../../../common/ir/executionproperty/ExecutionProperty.html" title="class in org.apache.nemo.common.ir.executionproperty">ExecutionProperty</a>> clazz, |
| java.lang.String name, |
| java.lang.Class<?>... valueTypes)</code></th> |
| <td class="colLast"> |
| <div class="block">Utility method to getting an optional method called 'name' for the class.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../common/ir/executionproperty/ExecutionProperty.html" title="class in org.apache.nemo.common.ir.executionproperty">ExecutionProperty</a><? extends java.io.Serializable></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#keyAndValueToEP(java.lang.Integer,java.lang.Double,java.lang.Double)">keyAndValueToEP</a></span>​(java.lang.Integer epKeyIndex, |
| java.lang.Double split, |
| java.lang.Double tweak)</code></th> |
| <td class="colLast"> |
| <div class="block">Receives the pair of execution property and value classes, and returns the optimized value of the EP.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static java.lang.Boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#loadMetaData()">loadMetaData</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Load the BiMaps (lightweight) Metadata from the DB.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static java.lang.Boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#metaDataLoaded()">metaDataLoaded</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../common/Pair.html" title="class in org.apache.nemo.common">Pair</a><java.lang.String,​java.lang.String></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#stringifyIRDAGProperties(org.apache.nemo.common.ir.IRDAG)">stringifyIRDAGProperties</a></span>​(<a href="../../../common/ir/IRDAG.html" title="class in org.apache.nemo.common.ir">IRDAG</a> irdag)</code></th> |
| <td class="colLast"> |
| <div class="block">Stringify execution properties of an IR DAG.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="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> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="SQLITE_DB_NAME"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SQLITE_DB_NAME</h4> |
| <pre>public static final java.lang.String SQLITE_DB_NAME</pre> |
| </li> |
| </ul> |
| <a id="POSTGRESQL_METADATA_DB_NAME"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>POSTGRESQL_METADATA_DB_NAME</h4> |
| <pre>public static final java.lang.String POSTGRESQL_METADATA_DB_NAME</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.apache.nemo.runtime.common.metric.MetricUtils.POSTGRESQL_METADATA_DB_NAME">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="loadMetaData()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loadMetaData</h4> |
| <pre class="methodSignature">public static java.lang.Boolean loadMetaData()</pre> |
| <div class="block">Load the BiMaps (lightweight) Metadata from the DB.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Whether or not the metadata has been successfully loaded from the DB.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="metaDataLoaded()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>metaDataLoaded</h4> |
| <pre class="methodSignature">public static java.lang.Boolean metaDataLoaded()</pre> |
| </li> |
| </ul> |
| <a id="stringifyIRDAGProperties(org.apache.nemo.common.ir.IRDAG)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>stringifyIRDAGProperties</h4> |
| <pre class="methodSignature">public static <a href="../../../common/Pair.html" title="class in org.apache.nemo.common">Pair</a><java.lang.String,​java.lang.String> stringifyIRDAGProperties​(<a href="../../../common/ir/IRDAG.html" title="class in org.apache.nemo.common.ir">IRDAG</a> irdag)</pre> |
| <div class="block">Stringify execution properties of an IR DAG.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>irdag</code> - IR DAG to observe.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the pair of stringified execution properties. Left is for vertices, right is for edges.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getMethodFor(java.lang.Class,java.lang.String,java.lang.Class...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMethodFor</h4> |
| <pre class="methodSignature">public static java.util.Optional<java.lang.reflect.Method> getMethodFor​(java.lang.Class<? extends <a href="../../../common/ir/executionproperty/ExecutionProperty.html" title="class in org.apache.nemo.common.ir.executionproperty">ExecutionProperty</a>> clazz, |
| java.lang.String name, |
| java.lang.Class<?>... valueTypes)</pre> |
| <div class="block">Utility method to getting an optional method called 'name' for the class.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>clazz</code> - class to get the method of.</dd> |
| <dd><code>name</code> - the name of the method.</dd> |
| <dd><code>valueTypes</code> - the value types of the method.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>optional of the method. It returns Optional.empty() if the method could not be found.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="keyAndValueToEP(java.lang.Integer,java.lang.Double,java.lang.Double)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>keyAndValueToEP</h4> |
| <pre class="methodSignature">public static <a href="../../../common/ir/executionproperty/ExecutionProperty.html" title="class in org.apache.nemo.common.ir.executionproperty">ExecutionProperty</a><? extends java.io.Serializable> keyAndValueToEP​(java.lang.Integer epKeyIndex, |
| java.lang.Double split, |
| java.lang.Double tweak)</pre> |
| <div class="block">Receives the pair of execution property and value classes, and returns the optimized value of the EP.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>epKeyIndex</code> - the EP Key index to retrieve the new EP from.</dd> |
| <dd><code>split</code> - the split point.</dd> |
| <dd><code>tweak</code> - the direction in which to tweak the execution property value.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The execution property constructed from the key index and the split value.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/MetricUtils.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" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses.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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
