| <!DOCTYPE HTML> |
| <html lang> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>ClassPathModelProvider (Apache OpenNLP Tools Models 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.models, interface: ClassPathModelProvider"> |
| <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.7.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="../../../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.models</a></div> |
| <h1 title="Interface ClassPathModelProvider" class="title">Interface ClassPathModelProvider</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="DefaultClassPathModelProvider.html" title="class in opennlp.tools.models">DefaultClassPathModelProvider</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">ClassPathModelProvider</span></div> |
| <div class="block">A provider for obtaining pre-trained OpenNLP <code>models</code> from |
| an application's classpath. |
| <p> |
| Providing models available in the classpath requires a <a href="ClassPathModelFinder.html" title="interface in opennlp.tools.models"><code>finder</code></a> |
| and a <a href="ClassPathModelLoader.html" title="class in opennlp.tools.models"><code>ClassPathModelLoader</code></a> at runtime. Depending on the environment, |
| a custom <code>finder</code> can be used.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><code>BaseModel</code></li> |
| <li><a href="ClassPathModelFinder.html" title="interface in opennlp.tools.models"><code>ClassPathModelFinder</code></a></li> |
| <li><a href="ClassPathModelLoader.html" title="class in opennlp.tools.models"><code>ClassPathModelLoader</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" aria-labelledby="method-summary-table-tab0"> |
| <div class="summary-table three-column-summary"> |
| <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><T extends opennlp.tools.util.model.BaseModel><br>T</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#load(java.lang.String,opennlp.tools.models.ModelType,java.lang.Class)" class="member-name-link">load</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> lang, |
| opennlp.tools.models.ModelType type, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> modelType)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Restores a <a href="ClassPathModelProvider.html" title="interface in opennlp.tools.models"><code>model</code></a> among all classpath models at runtime |
| according to the specified parameters <code>lang</code> and <code>type</code>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><T extends opennlp.tools.util.model.BaseModel><br>T</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#load(java.lang.String,opennlp.tools.models.ModelType,java.lang.Class,boolean)" class="member-name-link">load</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> lang, |
| opennlp.tools.models.ModelType type, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> modelType, |
| boolean reloadCache)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Restores a <a href="ClassPathModelProvider.html" title="interface in opennlp.tools.models"><code>model</code></a> among all classpath models at runtime |
| according to the specified parameters <code>lang</code> and <code>type</code>.</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="load(java.lang.String,opennlp.tools.models.ModelType,java.lang.Class)"> |
| <h3>load</h3> |
| <div class="member-signature"><span class="type-parameters"><T extends opennlp.tools.util.model.BaseModel></span> <span class="return-type">T</span> <span class="element-name">load</span><wbr><span class="parameters">(<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> lang, |
| opennlp.tools.models.ModelType type, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> modelType)</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">Restores a <a href="ClassPathModelProvider.html" title="interface in opennlp.tools.models"><code>model</code></a> among all classpath models at runtime |
| according to the specified parameters <code>lang</code> and <code>type</code>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>lang</code> - The ISO language code of the requested model. If <code>null</code> or empty, |
| the result will be <code>null</code> as well.</dd> |
| <dd><code>type</code> - The type string to narrow down the model variant. Note: Custom naming patterns |
| can be applied here, as the <code>type</code> fragment will be used for a 'contains' |
| check internally.</dd> |
| <dd><code>modelType</code> - The class of model type parameter <a href="ClassPathModelProvider.html" title="interface in opennlp.tools.models"><code>ClassPathModelProvider</code></a> to create an instance of.</dd> |
| <dt>Returns:</dt> |
| <dd>An model instance of type <a href="ClassPathModelProvider.html" title="interface in opennlp.tools.models"><code>ClassPathModelProvider</code></a>, or <code>null</code> if no match was found |
| for the specified parameters.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - Thrown if parameters were invalid.</dd> |
| <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 something went wrong during reading resources from the classpath.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="load(java.lang.String,opennlp.tools.models.ModelType,java.lang.Class,boolean)"> |
| <h3>load</h3> |
| <div class="member-signature"><span class="type-parameters"><T extends opennlp.tools.util.model.BaseModel></span> <span class="return-type">T</span> <span class="element-name">load</span><wbr><span class="parameters">(<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> lang, |
| opennlp.tools.models.ModelType type, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> modelType, |
| boolean reloadCache)</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">Restores a <a href="ClassPathModelProvider.html" title="interface in opennlp.tools.models"><code>model</code></a> among all classpath models at runtime |
| according to the specified parameters <code>lang</code> and <code>type</code>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>lang</code> - The ISO language code of the requested model. If <code>null</code> or empty, |
| the result will be <code>null</code> as well.</dd> |
| <dd><code>type</code> - The type of model to specifiy the model variant.</dd> |
| <dd><code>modelType</code> - The class of model type parameter <a href="ClassPathModelProvider.html" title="interface in opennlp.tools.models"><code>ClassPathModelProvider</code></a> to create an instance of.</dd> |
| <dd><code>reloadCache</code> - <code>true</code>, if the internal cache of the <a href="ClassPathModelFinder.html" title="interface in opennlp.tools.models"><code>ClassPathModelFinder</code></a> |
| should explicitly be reloaded, <code>false</code> otherwise.</dd> |
| <dt>Returns:</dt> |
| <dd>An model instance of type <a href="ClassPathModelProvider.html" title="interface in opennlp.tools.models"><code>ClassPathModelProvider</code></a>, or <code>null</code> if no match was found |
| for the specified parameters.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - Thrown if parameters were invalid.</dd> |
| <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 something went wrong during reading resources from the classpath.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2025 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
