blob: 1c932d73e6464f692e4ac201be161d56b2918cdb [file] [log] [blame]
<!DOCTYPE HTML>
<html lang>
<head>
<!-- Generated by javadoc (17) -->
<title>opennlp.tools.langdetect (Apache OpenNLP Tools 2.5.6 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.langdetect">
<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.7.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.langdetect" class="title">Package opennlp.tools.langdetect</h1>
</div>
<hr>
<div class="package-signature">package <span class="element-name">opennlp.tools.langdetect</span></div>
<section class="package-description" id="package-description">
<div class="block">Package related to predicting languages from samples of text.</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-tab4" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab4', 2)" class="table-tab">Record Classes</button></div>
<div id="class-summary.tabpanel" role="tabpanel" aria-labelledby="class-summary-tab0">
<div class="summary-table two-column-summary">
<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="DefaultLanguageDetectorContextGenerator.html" title="class in opennlp.tools.langdetect">DefaultLanguageDetectorContextGenerator</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">A context generator for <a href="LanguageDetectorContextGenerator.html" title="interface in opennlp.tools.langdetect"><code>language detector</code></a>.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Language.html" title="class in opennlp.tools.langdetect">Language</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Class for holding the document language and its confidence</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="LanguageDetector.html" title="interface in opennlp.tools.langdetect">LanguageDetector</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">The interface for <a href="LanguageDetector.html" title="interface in opennlp.tools.langdetect"><code>LanguageDetector</code></a> which predicts the <a href="Language.html" title="class in opennlp.tools.langdetect"><code>Language</code></a> for a context.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="LanguageDetectorConfig.html" title="class in opennlp.tools.langdetect">LanguageDetectorConfig</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-tab1"><a href="LanguageDetectorContextGenerator.html" title="interface in opennlp.tools.langdetect">LanguageDetectorContextGenerator</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">A context generator interface for <a href="LanguageDetector.html" title="interface in opennlp.tools.langdetect"><code>LanguageDetector</code></a>.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="LanguageDetectorCrossValidator.html" title="class in opennlp.tools.langdetect">LanguageDetectorCrossValidator</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Cross validator for <a href="LanguageDetector.html" title="interface in opennlp.tools.langdetect"><code>LanguageDetector</code></a>.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="LanguageDetectorEvaluationMonitor.html" title="interface in opennlp.tools.langdetect">LanguageDetectorEvaluationMonitor</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">A marker interface for evaluating <a href="LanguageDetector.html" title="interface in opennlp.tools.langdetect"><code>language detectors</code></a>.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="LanguageDetectorEvaluator.html" title="class in opennlp.tools.langdetect">LanguageDetectorEvaluator</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">The <a href="LanguageDetectorEvaluator.html" title="class in opennlp.tools.langdetect"><code>LanguageDetectorEvaluator</code></a> measures the performance of
the given <a href="LanguageDetector.html" title="interface in opennlp.tools.langdetect"><code>LanguageDetector</code></a> with the provided reference
<a href="LanguageSample.html" title="class in opennlp.tools.langdetect"><code>LanguageSample</code></a>s.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="LanguageDetectorEventStream.html" title="class in opennlp.tools.langdetect">LanguageDetectorEventStream</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Iterator-like class for modeling an event stream of <a href="LanguageSample.html" title="class in opennlp.tools.langdetect"><code>samples</code></a>.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="LanguageDetectorFactory.html" title="class in opennlp.tools.langdetect">LanguageDetectorFactory</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Default factory used by <a href="LanguageDetector.html" title="interface in opennlp.tools.langdetect"><code>LanguageDetector</code></a>.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="LanguageDetectorME.html" title="class in opennlp.tools.langdetect">LanguageDetectorME</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Implements a learnable <a href="LanguageDetector.html" title="interface in opennlp.tools.langdetect"><code>LanguageDetector</code></a>.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="LanguageDetectorModel.html" title="class in opennlp.tools.langdetect">LanguageDetectorModel</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">The <a href="LanguageDetectorModel.html" title="class in opennlp.tools.langdetect"><code>LanguageDetectorModel</code></a> is the model used by a learnable <a href="LanguageDetector.html" title="interface in opennlp.tools.langdetect"><code>LanguageDetector</code></a>.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="LanguageDetectorSampleStream.html" title="class in opennlp.tools.langdetect">LanguageDetectorSampleStream</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">This class reads in string encoded <a href="../util/ObjectStream.html" title="interface in opennlp.tools.util"><code>training samples</code></a>, parses them
and outputs <a href="LanguageSample.html" title="class in opennlp.tools.langdetect"><code>LanguageSample</code></a> objects.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab4"><a href="LanguageSample.html" title="class in opennlp.tools.langdetect">LanguageSample</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab4">
<div class="block">Holds a classified document and its <a href="Language.html" title="class in opennlp.tools.langdetect"><code>Language</code></a>.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab4"><a href="ProbingLanguageDetectionResult.html" title="class in opennlp.tools.langdetect">ProbingLanguageDetectionResult</a></div>
<div class="col-last even-row-color class-summary class-summary-tab4">
<div class="block">A data container encapsulating language detection results.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ThreadSafeLanguageDetectorME.html" title="class in opennlp.tools.langdetect">ThreadSafeLanguageDetectorME</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">A thread-safe version of the <a href="LanguageDetectorME.html" title="class in opennlp.tools.langdetect"><code>LanguageDetectorME</code></a>.</div>
</div>
</div>
</div>
</div>
</li>
</ul>
</section>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2025 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>