blob: 0a000c94b73c8b123ae41d99fb25b90ed1c8878b [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) -->
<title>opennlp.tools.namefind (Apache OpenNLP Tools 2.3.3 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.namefind">
<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>
<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>Related Packages&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 opennlp.tools.namefind" class="title">Package opennlp.tools.namefind</h1>
</div>
<hr>
<div class="package-signature">package <span class="element-name">opennlp.tools.namefind</span></div>
<section class="package-description" id="package-description">
<div class="block">Package related to finding proper names and numeric amounts.</div>
</section>
<section class="summary">
<ul class="summary-list">
<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><button id="class-summary-tab3" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab3', 2)" class="table-tab">Enum Classes</button><button id="class-summary-tab5" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab5', 2)" class="table-tab">Exceptions</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="BilouCodec.html" title="class in opennlp.tools.namefind">BilouCodec</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">The default <a href="../util/SequenceCodec.html" title="interface in opennlp.tools.util"><code>SequenceCodec</code></a> implementation according to the <code>BILOU</code> scheme.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="BilouNameFinderSequenceValidator.html" title="class in opennlp.tools.namefind">BilouNameFinderSequenceValidator</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">A <a href="../util/SequenceValidator.html" title="interface in opennlp.tools.util"><code>SequenceValidator</code></a> implementation for the <a href="BilouCodec.html" title="class in opennlp.tools.namefind"><code>BilouCodec</code></a>.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="BioCodec.html" title="class in opennlp.tools.namefind">BioCodec</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">The default <a href="../util/SequenceCodec.html" title="interface in opennlp.tools.util"><code>SequenceCodec</code></a> implementation according to the <code>BIO</code> scheme:
B: 'beginning' of a NE
I: 'inside', the word is inside a NE
O: 'outside', the word is a regular word outside a NE
See also the paper by Roth D. and Ratinov L.:
<a href="https://cogcomp.seas.upenn.edu/page/publication_view/199">
Design Challenges and Misconceptions in Named Entity Recognition</a>.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultNameContextGenerator.html" title="class in opennlp.tools.namefind">DefaultNameContextGenerator</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">A <a href="NameContextGenerator.html" title="interface in opennlp.tools.namefind"><code>NameContextGenerator</code></a> implementation for determining contextual features
for a <code>tag-chunk</code> style named-entity recognizer.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="DictionaryNameFinder.html" title="class in opennlp.tools.namefind">DictionaryNameFinder</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">This is a <a href="../dictionary/Dictionary.html" title="class in opennlp.tools.dictionary"><code>Dictionary</code></a> based <a href="TokenNameFinder.html" title="interface in opennlp.tools.namefind"><code>name finder</code></a>.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="DocumentNameFinder.html" title="interface in opennlp.tools.namefind">DocumentNameFinder</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Interface for processing an entire document allowing a <a href="TokenNameFinder.html" title="interface in opennlp.tools.namefind"><code>TokenNameFinder</code></a> to use context
from the entire document.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="NameContextGenerator.html" title="interface in opennlp.tools.namefind">NameContextGenerator</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Interface for generating the context for a <a href="TokenNameFinder.html" title="interface in opennlp.tools.namefind"><code>name finder</code></a> by
specifying a set of feature generators.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="NameFinderEventStream.html" title="class in opennlp.tools.namefind">NameFinderEventStream</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Class for creating an event stream out of data files for training an <a href="TokenNameFinder.html" title="interface in opennlp.tools.namefind"><code>TokenNameFinder</code></a>.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="NameFinderME.html" title="class in opennlp.tools.namefind">NameFinderME</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">A maximum-entropy-based <a href="TokenNameFinder.html" title="interface in opennlp.tools.namefind"><code>name finder</code></a> implementation.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="NameFinderSequenceValidator.html" title="class in opennlp.tools.namefind">NameFinderSequenceValidator</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">The default name finder <a href="../util/SequenceValidator.html" title="interface in opennlp.tools.util"><code>SequenceValidator</code></a> implementation.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="NameSample.html" title="class in opennlp.tools.namefind">NameSample</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Encapsulates names for a single unit of text.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="NameSampleDataStream.html" title="class in opennlp.tools.namefind">NameSampleDataStream</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">The <a href="NameSampleDataStream.html" title="class in opennlp.tools.namefind"><code>NameSampleDataStream</code></a> class converts tagged <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"><code>strings</code></a>
provided by a <a href="../ml/maxent/DataStream.html" title="interface in opennlp.tools.ml.maxent"><code>DataStream</code></a> to <a href="NameSample.html" title="class in opennlp.tools.namefind"><code>NameSample</code></a> objects.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="NameSampleSequenceStream.html" title="class in opennlp.tools.namefind">NameSampleSequenceStream</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">A <a href="../ml/model/SequenceStream.html" title="interface in opennlp.tools.ml.model"><code>SequenceStream</code></a> implementation encapsulating <a href="NameSample.html" title="class in opennlp.tools.namefind"><code>samples</code></a>.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="NameSampleTypeFilter.html" title="class in opennlp.tools.namefind">NameSampleTypeFilter</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">A <a href="../util/FilterObjectStream.html" title="class in opennlp.tools.util"><code>stream</code></a> which removes <a href="NameSample.html" title="class in opennlp.tools.namefind"><code>name samples</code></a>
which do not have a certain type.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="RegexNameFinder.html" title="class in opennlp.tools.namefind">RegexNameFinder</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">A <a href="TokenNameFinder.html" title="interface in opennlp.tools.namefind"><code>TokenNameFinder</code></a> implementation based on a series of regular expressions.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="RegexNameFinderFactory.html" title="class in opennlp.tools.namefind">RegexNameFinderFactory</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Returns a <a href="RegexNameFinder.html" title="class in opennlp.tools.namefind"><code>RegexNameFinder</code></a> based on a selection of
defaults or a configuration and a selection of defaults.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab3"><a href="RegexNameFinderFactory.DEFAULT_REGEX_NAME_FINDER.html" title="enum class in opennlp.tools.namefind">RegexNameFinderFactory.DEFAULT_REGEX_NAME_FINDER</a></div>
<div class="col-last even-row-color class-summary class-summary-tab3">
<div class="block">Enumeration of typical regex expressions available in OpenNLP.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="RegexNameFinderFactory.RegexAble.html" title="interface in opennlp.tools.namefind">RegexNameFinderFactory.RegexAble</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="TokenNameFinder.html" title="interface in opennlp.tools.namefind">TokenNameFinder</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">The interface for name finders which provide name tags for a sequence of tokens.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="TokenNameFinderCrossValidator.html" title="class in opennlp.tools.namefind">TokenNameFinderCrossValidator</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Cross validator for <a href="TokenNameFinder.html" title="interface in opennlp.tools.namefind"><code>TokenNameFinder</code></a>.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="TokenNameFinderEvaluationMonitor.html" title="interface in opennlp.tools.namefind">TokenNameFinderEvaluationMonitor</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">A marker interface for evaluating <a href="TokenNameFinder.html" title="interface in opennlp.tools.namefind"><code>name finders</code></a>.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="TokenNameFinderEvaluator.html" title="class in opennlp.tools.namefind">TokenNameFinderEvaluator</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">The <a href="TokenNameFinderEvaluator.html" title="class in opennlp.tools.namefind"><code>TokenNameFinderEvaluator</code></a> measures the performance
of the given <a href="TokenNameFinder.html" title="interface in opennlp.tools.namefind"><code>TokenNameFinder</code></a> with the provided
reference <a href="NameSample.html" title="class in opennlp.tools.namefind"><code>samples</code></a>.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="TokenNameFinderFactory.html" title="class in opennlp.tools.namefind">TokenNameFinderFactory</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">The factory that provides <a href="TokenNameFinder.html" title="interface in opennlp.tools.namefind"><code>TokenNameFinder</code></a> default implementations and
resources.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="TokenNameFinderModel.html" title="class in opennlp.tools.namefind">TokenNameFinderModel</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">The <a href="TokenNameFinderModel.html" title="class in opennlp.tools.namefind"><code>TokenNameFinderModel</code></a> is the model used by a learnable <a href="TokenNameFinder.html" title="interface in opennlp.tools.namefind"><code>TokenNameFinder</code></a>.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab5"><a href="TokenNameFinderModel.FeatureGeneratorCreationError.html" title="class in opennlp.tools.namefind">TokenNameFinderModel.FeatureGeneratorCreationError</a></div>
<div class="col-last even-row-color class-summary class-summary-tab5">&nbsp;</div>
</div>
</div>
</div>
</li>
</ul>
</section>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>