site/api/org/apache/jmeter/report/processor/ExternalSampleSorter.html - jmeter-site-preview - Git at Google

 <!DOCTYPE HTML>
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
 <title>ExternalSampleSorter (Apache JMeter dist API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta name="description" content="declaration: package: org.apache.jmeter.report.processor, class: ExternalSampleSorter">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
 <script type="text/javascript" src="../../../../../script.js"></script>
 <script type="text/javascript" src="../../../../../script-dir/jquery-3.6.1.min.js"></script>
 <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
 </head>
 <body class="class-declaration-page">
 <script type="text/javascript">var evenRowColor = "even-row-color";
 var oddRowColor = "odd-row-color";
 var tableTab = "table-tab";
 var activeTableTab = "active-table-tab";
 var pathtoroot = "../../../../../";
 loadScripts(document, 'script');</script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <div class="flex-box">
 <header role="banner" class="flex-header">
 <nav role="navigation">
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="top-nav" id="navbar-top">
 <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
 <div class="about-language"><b>Apache JMeter</b></div>
 <ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
 <li><a href="../../../../../index.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="nav-bar-cell1-rev">Class</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#class">Help</a></li>
 </ul>
 </div>
 <div class="sub-nav">
 <div>
 <ul class="sub-nav-list">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method-summary">Method</a></li>
 </ul>
 <ul class="sub-nav-list">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method-detail">Method</a></li>
 </ul>
 </div>
 <div class="nav-list-search"><label for="search-input">SEARCH:</label>
 <input type="text" id="search-input" value="search" disabled="disabled">
 <input type="reset" id="reset-button" value="reset" disabled="disabled">
 </div>
 </div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 <span class="skip-nav" id="skip-navbar-top"></span></nav>
 </header>
 <div class="flex-content">
 <main role="main">
 <!-- ======== START OF CLASS DATA ======== -->
 <div class="header">
 <div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.jmeter.report.processor</a></div>
 <h1 title="Class ExternalSampleSorter" class="title">Class ExternalSampleSorter</h1>
 </div>
 <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
 <div class="inheritance"><a href="AbstractSampleProcessor.html" title="class in org.apache.jmeter.report.processor">org.apache.jmeter.report.processor.AbstractSampleProcessor</a>
 <div class="inheritance"><a href="AbstractSampleConsumer.html" title="class in org.apache.jmeter.report.processor">org.apache.jmeter.report.processor.AbstractSampleConsumer</a>
 <div class="inheritance">org.apache.jmeter.report.processor.ExternalSampleSorter</div>
 </div>
 </div>
 </div>
 <section class="class-description" id="class-description">
 <dl class="notes">
 <dt>All Implemented Interfaces:</dt>
 <dd><code><a href="SampleConsumer.html" title="interface in org.apache.jmeter.report.processor">SampleConsumer</a></code>, <code><a href="SampleProcessor.html" title="interface in org.apache.jmeter.report.processor">SampleProcessor</a></code>, <code><a href="SampleProducer.html" title="interface in org.apache.jmeter.report.processor">SampleProducer</a></code></dd>
 </dl>
 <hr>
 <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ExternalSampleSorter</span>
 <span class="extends-implements">extends <a href="AbstractSampleConsumer.html" title="class in org.apache.jmeter.report.processor">AbstractSampleConsumer</a></span></div>
 <div class="block">R-way external sample sorter.
  <p>
  This SampleConsumer should be used to sort samples base on a
  <a href="../core/SampleComparator.html" title="interface in org.apache.jmeter.report.core"><code>SampleComparator</code></a>
  </p>
  <p>
  Samples are sorted with the external sort algorithm. Thus, samples are not
  all stored in memory to be sorted. Instead, they are sorted by chunk in
  memory and then written to the disk before being merged at the end.
  </p>
  <p>
  This sorter makes it possible to sort any number of samples with a fixed
  amount of memory. Hard disk will be used instead of RAM, at the cost of
  performance
  </p>
  <p>
  When <b>parallel mode</b> is enabled and several CPU are available to the
  JVM, this sorter uses multiple CPU to reduce sort time.<br>
  The <b>parallel mode</b> can be disabled if some sort of concurrency issue is
  encountered.
  </p>
  <p>
  As a last note, this <a href="SampleConsumer.html" title="interface in org.apache.jmeter.report.processor"><code>SampleConsumer</code></a> can be used as normal class with
  the different <code>sort()</code> methods
  </p>
  <p>
  It is important to set the <b><code>chunkSize</code></b> property according
  to the available memory as the algorithm does not take care of memory
  allocation (samples sizes are not predictable)
  </p>
  <p>
  Meanwhile, it is equally important to set a <a href="../core/SampleComparator.html" title="interface in org.apache.jmeter.report.core"><code>SampleComparator</code></a> to
  define sample ordering </p></div>
 <dl class="notes">
 <dt>Since:</dt>
 <dd>3.0</dd>
 </dl>
 </section>
 <section class="summary">
 <ul class="summary-list">
 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 <li>
 <section class="constructor-summary" id="constructor-summary">
 <h2>Constructor Summary</h2>
 <div class="caption"><span>Constructors</span></div>
 <div class="summary-table two-column-summary">
 <div class="table-header col-first">Constructor</div>
 <div class="table-header col-last">Description</div>
 <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">ExternalSampleSorter</a>()</code></div>
 <div class="col-last even-row-color">&nbsp;</div>
 <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.jmeter.report.core.SampleComparator)" class="member-name-link">ExternalSampleSorter</a><wbr>(<a href="../core/SampleComparator.html" title="interface in org.apache.jmeter.report.core">SampleComparator</a>&nbsp;comparator)</code></div>
 <div class="col-last odd-row-color">&nbsp;</div>
 </div>
 </section>
 </li>
 <!-- ========== METHOD SUMMARY =========== -->
 <li>
 <section class="method-summary" id="method-summary">
 <h2>Method Summary</h2>
 <div id="method-summary-table">
 <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
 <div id="method-summary-table.tabpanel" role="tabpanel">
 <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
 <div class="table-header col-first">Modifier and Type</div>
 <div class="table-header col-second">Method</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#consume(org.apache.jmeter.report.core.Sample,int)" class="member-name-link">consume</a><wbr>(<a href="../core/Sample.html" title="class in org.apache.jmeter.report.core">Sample</a>&nbsp;s,
  int&nbsp;channel)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Consumes the specified sample ton the specified channel.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isParallelize()" class="member-name-link">isParallelize</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final boolean</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isRevertedSort()" class="member-name-link">isRevertedSort</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#mergeFiles(java.util.List,org.apache.jmeter.report.core.SampleMetadata,org.apache.jmeter.report.processor.SampleProducer)" class="member-name-link">mergeFiles</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>&gt;&nbsp;chunks,
  <a href="../core/SampleMetadata.html" title="class in org.apache.jmeter.report.core">SampleMetadata</a>&nbsp;metadata,
  <a href="SampleProducer.html" title="interface in org.apache.jmeter.report.processor">SampleProducer</a>&nbsp;producer)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setChunkSize(long)" class="member-name-link">setChunkSize</a><wbr>(long&nbsp;chunkSize)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Set the number of samples that will be stored in memory.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setParallelize(boolean)" class="member-name-link">setParallelize</a><wbr>(boolean&nbsp;parallelize)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Enabled parallel mode</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setRevertedSort(boolean)" class="member-name-link">setRevertedSort</a><wbr>(boolean&nbsp;revertedSort)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final void</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setSampleComparator(org.apache.jmeter.report.core.SampleComparator)" class="member-name-link">setSampleComparator</a><wbr>(<a href="../core/SampleComparator.html" title="interface in org.apache.jmeter.report.core">SampleComparator</a>&nbsp;sampleComparator)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Set the sample comparator that will define sample ordering</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="../core/Sample.html" title="class in org.apache.jmeter.report.core">Sample</a>&gt;</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#sort(java.util.List)" class="member-name-link">sort</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="../core/Sample.html" title="class in org.apache.jmeter.report.core">Sample</a>&gt;&nbsp;samples)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#sort(org.apache.jmeter.report.core.CsvFile,java.io.File,boolean)" class="member-name-link">sort</a><wbr>(<a href="../core/CsvFile.html" title="class in org.apache.jmeter.report.core">CsvFile</a>&nbsp;inputFile,
  <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>&nbsp;outputFile,
  boolean&nbsp;writeHeader)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Sort an input CSV file to an sorted output CSV file.<br></div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#sort(org.apache.jmeter.report.core.SampleMetadata,java.io.File,java.io.File,boolean)" class="member-name-link">sort</a><wbr>(<a href="../core/SampleMetadata.html" title="class in org.apache.jmeter.report.core">SampleMetadata</a>&nbsp;sampleMetadata,
  <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>&nbsp;inputFile,
  <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>&nbsp;outputFile,
  boolean&nbsp;writeHeader)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Sort an input CSV file whose metadata structure is provided.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#startConsuming()" class="member-name-link">startConsuming</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Start the sample consuming.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#stopConsuming()" class="member-name-link">stopConsuming</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Stops the consuming process.</div>
 </div>
 </div>
 </div>
 </div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-org.apache.jmeter.report.processor.AbstractSampleConsumer">Methods inherited from class&nbsp;org.apache.jmeter.report.processor.<a href="AbstractSampleConsumer.html" title="class in org.apache.jmeter.report.processor">AbstractSampleConsumer</a></h3>
 <code><a href="AbstractSampleConsumer.html#addSampleConsumer(org.apache.jmeter.report.processor.SampleConsumer)">addSampleConsumer</a>, <a href="AbstractSampleConsumer.html#getConsumedChannelCount()">getConsumedChannelCount</a>, <a href="AbstractSampleConsumer.html#getConsumedMetadata(int)">getConsumedMetadata</a>, <a href="AbstractSampleConsumer.html#getConsumer(int)">getConsumer</a>, <a href="AbstractSampleConsumer.html#getDataFromContext(java.lang.String)">getDataFromContext</a>, <a href="AbstractSampleConsumer.html#getName()">getName</a>, <a href="AbstractSampleConsumer.html#getWorkingDirectory()">getWorkingDirectory</a>, <a href="AbstractSampleConsumer.html#produce(org.apache.jmeter.report.core.Sample,int)">produce</a>, <a href="AbstractSampleConsumer.html#removeSampleConsumer(org.apache.jmeter.report.processor.SampleConsumer)">removeSampleConsumer</a>, <a href="AbstractSampleConsumer.html#setChannelAttribute(int,java.lang.String,java.lang.Object)">setChannelAttribute</a>, <a href="AbstractSampleConsumer.html#setConsumedMetadata(org.apache.jmeter.report.core.SampleMetadata,int)">setConsumedMetadata</a>, <a href="AbstractSampleConsumer.html#setDataToContext(java.lang.String,java.lang.Object)">setDataToContext</a>, <a href="AbstractSampleConsumer.html#setName(java.lang.String)">setName</a>, <a href="AbstractSampleConsumer.html#setProducedMetadata(org.apache.jmeter.report.core.SampleMetadata,int)">setProducedMetadata</a>, <a href="AbstractSampleConsumer.html#setSampleConsumer(org.apache.jmeter.report.processor.SampleConsumer)">setSampleConsumer</a>, <a href="AbstractSampleConsumer.html#setSampleConsumers(java.util.List)">setSampleConsumers</a>, <a href="AbstractSampleConsumer.html#setSampleContext(org.apache.jmeter.report.processor.SampleContext)">setSampleContext</a>, <a href="AbstractSampleConsumer.html#startProducing()">startProducing</a>, <a href="AbstractSampleConsumer.html#stopProducing()">stopProducing</a></code></div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-org.apache.jmeter.report.processor.AbstractSampleProcessor">Methods inherited from class&nbsp;org.apache.jmeter.report.processor.<a href="AbstractSampleProcessor.html" title="class in org.apache.jmeter.report.processor">AbstractSampleProcessor</a></h3>
 <code><a href="AbstractSampleProcessor.html#getChannelAttribute(int,java.lang.String)">getChannelAttribute</a>, <a href="AbstractSampleProcessor.html#getSampleContext()">getSampleContext</a></code></div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
 <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-" title="class or interface in java.lang" class="external-link">wait</a></code></div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-org.apache.jmeter.report.processor.SampleProcessor">Methods inherited from interface&nbsp;org.apache.jmeter.report.processor.<a href="SampleProcessor.html" title="interface in org.apache.jmeter.report.processor">SampleProcessor</a></h3>
 <code><a href="SampleProcessor.html#getChannelAttribute(int,java.lang.String)">getChannelAttribute</a>, <a href="SampleProcessor.html#getSampleContext()">getSampleContext</a></code></div>
 </section>
 </li>
 </ul>
 </section>
 <section class="details">
 <ul class="details-list">
 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 <li>
 <section class="constructor-details" id="constructor-detail">
 <h2>Constructor Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="&lt;init&gt;()">
 <h3>ExternalSampleSorter</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">ExternalSampleSorter</span>()</div>
 </section>
 </li>
 <li>
 <section class="detail" id="&lt;init&gt;(org.apache.jmeter.report.core.SampleComparator)">
 <h3>ExternalSampleSorter</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">ExternalSampleSorter</span><wbr><span class="parameters">(<a href="../core/SampleComparator.html" title="interface in org.apache.jmeter.report.core">SampleComparator</a>&nbsp;comparator)</span></div>
 </section>
 </li>
 </ul>
 </section>
 </li>
 <!-- ============ METHOD DETAIL ========== -->
 <li>
 <section class="method-details" id="method-detail">
 <h2>Method Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="setChunkSize(long)">
 <h3>setChunkSize</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setChunkSize</span><wbr><span class="parameters">(long&nbsp;chunkSize)</span></div>
 <div class="block">Set the number of samples that will be stored in memory. This
  defines the number of samples that will be written in each chunk file
  before merging step as well.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>chunkSize</code> - The number of samples sorted in memory before they are written
             to disk. 5000 is the minimum and will be used if given
             chunkSize is less than 5000</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="setSampleComparator(org.apache.jmeter.report.core.SampleComparator)">
 <h3>setSampleComparator</h3>
 <div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setSampleComparator</span><wbr><span class="parameters">(<a href="../core/SampleComparator.html" title="interface in org.apache.jmeter.report.core">SampleComparator</a>&nbsp;sampleComparator)</span></div>
 <div class="block">Set the sample comparator that will define sample ordering</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>sampleComparator</code> - comparator to define the ordering</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="setParallelize(boolean)">
 <h3>setParallelize</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setParallelize</span><wbr><span class="parameters">(boolean&nbsp;parallelize)</span></div>
 <div class="block">Enabled parallel mode</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>parallelize</code> - <code>true</code> to enable, <code>false</code> to disable</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="isParallelize()">
 <h3>isParallelize</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isParallelize</span>()</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd><code>true</code> when parallel mode is enabled, <code>false</code> otherwise</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="sort(org.apache.jmeter.report.core.CsvFile,java.io.File,boolean)">
 <h3>sort</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">sort</span><wbr><span class="parameters">(<a href="../core/CsvFile.html" title="class in org.apache.jmeter.report.core">CsvFile</a>&nbsp;inputFile,
  <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>&nbsp;outputFile,
  boolean&nbsp;writeHeader)</span></div>
 <div class="block">Sort an input CSV file to an sorted output CSV file.<br>
  <p>
  The input CSV <b>must</b> have a header otherwise sorting will give
  unpredictable results
  </p></div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>inputFile</code> - The CSV file to be sorted (must not be <code>null</code>)</dd>
 <dd><code>outputFile</code> - The sorted destination CSV file (must not be <code>null</code>)</dd>
 <dd><code>writeHeader</code> - Whether the CSV header should be written to the output CSV file</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="sort(org.apache.jmeter.report.core.SampleMetadata,java.io.File,java.io.File,boolean)">
 <h3>sort</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">sort</span><wbr><span class="parameters">(<a href="../core/SampleMetadata.html" title="class in org.apache.jmeter.report.core">SampleMetadata</a>&nbsp;sampleMetadata,
  <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>&nbsp;inputFile,
  <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>&nbsp;outputFile,
  boolean&nbsp;writeHeader)</span></div>
 <div class="block">Sort an input CSV file whose metadata structure is provided. Use this
  method when input CSV file has no header : header information is then
  provided through the sampleMetadata parameter.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>sampleMetadata</code> - The CSV metadata : header information + separator (must not be <code>null</code>)</dd>
 <dd><code>inputFile</code> - The input file to be sorted (must not be <code>null</code>)</dd>
 <dd><code>outputFile</code> - The output sorted file (must not be <code>null</code>)</dd>
 <dd><code>writeHeader</code> - Whether output CSV header should be written (based on provided
             sample metadata)</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="startConsuming()">
 <h3>startConsuming</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">startConsuming</span>()</div>
 <div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="SampleConsumer.html#startConsuming()">SampleConsumer</a></code></span></div>
 <div class="block">Start the sample consuming. This step is used by consumer to initialize
  their process.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="consume(org.apache.jmeter.report.core.Sample,int)">
 <h3>consume</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">consume</span><wbr><span class="parameters">(<a href="../core/Sample.html" title="class in org.apache.jmeter.report.core">Sample</a>&nbsp;s,
  int&nbsp;channel)</span></div>
 <div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="SampleConsumer.html#consume(org.apache.jmeter.report.core.Sample,int)">SampleConsumer</a></code></span></div>
 <div class="block">Consumes the specified sample ton the specified channel.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>s</code> - The sample to be consumed</dd>
 <dd><code>channel</code> - The channel on which the sample is consumed</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="stopConsuming()">
 <h3>stopConsuming</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">stopConsuming</span>()</div>
 <div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="SampleConsumer.html#stopConsuming()">SampleConsumer</a></code></span></div>
 <div class="block">Stops the consuming process. No sample will be processed after this
  service has been called.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="sort(java.util.List)">
 <h3>sort</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="../core/Sample.html" title="class in org.apache.jmeter.report.core">Sample</a>&gt;</span>&nbsp;<span class="element-name">sort</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="../core/Sample.html" title="class in org.apache.jmeter.report.core">Sample</a>&gt;&nbsp;samples)</span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="mergeFiles(java.util.List,org.apache.jmeter.report.core.SampleMetadata,org.apache.jmeter.report.processor.SampleProducer)">
 <h3>mergeFiles</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">mergeFiles</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>&gt;&nbsp;chunks,
  <a href="../core/SampleMetadata.html" title="class in org.apache.jmeter.report.core">SampleMetadata</a>&nbsp;metadata,
  <a href="SampleProducer.html" title="interface in org.apache.jmeter.report.processor">SampleProducer</a>&nbsp;producer)</span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="isRevertedSort()">
 <h3>isRevertedSort</h3>
 <div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isRevertedSort</span>()</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>flag, whether the order of the sort should be reverted</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="setRevertedSort(boolean)">
 <h3>setRevertedSort</h3>
 <div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setRevertedSort</span><wbr><span class="parameters">(boolean&nbsp;revertedSort)</span></div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>revertedSort</code> - flag, whether the order of the sort should be reverted.
             <code>false</code> uses the order of the configured
             <a href="../core/SampleComparator.html" title="interface in org.apache.jmeter.report.core"><code>SampleComparator</code></a></dd>
 </dl>
 </section>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </section>
 <!-- ========= END OF CLASS DATA ========= -->
 </main>
 <footer role="contentinfo">
 <hr>
 <p class="legal-copy"><small>Copyright © 1998-2022 Apache Software Foundation. All Rights Reserved.</small></p>
 </footer>
 </div>
 </div>
 </body>
 </html>