| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>CsvFileSampleSource (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: CsvFileSampleSource"> |
| <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: </li> |
| <li>Nested | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </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> <a href="package-summary.html">org.apache.jmeter.report.processor</a></div> |
| <h1 title="Class CsvFileSampleSource" class="title">Class CsvFileSampleSource</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="AbstractSampleSource.html" title="class in org.apache.jmeter.report.processor">org.apache.jmeter.report.processor.AbstractSampleSource</a> |
| <div class="inheritance">org.apache.jmeter.report.processor.CsvFileSampleSource</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Runnable.html" title="class or interface in java.lang" class="external-link">Runnable</a></code>, <code><a href="SampleSource.html" title="interface in org.apache.jmeter.report.processor">SampleSource</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">CsvFileSampleSource</span> |
| <span class="extends-implements">extends <a href="AbstractSampleSource.html" title="class in org.apache.jmeter.report.processor">AbstractSampleSource</a></span></div> |
| <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> |
| <p> |
| The root name of the files is determined by the source file name and is made |
| of its name without the file extension :<br> |
| <b>Example:</b> If <code>results.csv</code> is the source file name then |
| <code>results</code> is the root file name.<br> |
| <br> |
| The <code>CsvFileSampleSource</code> looks for all the files in the same |
| directory of the main source file that have the same root file name<br> |
| <b>Example</b> : if the directory contains <code>results.csv</code>, |
| <code>results-1.csv</code>, <code>results-2.csv</code>, etc. then all |
| these files will be read and produced on their corresponding channels.<br> |
| The channel on which an input file will be produce is determined by its |
| suffix<br> |
| <ul> |
| <li>If the input file is named <code>results-1.csv</code> then it will |
| be produced on the channel 1.</li> |
| <li>If the input file is named <code>results-2.csv</code> then it will |
| be produced on the channel 2.</li> |
| <li>If the input file is named <code>results.csv</code> then it will |
| be produced on the channel 0.</li> |
| </ul></div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>3.0</dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#SOURCE_FILE_ATTRIBUTE" class="member-name-link">SOURCE_FILE_ATTRIBUTE</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">File name whose sample are being produced on the channel</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ======== 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(java.io.File,char)" class="member-name-link">CsvFileSampleSource</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a> inputFile, |
| char separator)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Build a sample source from the specified input file and character |
| separator.</div> |
| </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="#addSampleConsumer(org.apache.jmeter.report.processor.SampleConsumer)" class="member-name-link">addSampleConsumer</a><wbr>(<a href="SampleConsumer.html" title="interface in org.apache.jmeter.report.processor">SampleConsumer</a> consumer)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add a sample consumer to this sample source.</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="#removeSampleConsumer(org.apache.jmeter.report.processor.SampleConsumer)" class="member-name-link">removeSampleConsumer</a><wbr>(<a href="SampleConsumer.html" title="interface in org.apache.jmeter.report.processor">SampleConsumer</a> consumer)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Remove a sample consumer from this sample source.</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="#run()" class="member-name-link">run</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Run this sample source.<br> |
| This sample source will start reading all inputs CSV files and produce |
| their samples to this sample source registered sample consumers.</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="#setSampleConsumers(java.util.List)" class="member-name-link">setSampleConsumers</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="SampleConsumer.html" title="interface in org.apache.jmeter.report.processor">SampleConsumer</a>> consumers)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the specified sample consumers that will consume samples produced by |
| this sample source.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.jmeter.report.processor.AbstractSampleSource">Methods inherited from class org.apache.jmeter.report.processor.<a href="AbstractSampleSource.html" title="class in org.apache.jmeter.report.processor">AbstractSampleSource</a></h3> |
| <code><a href="AbstractSampleSource.html#getSampleContext()">getSampleContext</a>, <a href="AbstractSampleSource.html#setSampleContext(org.apache.jmeter.report.processor.SampleContext)">setSampleContext</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class 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> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="SOURCE_FILE_ATTRIBUTE"> |
| <h3>SOURCE_FILE_ATTRIBUTE</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">SOURCE_FILE_ATTRIBUTE</span></div> |
| <div class="block">File name whose sample are being produced on the channel</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.jmeter.report.processor.CsvFileSampleSource.SOURCE_FILE_ATTRIBUTE">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(java.io.File,char)"> |
| <h3>CsvFileSampleSource</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">CsvFileSampleSource</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a> inputFile, |
| char separator)</span></div> |
| <div class="block">Build a sample source from the specified input file and character |
| separator.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>inputFile</code> - The input sample file (CSV file) (must not be <code>null</code>)</dd> |
| <dd><code>separator</code> - The character separator to be used for delimiting samples |
| columns</dd> |
| </dl> |
| </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="setSampleConsumers(java.util.List)"> |
| <h3>setSampleConsumers</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setSampleConsumers</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="SampleConsumer.html" title="interface in org.apache.jmeter.report.processor">SampleConsumer</a>> consumers)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SampleSource.html#setSampleConsumers(java.util.List)">SampleSource</a></code></span></div> |
| <div class="block">Sets the specified sample consumers that will consume samples produced by |
| this sample source.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="SampleSource.html#setSampleConsumers(java.util.List)">setSampleConsumers</a></code> in interface <code><a href="SampleSource.html" title="interface in org.apache.jmeter.report.processor">SampleSource</a></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="AbstractSampleSource.html#setSampleConsumers(java.util.List)">setSampleConsumers</a></code> in class <code><a href="AbstractSampleSource.html" title="class in org.apache.jmeter.report.processor">AbstractSampleSource</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>consumers</code> - consumers to be set</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addSampleConsumer(org.apache.jmeter.report.processor.SampleConsumer)"> |
| <h3>addSampleConsumer</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addSampleConsumer</span><wbr><span class="parameters">(<a href="SampleConsumer.html" title="interface in org.apache.jmeter.report.processor">SampleConsumer</a> consumer)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SampleSource.html#addSampleConsumer(org.apache.jmeter.report.processor.SampleConsumer)">SampleSource</a></code></span></div> |
| <div class="block">Add a sample consumer to this sample source.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="SampleSource.html#addSampleConsumer(org.apache.jmeter.report.processor.SampleConsumer)">addSampleConsumer</a></code> in interface <code><a href="SampleSource.html" title="interface in org.apache.jmeter.report.processor">SampleSource</a></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="AbstractSampleSource.html#addSampleConsumer(org.apache.jmeter.report.processor.SampleConsumer)">addSampleConsumer</a></code> in class <code><a href="AbstractSampleSource.html" title="class in org.apache.jmeter.report.processor">AbstractSampleSource</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>consumer</code> - consumer to be added</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="removeSampleConsumer(org.apache.jmeter.report.processor.SampleConsumer)"> |
| <h3>removeSampleConsumer</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">removeSampleConsumer</span><wbr><span class="parameters">(<a href="SampleConsumer.html" title="interface in org.apache.jmeter.report.processor">SampleConsumer</a> consumer)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SampleSource.html#removeSampleConsumer(org.apache.jmeter.report.processor.SampleConsumer)">SampleSource</a></code></span></div> |
| <div class="block">Remove a sample consumer from this sample source.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="SampleSource.html#removeSampleConsumer(org.apache.jmeter.report.processor.SampleConsumer)">removeSampleConsumer</a></code> in interface <code><a href="SampleSource.html" title="interface in org.apache.jmeter.report.processor">SampleSource</a></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="AbstractSampleSource.html#removeSampleConsumer(org.apache.jmeter.report.processor.SampleConsumer)">removeSampleConsumer</a></code> in class <code><a href="AbstractSampleSource.html" title="class in org.apache.jmeter.report.processor">AbstractSampleSource</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>consumer</code> - consumer to be removed</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="run()"> |
| <h3>run</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">run</span>()</div> |
| <div class="block">Run this sample source.<br> |
| This sample source will start reading all inputs CSV files and produce |
| their samples to this sample source registered sample consumers.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Runnable.html#run()" title="class or interface in java.lang" class="external-link">run</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Runnable.html" title="class or interface in java.lang" class="external-link">Runnable</a></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="AbstractSampleSource.html#run()">run</a></code> in class <code><a href="AbstractSampleSource.html" title="class in org.apache.jmeter.report.processor">AbstractSampleSource</a></code></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-2024 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
