| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>AnnotatorUtil (Apache OpenNLP UIMA Annotators 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.uima.util, class: AnnotatorUtil"> |
| <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="../../../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.uima.util</a></div> |
| <h1 title="Class AnnotatorUtil" class="title">Class AnnotatorUtil</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/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">opennlp.uima.util.AnnotatorUtil</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">AnnotatorUtil</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> |
| <div class="block">This is a utility class for Annotators.</div> |
| </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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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-tab1 method-summary-table-tab4"><code>static <a href="https://www.apache.org/opennlp/opennlp-tools/apidocs/opennlp/tools/dictionary/Dictionary.html" title="class or interface in opennlp.tools.dictionary" class="external-link">Dictionary</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createOptionalDictionary(org.apache.uima.UimaContext,java.lang.String)" class="member-name-link">createOptionalDictionary</a><wbr>(org.apache.uima.UimaContext context, |
| <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> dictionaryParameter)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a <a href="https://www.apache.org/opennlp/opennlp-tools/apidocs/opennlp/tools/dictionary/Dictionary.html" title="class or interface in opennlp.tools.dictionary" class="external-link"><code>Dictionary</code></a> via the given <code>UimaContext</code>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getOptionalBooleanParameter(org.apache.uima.UimaContext,java.lang.String)" class="member-name-link">getOptionalBooleanParameter</a><wbr>(org.apache.uima.UimaContext context, |
| <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> parameter)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Retrieves an optional parameter from the given <code>UimaContext</code>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static org.apache.uima.cas.Feature</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getOptionalFeature(org.apache.uima.cas.Type,java.lang.String,java.lang.String)" class="member-name-link">getOptionalFeature</a><wbr>(org.apache.uima.cas.Type 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> featureName, |
| <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> rangeType)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Retrieves an optional <code>feature parameter</code> of specified type.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static org.apache.uima.cas.Feature</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getOptionalFeatureParameter(org.apache.uima.UimaContext,org.apache.uima.cas.Type,java.lang.String,java.lang.String)" class="member-name-link">getOptionalFeatureParameter</a><wbr>(org.apache.uima.UimaContext context, |
| org.apache.uima.cas.Type nameType, |
| <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> featureNameParameter, |
| <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> rangeTypeName)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Retrieves an optional <code>feature parameter</code> of specified type.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Float.html" title="class or interface in java.lang" class="external-link">Float</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getOptionalFloatParameter(org.apache.uima.UimaContext,java.lang.String)" class="member-name-link">getOptionalFloatParameter</a><wbr>(org.apache.uima.UimaContext context, |
| <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> parameter)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Retrieves an optional parameter from the given <code>UimaContext</code>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getOptionalIntegerParameter(org.apache.uima.UimaContext,java.lang.String)" class="member-name-link">getOptionalIntegerParameter</a><wbr>(org.apache.uima.UimaContext context, |
| <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> parameter)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Retrieves an optional parameter from the given <code>UimaContext</code>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link">InputStream</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getOptionalResourceAsStream(org.apache.uima.UimaContext,java.lang.String)" class="member-name-link">getOptionalResourceAsStream</a><wbr>(org.apache.uima.UimaContext context, |
| <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> name)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Opens an <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link"><code>InputStream</code></a> for an optional resource via the given <code>UimaContext</code>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <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-tab1 method-summary-table-tab4"><code><a href="#getOptionalStringArrayParameter(org.apache.uima.UimaContext,java.lang.String)" class="member-name-link">getOptionalStringArrayParameter</a><wbr>(org.apache.uima.UimaContext context, |
| <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> parameter)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Retrieves an optional parameter array from the given <code>UimaContext</code>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <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-tab1 method-summary-table-tab4"><code><a href="#getOptionalStringParameter(org.apache.uima.UimaContext,java.lang.String)" class="member-name-link">getOptionalStringParameter</a><wbr>(org.apache.uima.UimaContext context, |
| <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> parameter)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Retrieves an optional parameter from the given <code>UimaContext</code>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static org.apache.uima.cas.Type</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getOptionalTypeParameter(org.apache.uima.UimaContext,org.apache.uima.cas.TypeSystem,java.lang.String)" class="member-name-link">getOptionalTypeParameter</a><wbr>(org.apache.uima.UimaContext context, |
| org.apache.uima.cas.TypeSystem typeSystem, |
| <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> parameter)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Retrieves an optional <code>feature parameter</code> of specified type.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getRequiredBooleanParameter(org.apache.uima.UimaContext,java.lang.String)" class="member-name-link">getRequiredBooleanParameter</a><wbr>(org.apache.uima.UimaContext context, |
| <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> parameter)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Retrieves a required parameter from the given context.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static org.apache.uima.cas.Feature</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getRequiredFeature(org.apache.uima.cas.Type,java.lang.String)" class="member-name-link">getRequiredFeature</a><wbr>(org.apache.uima.cas.Type 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> featureName)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Retrieves a <code>Feature</code> for a specified type and <code>featureName</code>, |
| otherwise an exception is thrown.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static org.apache.uima.cas.Feature</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getRequiredFeature(org.apache.uima.cas.Type,java.lang.String,java.lang.String)" class="member-name-link">getRequiredFeature</a><wbr>(org.apache.uima.cas.Type 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> featureName, |
| <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> rangeType)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Retrieves a <code>Feature</code> of the given type.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static org.apache.uima.cas.Feature</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getRequiredFeatureParameter(org.apache.uima.UimaContext,org.apache.uima.cas.Type,java.lang.String)" class="member-name-link">getRequiredFeatureParameter</a><wbr>(org.apache.uima.UimaContext context, |
| org.apache.uima.cas.Type 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> featureNameParameter)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Retrieves a <code>feature parameter</code> of specified type.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static org.apache.uima.cas.Feature</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getRequiredFeatureParameter(org.apache.uima.UimaContext,org.apache.uima.cas.Type,java.lang.String,java.lang.String)" class="member-name-link">getRequiredFeatureParameter</a><wbr>(org.apache.uima.UimaContext context, |
| org.apache.uima.cas.Type 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> featureNameParameter, |
| <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> rangeTypeName)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Retrieves a <code>feature parameter</code> of specified type.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Float.html" title="class or interface in java.lang" class="external-link">Float</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getRequiredFloatParameter(org.apache.uima.UimaContext,java.lang.String)" class="member-name-link">getRequiredFloatParameter</a><wbr>(org.apache.uima.UimaContext context, |
| <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> parameter)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Retrieves a required parameter from the given context.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getRequiredIntegerParameter(org.apache.uima.UimaContext,java.lang.String)" class="member-name-link">getRequiredIntegerParameter</a><wbr>(org.apache.uima.UimaContext context, |
| <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> parameter)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Retrieves a required parameter from the given context.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <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-tab1 method-summary-table-tab4"><code><a href="#getRequiredStringParameter(org.apache.uima.UimaContext,java.lang.String)" class="member-name-link">getRequiredStringParameter</a><wbr>(org.apache.uima.UimaContext context, |
| <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> parameter)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Retrieves a required parameter from the given context.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static org.apache.uima.cas.Type</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getRequiredTypeParameter(org.apache.uima.UimaContext,org.apache.uima.cas.TypeSystem,java.lang.String)" class="member-name-link">getRequiredTypeParameter</a><wbr>(org.apache.uima.UimaContext context, |
| org.apache.uima.cas.TypeSystem typeSystem, |
| <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> parameter)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Retrieves a type of the given name from the given type system.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link">InputStream</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getResourceAsStream(org.apache.uima.UimaContext,java.lang.String)" class="member-name-link">getResourceAsStream</a><wbr>(org.apache.uima.UimaContext context, |
| <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> name)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Opens an <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link"><code>InputStream</code></a> for a resource via the given <code>UimaContext</code>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static org.apache.uima.cas.Type</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getType(org.apache.uima.cas.TypeSystem,java.lang.String)" class="member-name-link">getType</a><wbr>(org.apache.uima.cas.TypeSystem typeSystem, |
| <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> name)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Retrieves a type of the given name from the given type system.</div> |
| </div> |
| </div> |
| </div> |
| </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/17/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/17/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/17/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/17/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/17/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/17/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/17/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/17/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/17/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/17/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"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getType(org.apache.uima.cas.TypeSystem,java.lang.String)"> |
| <h3>getType</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">org.apache.uima.cas.Type</span> <span class="element-name">getType</span><wbr><span class="parameters">(org.apache.uima.cas.TypeSystem typeSystem, |
| <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> name)</span> |
| throws <span class="exceptions">org.apache.uima.analysis_engine.AnalysisEngineProcessException</span></div> |
| <div class="block">Retrieves a type of the given name from the given type system.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>typeSystem</code> - The <code>TypeSystem</code> to use.</dd> |
| <dd><code>name</code> - The name of the type to retrieve.</dd> |
| <dt>Returns:</dt> |
| <dd>The <code>Type</code> for the <code>name</code>.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="OpenNlpAnnotatorProcessException.html" title="class in opennlp.uima.util">OpenNlpAnnotatorProcessException</a></code> - Thrown if no <code>Type</code> could be found.</dd> |
| <dd><code>org.apache.uima.analysis_engine.AnalysisEngineProcessException</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRequiredFeature(org.apache.uima.cas.Type,java.lang.String)"> |
| <h3>getRequiredFeature</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">org.apache.uima.cas.Feature</span> <span class="element-name">getRequiredFeature</span><wbr><span class="parameters">(org.apache.uima.cas.Type 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> featureName)</span> |
| throws <span class="exceptions">org.apache.uima.analysis_engine.AnalysisEngineProcessException</span></div> |
| <div class="block">Retrieves a <code>Feature</code> for a specified type and <code>featureName</code>, |
| otherwise an exception is thrown.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>type</code> - The <code>Type</code> to use.</dd> |
| <dd><code>featureName</code> - The name of the feature to retrieve.</dd> |
| <dt>Returns:</dt> |
| <dd>The <code>Feature</code> if found.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="OpenNlpAnnotatorProcessException.html" title="class in opennlp.uima.util">OpenNlpAnnotatorProcessException</a></code> - Thrown if no <code>Feature</code> did match.</dd> |
| <dd><code>org.apache.uima.analysis_engine.AnalysisEngineProcessException</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRequiredFeature(org.apache.uima.cas.Type,java.lang.String,java.lang.String)"> |
| <h3>getRequiredFeature</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">org.apache.uima.cas.Feature</span> <span class="element-name">getRequiredFeature</span><wbr><span class="parameters">(org.apache.uima.cas.Type 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> featureName, |
| <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> rangeType)</span> |
| throws <span class="exceptions">org.apache.uima.analysis_engine.AnalysisEngineProcessException</span></div> |
| <div class="block">Retrieves a <code>Feature</code> of the given type.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>type</code> - The <code>Type</code> to use.</dd> |
| <dd><code>featureName</code> - The name of the feature to retrieve.</dd> |
| <dd><code>rangeType</code> - The expected range type.</dd> |
| <dt>Returns:</dt> |
| <dd>The <code>Feature</code> if found.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="OpenNlpAnnotatorProcessException.html" title="class in opennlp.uima.util">OpenNlpAnnotatorProcessException</a></code> - Thrown if no <code>Feature</code> did match.</dd> |
| <dd><code>org.apache.uima.analysis_engine.AnalysisEngineProcessException</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRequiredFeatureParameter(org.apache.uima.UimaContext,org.apache.uima.cas.Type,java.lang.String)"> |
| <h3>getRequiredFeatureParameter</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">org.apache.uima.cas.Feature</span> <span class="element-name">getRequiredFeatureParameter</span><wbr><span class="parameters">(org.apache.uima.UimaContext context, |
| org.apache.uima.cas.Type 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> featureNameParameter)</span> |
| throws <span class="exceptions">org.apache.uima.analysis_engine.AnalysisEngineProcessException</span></div> |
| <div class="block">Retrieves a <code>feature parameter</code> of specified type.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>context</code> - The <code>UimaContext</code> to use.</dd> |
| <dd><code>type</code> - The <code>Type</code> of the <code>Feature</code> to get.</dd> |
| <dd><code>featureNameParameter</code> - The name of the feature parameter.</dd> |
| <dt>Returns:</dt> |
| <dd>The <code>Feature</code> if found.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="OpenNlpAnnotatorProcessException.html" title="class in opennlp.uima.util">OpenNlpAnnotatorProcessException</a></code> - Thrown if no <code>Feature</code> did match.</dd> |
| <dd><code>org.apache.uima.analysis_engine.AnalysisEngineProcessException</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRequiredFeatureParameter(org.apache.uima.UimaContext,org.apache.uima.cas.Type,java.lang.String,java.lang.String)"> |
| <h3>getRequiredFeatureParameter</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">org.apache.uima.cas.Feature</span> <span class="element-name">getRequiredFeatureParameter</span><wbr><span class="parameters">(org.apache.uima.UimaContext context, |
| org.apache.uima.cas.Type 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> featureNameParameter, |
| <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> rangeTypeName)</span> |
| throws <span class="exceptions">org.apache.uima.analysis_engine.AnalysisEngineProcessException</span></div> |
| <div class="block">Retrieves a <code>feature parameter</code> of specified type.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>context</code> - The <code>UimaContext</code> to use.</dd> |
| <dd><code>type</code> - The <code>Type</code> of the <code>Feature</code> to get.</dd> |
| <dd><code>featureNameParameter</code> - The name of the feature parameter.</dd> |
| <dd><code>rangeTypeName</code> - The name of expected range type.</dd> |
| <dt>Returns:</dt> |
| <dd>The <code>Feature</code> if found.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="OpenNlpAnnotatorProcessException.html" title="class in opennlp.uima.util">OpenNlpAnnotatorProcessException</a></code> - Thrown if no <code>Feature</code> did match.</dd> |
| <dd><code>org.apache.uima.analysis_engine.AnalysisEngineProcessException</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRequiredTypeParameter(org.apache.uima.UimaContext,org.apache.uima.cas.TypeSystem,java.lang.String)"> |
| <h3>getRequiredTypeParameter</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">org.apache.uima.cas.Type</span> <span class="element-name">getRequiredTypeParameter</span><wbr><span class="parameters">(org.apache.uima.UimaContext context, |
| org.apache.uima.cas.TypeSystem typeSystem, |
| <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> parameter)</span> |
| throws <span class="exceptions">org.apache.uima.analysis_engine.AnalysisEngineProcessException</span></div> |
| <div class="block">Retrieves a type of the given name from the given type system.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>context</code> - The <code>UimaContext</code> to use.</dd> |
| <dd><code>typeSystem</code> - The <code>TypeSystem</code> to use.</dd> |
| <dd><code>parameter</code> - The name of the type to retrieve.</dd> |
| <dt>Returns:</dt> |
| <dd>The <code>Type</code> for the <code>name</code>.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="OpenNlpAnnotatorProcessException.html" title="class in opennlp.uima.util">OpenNlpAnnotatorProcessException</a></code> - Thrown if no <code>Type</code> could be found.</dd> |
| <dd><code>org.apache.uima.analysis_engine.AnalysisEngineProcessException</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRequiredStringParameter(org.apache.uima.UimaContext,java.lang.String)"> |
| <h3>getRequiredStringParameter</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <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">getRequiredStringParameter</span><wbr><span class="parameters">(org.apache.uima.UimaContext context, |
| <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> parameter)</span> |
| throws <span class="exceptions">org.apache.uima.resource.ResourceInitializationException</span></div> |
| <div class="block">Retrieves a required parameter from the given context.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>context</code> - The <code>UimaContext</code> to use.</dd> |
| <dd><code>parameter</code> - The name of the type to retrieve.</dd> |
| <dt>Returns:</dt> |
| <dd>The <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>String</code></a> value retrieved for a specified <code>parameter</code> |
| from the <code>context</code>.</dd> |
| <dt>Throws:</dt> |
| <dd><code>org.apache.uima.resource.ResourceInitializationException</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRequiredIntegerParameter(org.apache.uima.UimaContext,java.lang.String)"> |
| <h3>getRequiredIntegerParameter</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a></span> <span class="element-name">getRequiredIntegerParameter</span><wbr><span class="parameters">(org.apache.uima.UimaContext context, |
| <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> parameter)</span> |
| throws <span class="exceptions">org.apache.uima.resource.ResourceInitializationException</span></div> |
| <div class="block">Retrieves a required parameter from the given context.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>context</code> - The <code>UimaContext</code> to use.</dd> |
| <dd><code>parameter</code> - The name of the type to retrieve.</dd> |
| <dt>Returns:</dt> |
| <dd>The <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link"><code>Integer</code></a> value retrieved for a specified <code>parameter</code> |
| from the <code>context</code>.</dd> |
| <dt>Throws:</dt> |
| <dd><code>org.apache.uima.resource.ResourceInitializationException</code> - Thrown if no value} could be found.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRequiredFloatParameter(org.apache.uima.UimaContext,java.lang.String)"> |
| <h3>getRequiredFloatParameter</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Float.html" title="class or interface in java.lang" class="external-link">Float</a></span> <span class="element-name">getRequiredFloatParameter</span><wbr><span class="parameters">(org.apache.uima.UimaContext context, |
| <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> parameter)</span> |
| throws <span class="exceptions">org.apache.uima.resource.ResourceInitializationException</span></div> |
| <div class="block">Retrieves a required parameter from the given context.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>context</code> - The <code>UimaContext</code> to use.</dd> |
| <dd><code>parameter</code> - The name of the type to retrieve.</dd> |
| <dt>Returns:</dt> |
| <dd>The <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Float.html" title="class or interface in java.lang" class="external-link"><code>Float</code></a> value retrieved for a specified <code>parameter</code> |
| from the <code>context</code>.</dd> |
| <dt>Throws:</dt> |
| <dd><code>org.apache.uima.resource.ResourceInitializationException</code> - Thrown if no value} could be found.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRequiredBooleanParameter(org.apache.uima.UimaContext,java.lang.String)"> |
| <h3>getRequiredBooleanParameter</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a></span> <span class="element-name">getRequiredBooleanParameter</span><wbr><span class="parameters">(org.apache.uima.UimaContext context, |
| <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> parameter)</span> |
| throws <span class="exceptions">org.apache.uima.resource.ResourceInitializationException</span></div> |
| <div class="block">Retrieves a required parameter from the given context.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>context</code> - The <code>UimaContext</code> to use.</dd> |
| <dd><code>parameter</code> - The name of the type to retrieve.</dd> |
| <dt>Returns:</dt> |
| <dd>The <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link"><code>Boolean</code></a> value retrieved for a specified <code>parameter</code> |
| from the <code>context</code>.</dd> |
| <dt>Throws:</dt> |
| <dd><code>org.apache.uima.resource.ResourceInitializationException</code> - Thrown if no value} could be found.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOptionalFeatureParameter(org.apache.uima.UimaContext,org.apache.uima.cas.Type,java.lang.String,java.lang.String)"> |
| <h3>getOptionalFeatureParameter</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">org.apache.uima.cas.Feature</span> <span class="element-name">getOptionalFeatureParameter</span><wbr><span class="parameters">(org.apache.uima.UimaContext context, |
| org.apache.uima.cas.Type nameType, |
| <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> featureNameParameter, |
| <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> rangeTypeName)</span> |
| throws <span class="exceptions">org.apache.uima.analysis_engine.AnalysisEngineProcessException</span></div> |
| <div class="block">Retrieves an optional <code>feature parameter</code> of specified type.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>context</code> - The <code>UimaContext</code> to use.</dd> |
| <dd><code>nameType</code> - The <code>Type</code> of the <code>Feature</code> to get.</dd> |
| <dd><code>featureNameParameter</code> - The name of the feature parameter.</dd> |
| <dd><code>rangeTypeName</code> - The name of expected range type.</dd> |
| <dt>Returns:</dt> |
| <dd>The <code>Feature</code> if found.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="OpenNlpAnnotatorProcessException.html" title="class in opennlp.uima.util">OpenNlpAnnotatorProcessException</a></code> - Thrown if no <code>Feature</code> did match.</dd> |
| <dd><code>org.apache.uima.analysis_engine.AnalysisEngineProcessException</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOptionalFeature(org.apache.uima.cas.Type,java.lang.String,java.lang.String)"> |
| <h3>getOptionalFeature</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">org.apache.uima.cas.Feature</span> <span class="element-name">getOptionalFeature</span><wbr><span class="parameters">(org.apache.uima.cas.Type 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> featureName, |
| <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> rangeType)</span> |
| throws <span class="exceptions">org.apache.uima.analysis_engine.AnalysisEngineProcessException</span></div> |
| <div class="block">Retrieves an optional <code>feature parameter</code> of specified type.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>type</code> - The <code>Type</code> of the <code>Feature</code> to get.</dd> |
| <dd><code>featureName</code> - The name of the feature parameter.</dd> |
| <dd><code>rangeType</code> - The expected range type.</dd> |
| <dt>Returns:</dt> |
| <dd>The <code>Feature</code> if found.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="OpenNlpAnnotatorProcessException.html" title="class in opennlp.uima.util">OpenNlpAnnotatorProcessException</a></code> - Thrown if no <code>Feature</code> did match.</dd> |
| <dd><code>org.apache.uima.analysis_engine.AnalysisEngineProcessException</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOptionalTypeParameter(org.apache.uima.UimaContext,org.apache.uima.cas.TypeSystem,java.lang.String)"> |
| <h3>getOptionalTypeParameter</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">org.apache.uima.cas.Type</span> <span class="element-name">getOptionalTypeParameter</span><wbr><span class="parameters">(org.apache.uima.UimaContext context, |
| org.apache.uima.cas.TypeSystem typeSystem, |
| <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> parameter)</span> |
| throws <span class="exceptions">org.apache.uima.analysis_engine.AnalysisEngineProcessException</span></div> |
| <div class="block">Retrieves an optional <code>feature parameter</code> of specified type.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>context</code> - The <code>UimaContext</code> to use.</dd> |
| <dd><code>typeSystem</code> - The <code>TypeSystem</code> to use.</dd> |
| <dd><code>parameter</code> - The name of the type to retrieve.</dd> |
| <dt>Returns:</dt> |
| <dd>The <code>Type</code> for the <code>name</code>.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="OpenNlpAnnotatorProcessException.html" title="class in opennlp.uima.util">OpenNlpAnnotatorProcessException</a></code> - Thrown if no <code>Type</code> could be found.</dd> |
| <dd><code>org.apache.uima.analysis_engine.AnalysisEngineProcessException</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOptionalStringParameter(org.apache.uima.UimaContext,java.lang.String)"> |
| <h3>getOptionalStringParameter</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <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">getOptionalStringParameter</span><wbr><span class="parameters">(org.apache.uima.UimaContext context, |
| <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> parameter)</span> |
| throws <span class="exceptions">org.apache.uima.resource.ResourceInitializationException</span></div> |
| <div class="block">Retrieves an optional parameter from the given <code>UimaContext</code>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>context</code> - The <code>UimaContext</code> to use.</dd> |
| <dd><code>parameter</code> - The name of the parameter to retrieve.</dd> |
| <dt>Returns:</dt> |
| <dd>The <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>parameter</code></a> or <code>null</code> if not set.</dd> |
| <dt>Throws:</dt> |
| <dd><code>org.apache.uima.resource.ResourceInitializationException</code> - Thrown if the parameter type was not of the expected type.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOptionalStringArrayParameter(org.apache.uima.UimaContext,java.lang.String)"> |
| <h3>getOptionalStringArrayParameter</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <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">getOptionalStringArrayParameter</span><wbr><span class="parameters">(org.apache.uima.UimaContext context, |
| <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> parameter)</span> |
| throws <span class="exceptions">org.apache.uima.resource.ResourceInitializationException</span></div> |
| <div class="block">Retrieves an optional parameter array from the given <code>UimaContext</code>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>context</code> - The <code>UimaContext</code> to use.</dd> |
| <dd><code>parameter</code> - The name of the parameter to retrieve.</dd> |
| <dt>Returns:</dt> |
| <dd>The <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>parameter array</code></a> or an empty array if not set.</dd> |
| <dt>Throws:</dt> |
| <dd><code>org.apache.uima.resource.ResourceInitializationException</code> - Thrown if the parameter type was not of the expected type.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOptionalIntegerParameter(org.apache.uima.UimaContext,java.lang.String)"> |
| <h3>getOptionalIntegerParameter</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a></span> <span class="element-name">getOptionalIntegerParameter</span><wbr><span class="parameters">(org.apache.uima.UimaContext context, |
| <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> parameter)</span> |
| throws <span class="exceptions">org.apache.uima.resource.ResourceInitializationException</span></div> |
| <div class="block">Retrieves an optional parameter from the given <code>UimaContext</code>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>context</code> - The <code>UimaContext</code> to use.</dd> |
| <dd><code>parameter</code> - The name of the parameter to retrieve.</dd> |
| <dt>Returns:</dt> |
| <dd>The <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link"><code>parameter</code></a> or <code>null</code> if not set.</dd> |
| <dt>Throws:</dt> |
| <dd><code>org.apache.uima.resource.ResourceInitializationException</code> - Thrown if the parameter type was not of the expected type.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOptionalFloatParameter(org.apache.uima.UimaContext,java.lang.String)"> |
| <h3>getOptionalFloatParameter</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Float.html" title="class or interface in java.lang" class="external-link">Float</a></span> <span class="element-name">getOptionalFloatParameter</span><wbr><span class="parameters">(org.apache.uima.UimaContext context, |
| <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> parameter)</span> |
| throws <span class="exceptions">org.apache.uima.resource.ResourceInitializationException</span></div> |
| <div class="block">Retrieves an optional parameter from the given <code>UimaContext</code>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>context</code> - The <code>UimaContext</code> to use.</dd> |
| <dd><code>parameter</code> - The name of the parameter to retrieve.</dd> |
| <dt>Returns:</dt> |
| <dd>The <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Float.html" title="class or interface in java.lang" class="external-link"><code>parameter</code></a> or <code>null</code> if not set.</dd> |
| <dt>Throws:</dt> |
| <dd><code>org.apache.uima.resource.ResourceInitializationException</code> - Thrown if the parameter type was not of the expected type.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOptionalBooleanParameter(org.apache.uima.UimaContext,java.lang.String)"> |
| <h3>getOptionalBooleanParameter</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a></span> <span class="element-name">getOptionalBooleanParameter</span><wbr><span class="parameters">(org.apache.uima.UimaContext context, |
| <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> parameter)</span> |
| throws <span class="exceptions">org.apache.uima.resource.ResourceInitializationException</span></div> |
| <div class="block">Retrieves an optional parameter from the given <code>UimaContext</code>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>context</code> - The <code>UimaContext</code> to use.</dd> |
| <dd><code>parameter</code> - The name of the parameter to retrieve.</dd> |
| <dt>Returns:</dt> |
| <dd>The <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link"><code>parameter</code></a> or <code>null</code> if not set.</dd> |
| <dt>Throws:</dt> |
| <dd><code>org.apache.uima.resource.ResourceInitializationException</code> - Thrown if the parameter type was not of the expected type.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getResourceAsStream(org.apache.uima.UimaContext,java.lang.String)"> |
| <h3>getResourceAsStream</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link">InputStream</a></span> <span class="element-name">getResourceAsStream</span><wbr><span class="parameters">(org.apache.uima.UimaContext context, |
| <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> name)</span> |
| throws <span class="exceptions">org.apache.uima.resource.ResourceInitializationException</span></div> |
| <div class="block">Opens an <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link"><code>InputStream</code></a> for a resource via the given <code>UimaContext</code>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>context</code> - The <code>UimaContext</code> to use.</dd> |
| <dd><code>name</code> - The name that identifies the resource.</dd> |
| <dt>Returns:</dt> |
| <dd>A valid, open <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link"><code>InputStream</code></a>.</dd> |
| <dt>Throws:</dt> |
| <dd><code>org.apache.uima.resource.ResourceInitializationException</code> - Thrown if the resource could not be found.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOptionalResourceAsStream(org.apache.uima.UimaContext,java.lang.String)"> |
| <h3>getOptionalResourceAsStream</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link">InputStream</a></span> <span class="element-name">getOptionalResourceAsStream</span><wbr><span class="parameters">(org.apache.uima.UimaContext context, |
| <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> name)</span> |
| throws <span class="exceptions">org.apache.uima.resource.ResourceInitializationException</span></div> |
| <div class="block">Opens an <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link"><code>InputStream</code></a> for an optional resource via the given <code>UimaContext</code>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>context</code> - The <code>UimaContext</code> to use.</dd> |
| <dd><code>name</code> - The name that identifies the resource.</dd> |
| <dt>Returns:</dt> |
| <dd>A valid, open <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link"><code>InputStream</code></a>.</dd> |
| <dt>Throws:</dt> |
| <dd><code>org.apache.uima.resource.ResourceInitializationException</code> - Thrown if the resource could not be found.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createOptionalDictionary(org.apache.uima.UimaContext,java.lang.String)"> |
| <h3>createOptionalDictionary</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://www.apache.org/opennlp/opennlp-tools/apidocs/opennlp/tools/dictionary/Dictionary.html" title="class or interface in opennlp.tools.dictionary" class="external-link">Dictionary</a></span> <span class="element-name">createOptionalDictionary</span><wbr><span class="parameters">(org.apache.uima.UimaContext context, |
| <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> dictionaryParameter)</span> |
| throws <span class="exceptions">org.apache.uima.resource.ResourceInitializationException</span></div> |
| <div class="block">Creates a <a href="https://www.apache.org/opennlp/opennlp-tools/apidocs/opennlp/tools/dictionary/Dictionary.html" title="class or interface in opennlp.tools.dictionary" class="external-link"><code>Dictionary</code></a> via the given <code>UimaContext</code>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>context</code> - The <code>UimaContext</code> to use.</dd> |
| <dd><code>dictionaryParameter</code> - The name that identifies the dictionary.</dd> |
| <dt>Returns:</dt> |
| <dd>A valid <a href="https://www.apache.org/opennlp/opennlp-tools/apidocs/opennlp/tools/dictionary/Dictionary.html" title="class or interface in opennlp.tools.dictionary" class="external-link"><code>Dictionary</code></a> or <code>null</code> if IO errors occurred.</dd> |
| <dt>Throws:</dt> |
| <dd><code>org.apache.uima.resource.ResourceInitializationException</code> - Thrown if the resource could not be found.</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> |
