blob: 1b592c783e962286091ee052257787341f94cd6a [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>org.apache.jmeter.report.processor (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">
<meta name="generator" content="javadoc/PackageWriterImpl">
<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="package-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 class="nav-bar-cell1-rev">Package</li>
<li>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#package">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Package:&nbsp;</li>
<li><a href="#package-description">Description</a>&nbsp;|&nbsp;</li>
<li><a href="#related-package-summary">Related Packages</a>&nbsp;|&nbsp;</li>
<li><a href="#class-summary">Classes and Interfaces</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">
<div class="header">
<h1 title="Package org.apache.jmeter.report.processor" class="title">Package org.apache.jmeter.report.processor</h1>
</div>
<hr>
<div class="package-signature">package <span class="element-name">org.apache.jmeter.report.processor</span></div>
<section class="package-description" id="package-description">
<div class="block">This package contains the components used for computing the data used by javascript graphs.</div>
</section>
<section class="summary">
<ul class="summary-list">
<li>
<div id="related-package-summary">
<div class="caption"><span>Related Packages</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="graph/package-summary.html">org.apache.jmeter.report.processor.graph</a></div>
<div class="col-last even-row-color">
<div class="block">This package contains the components used for computing the data used by javascript graphs.</div>
</div>
</div>
</div>
</li>
<li>
<div id="class-summary">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button></div>
<div id="class-summary.tabpanel" role="tabpanel">
<div class="summary-table two-column-summary" aria-labelledby="class-summary-tab0">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="AbstractAggregatorFactory.html" title="class in org.apache.jmeter.report.processor">AbstractAggregatorFactory</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">
A factory for creating AbstractAggregator objects.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="AbstractSampleConsumer.html" title="class in org.apache.jmeter.report.processor">AbstractSampleConsumer</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Base class for sample consumer implementations.<br>
Every sample consumer should extends this class to support basic consumer
features.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="AbstractSampleProcessor.html" title="class in org.apache.jmeter.report.processor">AbstractSampleProcessor</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Base for sample processor implementations<br>
Implements basic logic for setting sample context and handling channel
attributes.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="AbstractSampleSource.html" title="class in org.apache.jmeter.report.processor">AbstractSampleSource</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="AbstractSummaryConsumer.html" title="class in org.apache.jmeter.report.processor">AbstractSummaryConsumer</a>&lt;TData&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">The class AbstractSummaryConsumer provides a base class for data of the
dashboard page.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="AggregateConsumer.html" title="class in org.apache.jmeter.report.processor">AggregateConsumer</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">The Class AggregateConsumer provides a consumer that can aggregate samples to
provide a result</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="Aggregator.html" title="interface in org.apache.jmeter.report.processor">Aggregator</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">The interface Aggregator represents an aggregator used by graph consumers.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="AggregatorFactory.html" title="interface in org.apache.jmeter.report.processor">AggregatorFactory</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">A factory for creating Aggregator objects.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ApdexSummaryConsumer.html" title="class in org.apache.jmeter.report.processor">ApdexSummaryConsumer</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">
The class ApdexSummaryConsumer provides a consumer that calculates Apdex for
each sample name.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ApdexSummaryData.html" title="class in org.apache.jmeter.report.processor">ApdexSummaryData</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">The class ApdexSummaryData provides information for ApdexSummaryConsumer.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ApdexThresholdsInfo.html" title="class in org.apache.jmeter.report.processor">ApdexThresholdsInfo</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">The class ApdexThresholdsInfo provides a container for APDEX threshold
information.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ChannelContext.html" title="class in org.apache.jmeter.report.processor">ChannelContext</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Define a context associated to a sample consumer/producer channel</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="CsvFileSampleSource.html" title="class in org.apache.jmeter.report.processor">CsvFileSampleSource</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Read a csv source file and write its rows (samples) all the registered
<code>SampleConsumer</code>s.<br>
If there is several other source files with the same root name then those
files are produced on their corresponding channels.<br></div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DescriptiveStatisticsFactory.html" title="class in org.apache.jmeter.report.processor">DescriptiveStatisticsFactory</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ErrorsSummaryConsumer.html" title="class in org.apache.jmeter.report.processor">ErrorsSummaryConsumer</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">
The class ErrorSummaryConsumer provides a consumer that calculates error
statistics.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ExternalSampleSorter.html" title="class in org.apache.jmeter.report.processor">ExternalSampleSorter</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">R-way external sample sorter.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="FieldSampleComparator.html" title="class in org.apache.jmeter.report.processor">FieldSampleComparator</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="FilterConsumer.html" title="class in org.apache.jmeter.report.processor">FilterConsumer</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">
The class FilterConsumer provides a way to discard samples in a consumer
chain.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ListResultData.html" title="class in org.apache.jmeter.report.processor">ListResultData</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">The class ListResultData provides a list of results from sample processing.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="MapResultData.html" title="class in org.apache.jmeter.report.processor">MapResultData</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">The class MapResultData provides a hash map of results from samples
processing.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="MaxAggregator.html" title="class in org.apache.jmeter.report.processor">MaxAggregator</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">The class MaxAggregator is used to get maximum from samples.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="MaxAggregatorFactory.html" title="class in org.apache.jmeter.report.processor">MaxAggregatorFactory</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">A factory for creating MaxAggregator objects.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="MeanAggregator.html" title="class in org.apache.jmeter.report.processor">MeanAggregator</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">The class MeanAggregator is used to get mean from samples.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="MeanAggregatorFactory.html" title="class in org.apache.jmeter.report.processor">MeanAggregatorFactory</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">A factory for creating MeanAggregator objects.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="MedianAggregatorFactory.html" title="class in org.apache.jmeter.report.processor">MedianAggregatorFactory</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">A factory for creating PercentileAggregator with index of percentile fixed to
value 50.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="MinAggregator.html" title="class in org.apache.jmeter.report.processor">MinAggregator</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">The class MinAggregator is used to get minimum from samples.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="MinAggregatorFactory.html" title="class in org.apache.jmeter.report.processor">MinAggregatorFactory</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">A factory for creating MinAggregator objects.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="NormalizerSampleConsumer.html" title="class in org.apache.jmeter.report.processor">NormalizerSampleConsumer</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Consume samples using the JMeter timestamp property (defaulting to <a href="../../samplers/SampleSaveConfiguration.html#MILLISECONDS"><code>SampleSaveConfiguration.MILLISECONDS</code></a>) and reproduce them as a long
value (for faster treatment later in the consuming chain).</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="PercentileAggregator.html" title="class in org.apache.jmeter.report.processor">PercentileAggregator</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">The class PercentileAggregator is used to get percentile from samples.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="PercentileAggregatorFactory.html" title="class in org.apache.jmeter.report.processor">PercentileAggregatorFactory</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">A factory for creating PercentileAggregator objects.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="RequestsSummaryConsumer.html" title="class in org.apache.jmeter.report.processor">RequestsSummaryConsumer</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">
The class GrapherConsumer provides a consumer that count succeeded and failed
samples.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="ResultData.html" title="interface in org.apache.jmeter.report.processor">ResultData</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">The interface ResultData represents a result from samples processing.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="ResultDataVisitor.html" title="interface in org.apache.jmeter.report.processor">ResultDataVisitor</a>&lt;T&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">The interface ResultDataVisitor represents a visitor for result data from
samples processing.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="SampleConsumer.html" title="interface in org.apache.jmeter.report.processor">SampleConsumer</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Defines a sample consumer<br></div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="SampleContext.html" title="class in org.apache.jmeter.report.processor">SampleContext</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Defines the context in which <a href="SampleConsumer.html" title="interface in org.apache.jmeter.report.processor"><code>SampleConsumer</code></a>, <a href="SampleProducer.html" title="interface in org.apache.jmeter.report.processor"><code>SampleProducer</code></a>
will operate</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="SampleIndexer.html" title="interface in org.apache.jmeter.report.processor">SampleIndexer</a>&lt;TIndex&gt;</div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">The classes that implement interface SampleIndexer have to calculate an index
from a sample.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="SampleProcessor.html" title="interface in org.apache.jmeter.report.processor">SampleProcessor</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Defines a sample processor.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="SampleProducer.html" title="interface in org.apache.jmeter.report.processor">SampleProducer</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Defines a sample producer</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="SampleSource.html" title="interface in org.apache.jmeter.report.processor">SampleSource</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">The interface SampleSource represents a source of samples for sample consumers.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SampleWriterConsumer.html" title="class in org.apache.jmeter.report.processor">SampleWriterConsumer</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Sample consumed by this consumer are written to a file<br>
<br></div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="StatisticsSummaryConsumer.html" title="class in org.apache.jmeter.report.processor">StatisticsSummaryConsumer</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">The class StatisticsSummaryConsumer provides a consumer that calculates:
total number of samples
errors
error %
mean response time
median response time
percentile 1 (90% by default)
percentile 2 (95% by default)
percentile 3 (99% by default)
throughput
received bytes per second
sent bytes per second
min
max
</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="StatisticsSummaryData.html" title="class in org.apache.jmeter.report.processor">StatisticsSummaryData</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">The class ApdexSummaryData provides information for
StatisticsSummaryConsumer.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="SumAggregator.html" title="class in org.apache.jmeter.report.processor">SumAggregator</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">The class SumAggregator is used to get sum from samples.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SumAggregatorFactory.html" title="class in org.apache.jmeter.report.processor">SumAggregatorFactory</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">A factory for creating SumAggregator objects.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="TaggerConsumer.html" title="class in org.apache.jmeter.report.processor">TaggerConsumer</a>&lt;TIndex&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">The Class TimeCountConsumer adds a data field to the samples it consumes.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="ThresholdSelector.html" title="interface in org.apache.jmeter.report.processor">ThresholdSelector</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">The interface ThresholdSelector represents a projection from the samplers
with the same name to APDEX threshold information.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="TimeRateAggregator.html" title="class in org.apache.jmeter.report.processor">TimeRateAggregator</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">The class TimeRateAggregator is used to get samples rate by second.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="TimeRateAggregatorFactory.html" title="class in org.apache.jmeter.report.processor">TimeRateAggregatorFactory</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">A factory for creating TimeRateAggregator objects.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Top5ErrorsBySamplerConsumer.html" title="class in org.apache.jmeter.report.processor">Top5ErrorsBySamplerConsumer</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">The class Top5ErrorsBySamplerConsumer provides a consumer that calculates
the TOP5 of errors by sampler.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Top5ErrorsSummaryData.html" title="class in org.apache.jmeter.report.processor">Top5ErrorsSummaryData</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Summary data for TOP 5 of errors.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ValueResultData.html" title="class in org.apache.jmeter.report.processor">ValueResultData</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">This provides a value result from samples processing.</div>
</div>
</div>
</div>
</div>
</li>
</ul>
</section>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &copy; 1998-2024 Apache Software Foundation. All Rights Reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>