| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>DataIndexer (Apache OpenNLP Tools 2.3.2 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: opennlp.tools.ml.model, interface: DataIndexer"> |
| <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> |
| <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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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">opennlp.tools.ml.model</a></div> |
| <h1 title="Interface DataIndexer" class="title">Interface DataIndexer</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="AbstractDataIndexer.html" title="class in opennlp.tools.ml.model">AbstractDataIndexer</a></code>, <code><a href="OnePassDataIndexer.html" title="class in opennlp.tools.ml.model">OnePassDataIndexer</a></code>, <code><a href="OnePassRealValueDataIndexer.html" title="class in opennlp.tools.ml.model">OnePassRealValueDataIndexer</a></code>, <code><a href="TwoPassDataIndexer.html" title="class in opennlp.tools.ml.model">TwoPassDataIndexer</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">DataIndexer</span></div> |
| <div class="block">Represents an indexer which compresses events in memory and performs feature selection.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../util/ObjectStream.html" title="interface in opennlp.tools.util"><code>ObjectStream</code></a></li> |
| <li><a href="../../util/TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== 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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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-tab3"><code>int[][]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getContexts()" class="member-name-link">getContexts</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getNumEvents()" class="member-name-link">getNumEvents</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int[]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getNumTimesEventsSeen()" class="member-name-link">getNumTimesEventsSeen</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getOutcomeLabels()" class="member-name-link">getOutcomeLabels</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int[]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getOutcomeList()" class="member-name-link">getOutcomeList</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPredCounts()" class="member-name-link">getPredCounts</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/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 method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPredLabels()" class="member-name-link">getPredLabels</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>float[][]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getValues()" class="member-name-link">getValues</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#index(opennlp.tools.util.ObjectStream)" class="member-name-link">index</a><wbr>(<a href="../../util/ObjectStream.html" title="interface in opennlp.tools.util">ObjectStream</a><<a href="Event.html" title="class in opennlp.tools.ml.model">Event</a>> eventStream)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Performs the data indexing.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#init(opennlp.tools.util.TrainingParameters,java.util.Map)" class="member-name-link">init</a><wbr>(<a href="../../util/TrainingParameters.html" title="class in opennlp.tools.util">TrainingParameters</a> trainParams, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> reportMap)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets parameters used during the data indexing.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getContexts()"> |
| <h3>getContexts</h3> |
| <div class="member-signature"><span class="return-type">int[][]</span> <span class="element-name">getContexts</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Retrieves a 2-dimensional array whose first dimension is the event |
| index and array this refers to contains the contexts for that event.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getNumTimesEventsSeen()"> |
| <h3>getNumTimesEventsSeen</h3> |
| <div class="member-signature"><span class="return-type">int[]</span> <span class="element-name">getNumTimesEventsSeen</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Retrieves an array indexed by the event index indicating |
| the number of times a particular event was seen.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOutcomeList()"> |
| <h3>getOutcomeList</h3> |
| <div class="member-signature"><span class="return-type">int[]</span> <span class="element-name">getOutcomeList</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Retrieves an array indicating the outcome index for each event.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getPredLabels()"> |
| <h3>getPredLabels</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/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">getPredLabels</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Retrieves an array of predicate/context names indexed by context index. |
| These indices are the value of the array returned by <a href="#getContexts()"><code>getContexts()</code></a>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getPredCounts()"> |
| <h3>getPredCounts</h3> |
| <div class="member-signature"><span class="return-type">int[]</span> <span class="element-name">getPredCounts</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Retrieves an array of the count of each predicate in the events.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOutcomeLabels()"> |
| <h3>getOutcomeLabels</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/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">getOutcomeLabels</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Retrieves an array of outcome names indexed by outcome index.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getValues()"> |
| <h3>getValues</h3> |
| <div class="member-signature"><span class="return-type">float[][]</span> <span class="element-name">getValues</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Retrieves the values associated with each event context or |
| <code>null</code> if integer values are to be used.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getNumEvents()"> |
| <h3>getNumEvents</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name">getNumEvents</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Retrieves the number of total events indexed.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="init(opennlp.tools.util.TrainingParameters,java.util.Map)"> |
| <h3>init</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">init</span><wbr><span class="parameters">(<a href="../../util/TrainingParameters.html" title="class in opennlp.tools.util">TrainingParameters</a> trainParams, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> reportMap)</span></div> |
| <div class="block">Sets parameters used during the data indexing.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>trainParams</code> - The <a href="../../util/TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> to be used.</dd> |
| <dd><code>reportMap</code> - The <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link"><code>Map</code></a> used for reporting.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="index(opennlp.tools.util.ObjectStream)"> |
| <h3>index</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">index</span><wbr><span class="parameters">(<a href="../../util/ObjectStream.html" title="interface in opennlp.tools.util">ObjectStream</a><<a href="Event.html" title="class in opennlp.tools.ml.model">Event</a>> eventStream)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Performs the data indexing. |
| <p> |
| <b>Note:</b> |
| Make sure the <a href="#init(opennlp.tools.util.TrainingParameters,java.util.Map)"><code>init(TrainingParameters, Map)</code></a> method is called first.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>eventStream</code> - A <code><a href="../../util/ObjectStream.html" title="interface in opennlp.tools.util">ObjectStream</a><<a href="Event.html" title="class in opennlp.tools.ml.model">Event</a>></code> of events used as input.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - Thrown if IO errors occurred during indexing.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
