Google Git
Sign in
apache / storm-site / 553ca57e4e37c342861887cd8dd404f44d39b4f9 / . / content / releases / 2.4.0 / javadocs / org / apache / storm / scheduler / resource / strategies / scheduling / sorter / NodeSorter.html
blob: c06fa9b51d1191164cf1511b041c54e17e364b73 [file] [log] [blame]
<!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 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>NodeSorter (Storm 2.4.0 API)</title>
<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="NodeSorter (Storm 2.4.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10};
var tabs = {65535:["t0","All 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/NodeSorter.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="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/sorter/INodeSorter.html" title="interface in org.apache.storm.scheduler.resource.strategies.scheduling.sorter"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/sorter/NodeSorter.ExistingScheduleFunc.html" title="interface in org.apache.storm.scheduler.resource.strategies.scheduling.sorter"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/storm/scheduler/resource/strategies/scheduling/sorter/NodeSorter.html" target="_top">Frames</a></li>
<li><a href="NodeSorter.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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">org.apache.storm.scheduler.resource.strategies.scheduling.sorter</div>
<h2 title="Class NodeSorter" class="title">Class NodeSorter</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.storm.scheduler.resource.strategies.scheduling.sorter.NodeSorter</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/sorter/INodeSorter.html" title="interface in org.apache.storm.scheduler.resource.strategies.scheduling.sorter">INodeSorter</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">NodeSorter</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/sorter/INodeSorter.html" title="interface in org.apache.storm.scheduler.resource.strategies.scheduling.sorter">INodeSorter</a></pre>
</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">&nbsp;</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>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/sorter/NodeSorter.ExistingScheduleFunc.html" title="interface in org.apache.storm.scheduler.resource.strategies.scheduling.sorter">NodeSorter.ExistingScheduleFunc</a></span></code>
<div class="block">interface for calculating the number of existing executors scheduled on a object (rack or node).</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../../../../../org/apache/storm/scheduler/Cluster.html" title="class in org.apache.storm.scheduler">Cluster</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/sorter/NodeSorter.html#cluster">cluster</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/sorter/NodeSorter.html#favoredNodeIds">favoredNodeIds</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/sorter/NodeSorter.html#greyListedSupervisorIds">greyListedSupervisorIds</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/BaseResourceAwareStrategy.NodeSortType.html" title="enum in org.apache.storm.scheduler.resource.strategies.scheduling">BaseResourceAwareStrategy.NodeSortType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/sorter/NodeSorter.html#nodeSortType">nodeSortType</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../../../../../org/apache/storm/scheduler/TopologyDetails.html" title="class in org.apache.storm.scheduler">TopologyDetails</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/sorter/NodeSorter.html#topologyDetails">topologyDetails</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/sorter/NodeSorter.html#unFavoredNodeIds">unFavoredNodeIds</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/sorter/NodeSorter.html#NodeSorter-org.apache.storm.scheduler.Cluster-org.apache.storm.scheduler.TopologyDetails-org.apache.storm.scheduler.resource.strategies.scheduling.BaseResourceAwareStrategy.NodeSortType-">NodeSorter</a></span>(<a href="../../../../../../../../org/apache/storm/scheduler/Cluster.html" title="class in org.apache.storm.scheduler">Cluster</a>&nbsp;cluster,
<a href="../../../../../../../../org/apache/storm/scheduler/TopologyDetails.html" title="class in org.apache.storm.scheduler">TopologyDetails</a>&nbsp;topologyDetails,
<a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/BaseResourceAwareStrategy.NodeSortType.html" title="enum in org.apache.storm.scheduler.resource.strategies.scheduling">BaseResourceAwareStrategy.NodeSortType</a>&nbsp;nodeSortType)</code>
<div class="block">Initialize for the default implementation node sorting.</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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>
<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><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/ObjectResourcesItem.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling">ObjectResourcesItem</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/sorter/NodeSorter.html#getSortedRacks--">getSortedRacks</a></span>()</code>
<div class="block">Racks are sorted by two criteria.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../../../org/apache/storm/scheduler/resource/RasNode.html" title="class in org.apache.storm.scheduler.resource">RasNode</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/sorter/NodeSorter.html#hostnameToNodes-java.lang.String-">hostnameToNodes</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;hostname)</code>
<div class="block">hostname to Ids.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/sorter/NodeSorter.html#makeHostToNodeIds-java.util.List-">makeHostToNodeIds</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;hosts)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/sorter/NodeSorter.html#prepare-org.apache.storm.scheduler.ExecutorDetails-">prepare</a></span>(<a href="../../../../../../../../org/apache/storm/scheduler/ExecutorDetails.html" title="class in org.apache.storm.scheduler">ExecutorDetails</a>&nbsp;exec)</code>
<div class="block">Prepare for node sorting.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/sorter/NodeSorter.html#sortAllNodes--">sortAllNodes</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/ObjectResourcesItem.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling">ObjectResourcesItem</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/sorter/NodeSorter.html#sortObjectResources-org.apache.storm.scheduler.resource.strategies.scheduling.ObjectResourcesSummary-org.apache.storm.scheduler.ExecutorDetails-org.apache.storm.scheduler.resource.strategies.scheduling.sorter.NodeSorter.ExistingScheduleFunc-">sortObjectResources</a></span>(<a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/ObjectResourcesSummary.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling">ObjectResourcesSummary</a>&nbsp;resourcesSummary,
<a href="../../../../../../../../org/apache/storm/scheduler/ExecutorDetails.html" title="class in org.apache.storm.scheduler">ExecutorDetails</a>&nbsp;exec,
<a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/sorter/NodeSorter.ExistingScheduleFunc.html" title="interface in org.apache.storm.scheduler.resource.strategies.scheduling.sorter">NodeSorter.ExistingScheduleFunc</a>&nbsp;existingScheduleFunc)</code>
<div class="block">Scheduling uses <a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/sorter/NodeSorter.html#sortAllNodes--"><code>sortAllNodes()</code></a> which eventually calls this method whose behavior can be altered by setting <a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/sorter/NodeSorter.html#nodeSortType"><code>nodeSortType</code></a>.</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&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="nodeSortType">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nodeSortType</h4>
<pre>protected final&nbsp;<a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/BaseResourceAwareStrategy.NodeSortType.html" title="enum in org.apache.storm.scheduler.resource.strategies.scheduling">BaseResourceAwareStrategy.NodeSortType</a> nodeSortType</pre>
</li>
</ul>
<a name="cluster">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cluster</h4>
<pre>protected&nbsp;<a href="../../../../../../../../org/apache/storm/scheduler/Cluster.html" title="class in org.apache.storm.scheduler">Cluster</a> cluster</pre>
</li>
</ul>
<a name="topologyDetails">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>topologyDetails</h4>
<pre>protected&nbsp;<a href="../../../../../../../../org/apache/storm/scheduler/TopologyDetails.html" title="class in org.apache.storm.scheduler">TopologyDetails</a> topologyDetails</pre>
</li>
</ul>
<a name="greyListedSupervisorIds">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>greyListedSupervisorIds</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt; greyListedSupervisorIds</pre>
</li>
</ul>
<a name="favoredNodeIds">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>favoredNodeIds</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt; favoredNodeIds</pre>
</li>
</ul>
<a name="unFavoredNodeIds">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>unFavoredNodeIds</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt; unFavoredNodeIds</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="NodeSorter-org.apache.storm.scheduler.Cluster-org.apache.storm.scheduler.TopologyDetails-org.apache.storm.scheduler.resource.strategies.scheduling.BaseResourceAwareStrategy.NodeSortType-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>NodeSorter</h4>
<pre>public&nbsp;NodeSorter(<a href="../../../../../../../../org/apache/storm/scheduler/Cluster.html" title="class in org.apache.storm.scheduler">Cluster</a>&nbsp;cluster,
<a href="../../../../../../../../org/apache/storm/scheduler/TopologyDetails.html" title="class in org.apache.storm.scheduler">TopologyDetails</a>&nbsp;topologyDetails,
<a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/BaseResourceAwareStrategy.NodeSortType.html" title="enum in org.apache.storm.scheduler.resource.strategies.scheduling">BaseResourceAwareStrategy.NodeSortType</a>&nbsp;nodeSortType)</pre>
<div class="block"><p>Initialize for the default implementation node sorting.</p>
<p>
<li><code>BaseResourceAwareStrategy.NodeSortType#GENERIC_RAS</code> sorting implemented in
<a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/sorter/NodeSorter.html#sortObjectResourcesGeneric-org.apache.storm.scheduler.resource.strategies.scheduling.ObjectResourcesSummary-org.apache.storm.scheduler.ExecutorDetails-org.apache.storm.scheduler.resource.strategies.scheduling.sorter.NodeSorter.ExistingScheduleFunc-"><code>sortObjectResourcesGeneric(ObjectResourcesSummary, ExecutorDetails, NodeSorter.ExistingScheduleFunc)</code></a></li>
<li><code>BaseResourceAwareStrategy.NodeSortType#DEFAULT_RAS</code> sorting implemented in
<a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/sorter/NodeSorter.html#sortObjectResourcesDefault-org.apache.storm.scheduler.resource.strategies.scheduling.ObjectResourcesSummary-org.apache.storm.scheduler.resource.strategies.scheduling.sorter.NodeSorter.ExistingScheduleFunc-"><code>sortObjectResourcesDefault(ObjectResourcesSummary, NodeSorter.ExistingScheduleFunc)</code></a></li>
<li><code>BaseResourceAwareStrategy.NodeSortType#COMMON</code> sorting implemented in
<a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/sorter/NodeSorter.html#sortObjectResourcesCommon-org.apache.storm.scheduler.resource.strategies.scheduling.ObjectResourcesSummary-org.apache.storm.scheduler.ExecutorDetails-org.apache.storm.scheduler.resource.strategies.scheduling.sorter.NodeSorter.ExistingScheduleFunc-"><code>sortObjectResourcesCommon(ObjectResourcesSummary, ExecutorDetails, NodeSorter.ExistingScheduleFunc)</code></a></li>
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cluster</code> - for which nodes will be sorted.</dd>
<dd><code>topologyDetails</code> - the topology to sort for.</dd>
<dd><code>nodeSortType</code> - type of sorting to be applied to object resource collection <code>BaseResourceAwareStrategy.NodeSortType</code>.</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="prepare-org.apache.storm.scheduler.ExecutorDetails-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>prepare</h4>
<pre>public&nbsp;void&nbsp;prepare(<a href="../../../../../../../../org/apache/storm/scheduler/ExecutorDetails.html" title="class in org.apache.storm.scheduler">ExecutorDetails</a>&nbsp;exec)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/sorter/INodeSorter.html#prepare-org.apache.storm.scheduler.ExecutorDetails-">INodeSorter</a></code></span></div>
<div class="block"><p>Prepare for node sorting. This method must be called before <a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/sorter/INodeSorter.html#getSortedRacks--"><code>INodeSorter.getSortedRacks()</code></a> and <a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/sorter/INodeSorter.html#sortAllNodes--"><code>INodeSorter.sortAllNodes()</code></a>.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/sorter/INodeSorter.html#prepare-org.apache.storm.scheduler.ExecutorDetails-">prepare</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/sorter/INodeSorter.html" title="interface in org.apache.storm.scheduler.resource.strategies.scheduling.sorter">INodeSorter</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>exec</code> - optional, may be null.</dd>
</dl>
</li>
</ul>
<a name="sortObjectResources-org.apache.storm.scheduler.resource.strategies.scheduling.ObjectResourcesSummary-org.apache.storm.scheduler.ExecutorDetails-org.apache.storm.scheduler.resource.strategies.scheduling.sorter.NodeSorter.ExistingScheduleFunc-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sortObjectResources</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/ObjectResourcesItem.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling">ObjectResourcesItem</a>&gt;&nbsp;sortObjectResources(<a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/ObjectResourcesSummary.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling">ObjectResourcesSummary</a>&nbsp;resourcesSummary,
<a href="../../../../../../../../org/apache/storm/scheduler/ExecutorDetails.html" title="class in org.apache.storm.scheduler">ExecutorDetails</a>&nbsp;exec,
<a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/sorter/NodeSorter.ExistingScheduleFunc.html" title="interface in org.apache.storm.scheduler.resource.strategies.scheduling.sorter">NodeSorter.ExistingScheduleFunc</a>&nbsp;existingScheduleFunc)</pre>
<div class="block"><p>Scheduling uses <a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/sorter/NodeSorter.html#sortAllNodes--"><code>sortAllNodes()</code></a> which eventually calls this method whose behavior can be altered by setting <a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/sorter/NodeSorter.html#nodeSortType"><code>nodeSortType</code></a>.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>resourcesSummary</code> - contains all individual <a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/ObjectResourcesItem.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling"><code>ObjectResourcesItem</code></a> as well as cumulative stats</dd>
<dd><code>exec</code> - executor for which the sorting is done</dd>
<dd><code>existingScheduleFunc</code> - a function to get existing executors already scheduled on this object</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a sorted list of <a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/ObjectResourcesItem.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling"><code>ObjectResourcesItem</code></a></dd>
</dl>
</li>
</ul>
<a name="makeHostToNodeIds-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>makeHostToNodeIds</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;makeHostToNodeIds(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;hosts)</pre>
</li>
</ul>
<a name="sortAllNodes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sortAllNodes</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;sortAllNodes()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/sorter/INodeSorter.html#sortAllNodes--">sortAllNodes</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/sorter/INodeSorter.html" title="interface in org.apache.storm.scheduler.resource.strategies.scheduling.sorter">INodeSorter</a></code></dd>
</dl>
</li>
</ul>
<a name="getSortedRacks--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSortedRacks</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/ObjectResourcesItem.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling">ObjectResourcesItem</a>&gt;&nbsp;getSortedRacks()</pre>
<div class="block"><p>Racks are sorted by two criteria.</p><p><p>1) the number executors of the topology that needs to be scheduled is already on the rack in descending order. The reasoning to sort based on criterion 1 is so we schedule the rest of a topology on the same rack as the existing executors of the topology.</p><p><p>2) the subordinate/subservient resource availability percentage of a rack in descending order We calculate the resource availability percentage by dividing the resource availability on the rack by the resource availability of the entire cluster By doing this calculation, racks that have exhausted or little of one of the resources mentioned above will be ranked after racks that have more balanced resource availability. So we will be less likely to pick a rack that have a lot of one resource but a low amount of another.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/sorter/INodeSorter.html#getSortedRacks--">getSortedRacks</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/sorter/INodeSorter.html" title="interface in org.apache.storm.scheduler.resource.strategies.scheduling.sorter">INodeSorter</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a sorted list of racks</dd>
</dl>
</li>
</ul>
<a name="hostnameToNodes-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>hostnameToNodes</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../../../org/apache/storm/scheduler/resource/RasNode.html" title="class in org.apache.storm.scheduler.resource">RasNode</a>&gt;&nbsp;hostnameToNodes(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;hostname)</pre>
<div class="block"><p>hostname to Ids.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>hostname</code> - the hostname.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the ids n that node.</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/NodeSorter.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 class="aboutLanguage"><script type="text/javascript" src="../../../../../../../../highlight.pack.js"></script>
<script type="text/javascript"><!--
hljs.initHighlightingOnLoad();
//--></script></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/sorter/INodeSorter.html" title="interface in org.apache.storm.scheduler.resource.strategies.scheduling.sorter"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/sorter/NodeSorter.ExistingScheduleFunc.html" title="interface in org.apache.storm.scheduler.resource.strategies.scheduling.sorter"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/storm/scheduler/resource/strategies/scheduling/sorter/NodeSorter.html" target="_top">Frames</a></li>
<li><a href="NodeSorter.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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>Copyright &#169; 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>