Google Git
Sign in
apache / jmeter-site / refs/heads/asf-site / . / api / org / apache / jmeter / report / processor / FilterConsumer.html
blob: 05a601d08b928da30895d5ba1ffe6b3ce7d70b6e [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>FilterConsumer (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: FilterConsumer">
<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 FilterConsumer" class="title">Class FilterConsumer</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/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.FilterConsumer</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">FilterConsumer</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"><p>
The class FilterConsumer provides a way to discard samples in a consumer
chain. This class uses a predicate for the filtering decision.
</p>
<ul>
<li>
When reverseFilter is false, samples are discarded if none predicate is
defined or samples don't match the predicate.</li>
<li>
When reverseFilter is true, samples are discarded if a predicate is defined
and samples match the predicate.</li>
</ul></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">FilterConsumer</a>()</code></div>
<div class="col-last even-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;sample,
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>final <a href="../core/SamplePredicate.html" title="interface in org.apache.jmeter.report.core">SamplePredicate</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSamplePredicate()" class="member-name-link">getSamplePredicate</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Gets the sample predicate used to filter the samples.</div>
</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="#isReverseFilter()" class="member-name-link">isReverseFilter</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Checks if the filtering is reversed.</div>
</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="#setReverseFilter(boolean)" class="member-name-link">setReverseFilter</a><wbr>(boolean&nbsp;reverseFilter)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Reverses the filtering decision.</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="#setSamplePredicate(org.apache.jmeter.report.core.SamplePredicate)" class="member-name-link">setSamplePredicate</a><wbr>(<a href="../core/SamplePredicate.html" title="interface in org.apache.jmeter.report.core">SamplePredicate</a>&nbsp;samplePredicate)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets the sample predicate used to filter the samples.</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/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/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/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/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>FilterConsumer</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">FilterConsumer</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="isReverseFilter()">
<h3>isReverseFilter</h3>
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isReverseFilter</span>()</div>
<div class="block">Checks if the filtering is reversed.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>true if the filtering is reversed; otherwise false.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setReverseFilter(boolean)">
<h3>setReverseFilter</h3>
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setReverseFilter</span><wbr><span class="parameters">(boolean&nbsp;reverseFilter)</span></div>
<div class="block">Reverses the filtering decision.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>reverseFilter</code> - the filter mode to set</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getSamplePredicate()">
<h3>getSamplePredicate</h3>
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type"><a href="../core/SamplePredicate.html" title="interface in org.apache.jmeter.report.core">SamplePredicate</a></span>&nbsp;<span class="element-name">getSamplePredicate</span>()</div>
<div class="block">Gets the sample predicate used to filter the samples.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the sample predicate used to filter the samples.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setSamplePredicate(org.apache.jmeter.report.core.SamplePredicate)">
<h3>setSamplePredicate</h3>
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setSamplePredicate</span><wbr><span class="parameters">(<a href="../core/SamplePredicate.html" title="interface in org.apache.jmeter.report.core">SamplePredicate</a>&nbsp;samplePredicate)</span></div>
<div class="block">Sets the sample predicate used to filter the samples.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>samplePredicate</code> - the new sample predicate.</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;sample,
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>sample</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>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</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>