docs/2.3.2/apidocs/opennlp-tools/opennlp/tools/parser/treeinsert/Parser.html - opennlp-site - Git at Google

 <!DOCTYPE HTML>
 <html lang="de">
 <head>
 <!-- Generated by javadoc (17) -->
 <title>Parser (Apache OpenNLP Tools 2.3.2 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta name="description" content="declaration: package: opennlp.tools.parser.treeinsert, class: Parser">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 <script type="text/javascript" src="../../../../script-dir/jquery-3.6.1.min.js"></script>
 <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
 </head>
 <body class="class-declaration-page">
 <script type="text/javascript">var evenRowColor = "even-row-color";
 var oddRowColor = "odd-row-color";
 var tableTab = "table-tab";
 var activeTableTab = "active-table-tab";
 var pathtoroot = "../../../../";
 loadScripts(document, 'script');</script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <div class="flex-box">
 <header role="banner" class="flex-header">
 <nav role="navigation">
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="top-nav" id="navbar-top">
 <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
 <ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
 <li><a href="../../../../index.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="nav-bar-cell1-rev">Class</li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../../index-all.html">Index</a></li>
 <li><a href="../../../../help-doc.html#class">Help</a></li>
 </ul>
 </div>
 <div class="sub-nav">
 <div>
 <ul class="sub-nav-list">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method-summary">Method</a></li>
 </ul>
 <ul class="sub-nav-list">
 <li>Detail:&nbsp;</li>
 <li><a href="#field-detail">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</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>&nbsp;<a href="package-summary.html">opennlp.tools.parser.treeinsert</a></div>
 <h1 title="Class Parser" class="title">Class Parser</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"><a href="../AbstractBottomUpParser.html" title="class in opennlp.tools.parser">opennlp.tools.parser.AbstractBottomUpParser</a>
 <div class="inheritance">opennlp.tools.parser.treeinsert.Parser</div>
 </div>
 </div>
 <section class="class-description" id="class-description">
 <dl class="notes">
 <dt>All Implemented Interfaces:</dt>
 <dd><code><a href="../Parser.html" title="interface in opennlp.tools.parser">Parser</a></code></dd>
 </dl>
 <hr>
 <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">Parser</span>
 <span class="extends-implements">extends <a href="../AbstractBottomUpParser.html" title="class in opennlp.tools.parser">AbstractBottomUpParser</a></span></div>
 <div class="block">A built-attach <a href="../Parser.html" title="interface in opennlp.tools.parser"><code>Parser</code></a> implementation.
  <p>
  Nodes are built when their left-most child is encountered.
  Subsequent children are attached as daughters.
  Attachment is based on node in the right-frontier
  of the tree. After each attachment or building, nodes are
  assessed as either complete or incomplete. Complete nodes
  are no longer eligible for daughter attachment.
  <p>
  Complex modifiers which produce additional node
  levels of the same type are attached with sister-adjunction.
  Attachment can not take place higher in the right-frontier
  than an incomplete node.</div>
 <dl class="notes">
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list">
 <li><a href="../AbstractBottomUpParser.html" title="class in opennlp.tools.parser"><code>AbstractBottomUpParser</code></a></li>
 <li><a href="../Parser.html" title="interface in opennlp.tools.parser"><code>Parser</code></a></li>
 </ul>
 </dd>
 </dl>
 </section>
 <section class="summary">
 <ul class="summary-list">
 <!-- =========== FIELD SUMMARY =========== -->
 <li>
 <section class="field-summary" id="field-summary">
 <h2>Field Summary</h2>
 <div class="caption"><span>Fields</span></div>
 <div class="summary-table three-column-summary">
 <div class="table-header col-first">Modifier and Type</div>
 <div class="table-header col-second">Field</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color"><code>static final <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"><code><a href="#ATTACH_DAUGHTER" class="member-name-link">ATTACH_DAUGHTER</a></code></div>
 <div class="col-last even-row-color">
 <div class="block">Outcome used when a node should be attached as a daughter to another node.</div>
 </div>
 <div class="col-first odd-row-color"><code>static final <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"><code><a href="#ATTACH_SISTER" class="member-name-link">ATTACH_SISTER</a></code></div>
 <div class="col-last odd-row-color">
 <div class="block">Outcome used when a node should be attached as a sister to another node.</div>
 </div>
 <div class="col-first even-row-color"><code>static final <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"><code><a href="#BUILT" class="member-name-link">BUILT</a></code></div>
 <div class="col-last even-row-color">
 <div class="block">Label used to distinguish build nodes from non-built nodes.</div>
 </div>
 <div class="col-first odd-row-color"><code>static final <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"><code><a href="#DONE" class="member-name-link">DONE</a></code></div>
 <div class="col-last odd-row-color">
 <div class="block">Outcome used when a constituent needs an no additional parent node/building.</div>
 </div>
 <div class="col-first even-row-color"><code>static final <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"><code><a href="#NON_ATTACH" class="member-name-link">NON_ATTACH</a></code></div>
 <div class="col-last even-row-color">
 <div class="block">Outcome used when a node should not be attached to another node.</div>
 </div>
 </div>
 <div class="inherited-list">
 <h3 id="fields-inherited-from-class-opennlp.tools.parser.AbstractBottomUpParser">Fields inherited from class&nbsp;opennlp.tools.parser.<a href="../AbstractBottomUpParser.html" title="class in opennlp.tools.parser">AbstractBottomUpParser</a></h3>
 <code><a href="../AbstractBottomUpParser.html#COMPLETE">COMPLETE</a>, <a href="../AbstractBottomUpParser.html#CONT">CONT</a>, <a href="../AbstractBottomUpParser.html#defaultAdvancePercentage">defaultAdvancePercentage</a>, <a href="../AbstractBottomUpParser.html#defaultBeamSize">defaultBeamSize</a>, <a href="../AbstractBottomUpParser.html#INC_NODE">INC_NODE</a>, <a href="../AbstractBottomUpParser.html#INCOMPLETE">INCOMPLETE</a>, <a href="../AbstractBottomUpParser.html#OTHER">OTHER</a>, <a href="../AbstractBottomUpParser.html#START">START</a>, <a href="../AbstractBottomUpParser.html#TOK_NODE">TOK_NODE</a>, <a href="../AbstractBottomUpParser.html#TOP_NODE">TOP_NODE</a></code></div>
 </section>
 </li>
 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 <li>
 <section class="constructor-summary" id="constructor-summary">
 <h2>Constructor Summary</h2>
 <div class="caption"><span>Constructors</span></div>
 <div class="summary-table two-column-summary">
 <div class="table-header col-first">Constructor</div>
 <div class="table-header col-last">Description</div>
 <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(opennlp.tools.parser.ParserModel)" class="member-name-link">Parser</a><wbr>(<a href="../ParserModel.html" title="class in opennlp.tools.parser">ParserModel</a>&nbsp;model)</code></div>
 <div class="col-last even-row-color">
 <div class="block">Instantiates a <a href="Parser.html" title="class in opennlp.tools.parser.treeinsert"><code>Parser</code></a> via a given <code>model</code>.</div>
 </div>
 <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(opennlp.tools.parser.ParserModel,int,double)" class="member-name-link">Parser</a><wbr>(<a href="../ParserModel.html" title="class in opennlp.tools.parser">ParserModel</a>&nbsp;model,
  int&nbsp;beamSize,
  double&nbsp;advancePercentage)</code></div>
 <div class="col-last odd-row-color">
 <div class="block">Instantiates a <a href="Parser.html" title="class in opennlp.tools.parser.treeinsert"><code>Parser</code></a> via a given <code>model</code> and
  other configuration parameters.</div>
 </div>
 </div>
 </section>
 </li>
 <!-- ========== 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://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="../Parse.html" title="class in opennlp.tools.parser">Parse</a>&gt;</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getRightFrontier(opennlp.tools.parser.Parse,java.util.Set)" class="member-name-link">getRightFrontier</a><wbr>(<a href="../Parse.html" title="class in opennlp.tools.parser">Parse</a>&nbsp;root,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;<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>&gt;&nbsp;punctSet)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">Returns the right frontier of the specified <a href="../Parse.html" title="class in opennlp.tools.parser"><code>tree</code></a> with nodes ordered from deepest
  to shallowest.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../ParserModel.html" title="class in opennlp.tools.parser">ParserModel</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#train(java.lang.String,opennlp.tools.util.ObjectStream,opennlp.tools.parser.HeadRules,int,int)" class="member-name-link">train</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>&nbsp;languageCode,
  <a href="../../util/ObjectStream.html" title="interface in opennlp.tools.util">ObjectStream</a>&lt;<a href="../Parse.html" title="class in opennlp.tools.parser">Parse</a>&gt;&nbsp;parseSamples,
  <a href="../HeadRules.html" title="interface in opennlp.tools.parser">HeadRules</a>&nbsp;rules,
  int&nbsp;iterations,
  int&nbsp;cutoff)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">Starts a training of a <a href="../ParserModel.html" title="class in opennlp.tools.parser"><code>ParserModel</code></a>.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../ParserModel.html" title="class in opennlp.tools.parser">ParserModel</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#train(java.lang.String,opennlp.tools.util.ObjectStream,opennlp.tools.parser.HeadRules,opennlp.tools.util.TrainingParameters)" class="member-name-link">train</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>&nbsp;languageCode,
  <a href="../../util/ObjectStream.html" title="interface in opennlp.tools.util">ObjectStream</a>&lt;<a href="../Parse.html" title="class in opennlp.tools.parser">Parse</a>&gt;&nbsp;parseSamples,
  <a href="../HeadRules.html" title="interface in opennlp.tools.parser">HeadRules</a>&nbsp;rules,
  <a href="../../util/TrainingParameters.html" title="class in opennlp.tools.util">TrainingParameters</a>&nbsp;mlParams)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">Starts a training of a <a href="../ParserModel.html" title="class in opennlp.tools.parser"><code>ParserModel</code></a>.</div>
 </div>
 </div>
 </div>
 </div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-opennlp.tools.parser.AbstractBottomUpParser">Methods inherited from class&nbsp;opennlp.tools.parser.<a href="../AbstractBottomUpParser.html" title="class in opennlp.tools.parser">AbstractBottomUpParser</a></h3>
 <code><a href="../AbstractBottomUpParser.html#buildDictionary(opennlp.tools.util.ObjectStream,opennlp.tools.parser.HeadRules,int)">buildDictionary</a>, <a href="../AbstractBottomUpParser.html#buildDictionary(opennlp.tools.util.ObjectStream,opennlp.tools.parser.HeadRules,opennlp.tools.util.TrainingParameters)">buildDictionary</a>, <a href="../AbstractBottomUpParser.html#collapsePunctuation(opennlp.tools.parser.Parse%5B%5D,java.util.Set)">collapsePunctuation</a>, <a href="../AbstractBottomUpParser.html#parse(opennlp.tools.parser.Parse)">parse</a>, <a href="../AbstractBottomUpParser.html#parse(opennlp.tools.parser.Parse,int)">parse</a>, <a href="../AbstractBottomUpParser.html#setErrorReporting(boolean)">setErrorReporting</a>, <a href="../AbstractBottomUpParser.html#setParents(opennlp.tools.parser.Parse)">setParents</a></code></div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;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">
 <!-- ============ FIELD DETAIL =========== -->
 <li>
 <section class="field-details" id="field-detail">
 <h2>Field Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="DONE">
 <h3>DONE</h3>
 <div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<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>&nbsp;<span class="element-name">DONE</span></div>
 <div class="block">Outcome used when a constituent needs an no additional parent node/building.</div>
 <dl class="notes">
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list">
 <li><a href="../../../../constant-values.html#opennlp.tools.parser.treeinsert.Parser.DONE">Constant Field Values</a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="ATTACH_SISTER">
 <h3>ATTACH_SISTER</h3>
 <div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<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>&nbsp;<span class="element-name">ATTACH_SISTER</span></div>
 <div class="block">Outcome used when a node should be attached as a sister to another node.</div>
 <dl class="notes">
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list">
 <li><a href="../../../../constant-values.html#opennlp.tools.parser.treeinsert.Parser.ATTACH_SISTER">Constant Field Values</a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="ATTACH_DAUGHTER">
 <h3>ATTACH_DAUGHTER</h3>
 <div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<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>&nbsp;<span class="element-name">ATTACH_DAUGHTER</span></div>
 <div class="block">Outcome used when a node should be attached as a daughter to another node.</div>
 <dl class="notes">
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list">
 <li><a href="../../../../constant-values.html#opennlp.tools.parser.treeinsert.Parser.ATTACH_DAUGHTER">Constant Field Values</a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="NON_ATTACH">
 <h3>NON_ATTACH</h3>
 <div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<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>&nbsp;<span class="element-name">NON_ATTACH</span></div>
 <div class="block">Outcome used when a node should not be attached to another node.</div>
 <dl class="notes">
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list">
 <li><a href="../../../../constant-values.html#opennlp.tools.parser.treeinsert.Parser.NON_ATTACH">Constant Field Values</a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="BUILT">
 <h3>BUILT</h3>
 <div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<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>&nbsp;<span class="element-name">BUILT</span></div>
 <div class="block">Label used to distinguish build nodes from non-built nodes.</div>
 <dl class="notes">
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list">
 <li><a href="../../../../constant-values.html#opennlp.tools.parser.treeinsert.Parser.BUILT">Constant Field Values</a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 </ul>
 </section>
 </li>
 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 <li>
 <section class="constructor-details" id="constructor-detail">
 <h2>Constructor Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="&lt;init&gt;(opennlp.tools.parser.ParserModel,int,double)">
 <h3>Parser</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">Parser</span><wbr><span class="parameters">(<a href="../ParserModel.html" title="class in opennlp.tools.parser">ParserModel</a>&nbsp;model,
  int&nbsp;beamSize,
  double&nbsp;advancePercentage)</span></div>
 <div class="block">Instantiates a <a href="Parser.html" title="class in opennlp.tools.parser.treeinsert"><code>Parser</code></a> via a given <code>model</code> and
  other configuration parameters. Uses the default implementations of
  <a href="../../postag/POSTaggerME.html" title="class in opennlp.tools.postag"><code>POSTaggerME</code></a> and <a href="../../chunker/ChunkerME.html" title="class in opennlp.tools.chunker"><code>ChunkerME</code></a>.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>model</code> - The <a href="../ParserModel.html" title="class in opennlp.tools.parser"><code>ParserModel</code></a> to use.</dd>
 <dd><code>beamSize</code> - The number of different parses kept during parsing.</dd>
 <dd><code>advancePercentage</code> - The minimal amount of probability mass which advanced outcomes
                           must represent. Only outcomes which contribute to the top
                           <code>advancePercentage</code> will be explored.</dd>
 <dt>Throws:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - Thrown if the <a href="../ParserType.html" title="enum class in opennlp.tools.parser"><code>ParserType</code></a> is not supported.</dd>
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list">
 <li><a href="../ParserModel.html" title="class in opennlp.tools.parser"><code>ParserModel</code></a></li>
 <li><a href="../../postag/POSTaggerME.html" title="class in opennlp.tools.postag"><code>POSTaggerME</code></a></li>
 <li><a href="../../chunker/ChunkerME.html" title="class in opennlp.tools.chunker"><code>ChunkerME</code></a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="&lt;init&gt;(opennlp.tools.parser.ParserModel)">
 <h3>Parser</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">Parser</span><wbr><span class="parameters">(<a href="../ParserModel.html" title="class in opennlp.tools.parser">ParserModel</a>&nbsp;model)</span></div>
 <div class="block">Instantiates a <a href="Parser.html" title="class in opennlp.tools.parser.treeinsert"><code>Parser</code></a> via a given <code>model</code>.
  Uses the default implementations of <a href="../../postag/POSTaggerME.html" title="class in opennlp.tools.postag"><code>POSTaggerME</code></a> and <a href="../../chunker/ChunkerME.html" title="class in opennlp.tools.chunker"><code>ChunkerME</code></a>
  and default values for <code>beamSize</code> and <code>advancePercentage</code>.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>model</code> - The <a href="../ParserModel.html" title="class in opennlp.tools.parser"><code>ParserModel</code></a> to use.</dd>
 <dt>Throws:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - Thrown if the <a href="../ParserType.html" title="enum class in opennlp.tools.parser"><code>ParserType</code></a> is not supported.</dd>
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list">
 <li><a href="../ParserModel.html" title="class in opennlp.tools.parser"><code>ParserModel</code></a></li>
 <li><a href="../../postag/POSTaggerME.html" title="class in opennlp.tools.postag"><code>POSTaggerME</code></a></li>
 <li><a href="../../chunker/ChunkerME.html" title="class in opennlp.tools.chunker"><code>ChunkerME</code></a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 </ul>
 </section>
 </li>
 <!-- ============ METHOD DETAIL ========== -->
 <li>
 <section class="method-details" id="method-detail">
 <h2>Method Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="getRightFrontier(opennlp.tools.parser.Parse,java.util.Set)">
 <h3>getRightFrontier</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="../Parse.html" title="class in opennlp.tools.parser">Parse</a>&gt;</span>&nbsp;<span class="element-name">getRightFrontier</span><wbr><span class="parameters">(<a href="../Parse.html" title="class in opennlp.tools.parser">Parse</a>&nbsp;root,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;<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>&gt;&nbsp;punctSet)</span></div>
 <div class="block">Returns the right frontier of the specified <a href="../Parse.html" title="class in opennlp.tools.parser"><code>tree</code></a> with nodes ordered from deepest
  to shallowest.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>root</code> - The <a href="../Parse.html" title="class in opennlp.tools.parser"><code>root</code></a> of the parse tree.</dd>
 <dd><code>punctSet</code> - A set of punctuation symbols to be used.</dd>
 <dt>Returns:</dt>
 <dd>The right frontier of the specified parse tree.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="train(java.lang.String,opennlp.tools.util.ObjectStream,opennlp.tools.parser.HeadRules,opennlp.tools.util.TrainingParameters)">
 <h3>train</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="../ParserModel.html" title="class in opennlp.tools.parser">ParserModel</a></span>&nbsp;<span class="element-name">train</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>&nbsp;languageCode,
  <a href="../../util/ObjectStream.html" title="interface in opennlp.tools.util">ObjectStream</a>&lt;<a href="../Parse.html" title="class in opennlp.tools.parser">Parse</a>&gt;&nbsp;parseSamples,
  <a href="../HeadRules.html" title="interface in opennlp.tools.parser">HeadRules</a>&nbsp;rules,
  <a href="../../util/TrainingParameters.html" title="class in opennlp.tools.util">TrainingParameters</a>&nbsp;mlParams)</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">Starts a training of a <a href="../ParserModel.html" title="class in opennlp.tools.parser"><code>ParserModel</code></a>.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>languageCode</code> - An ISO conform language code.</dd>
 <dd><code>parseSamples</code> - The <a href="../../util/ObjectStream.html" title="interface in opennlp.tools.util"><code>samples</code></a> as input.</dd>
 <dd><code>rules</code> - The <a href="../HeadRules.html" title="interface in opennlp.tools.parser"><code>HeadRules</code></a> to use.</dd>
 <dd><code>mlParams</code> - The <a href="../../util/TrainingParameters.html" title="class in opennlp.tools.util"><code>parameters</code></a> for training.</dd>
 <dt>Returns:</dt>
 <dd>A valid <a href="../ParserModel.html" title="class in opennlp.tools.parser"><code>ParserModel</code></a>.</dd>
 <dt>Throws:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - Thrown if IO errors occurred during training.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="train(java.lang.String,opennlp.tools.util.ObjectStream,opennlp.tools.parser.HeadRules,int,int)">
 <h3>train</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="../ParserModel.html" title="class in opennlp.tools.parser">ParserModel</a></span>&nbsp;<span class="element-name">train</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>&nbsp;languageCode,
  <a href="../../util/ObjectStream.html" title="interface in opennlp.tools.util">ObjectStream</a>&lt;<a href="../Parse.html" title="class in opennlp.tools.parser">Parse</a>&gt;&nbsp;parseSamples,
  <a href="../HeadRules.html" title="interface in opennlp.tools.parser">HeadRules</a>&nbsp;rules,
  int&nbsp;iterations,
  int&nbsp;cutoff)</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">Starts a training of a <a href="../ParserModel.html" title="class in opennlp.tools.parser"><code>ParserModel</code></a>.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>languageCode</code> - An ISO conform language code.</dd>
 <dd><code>parseSamples</code> - The <a href="../../util/ObjectStream.html" title="interface in opennlp.tools.util"><code>samples</code></a> as input.</dd>
 <dd><code>rules</code> - The <a href="../HeadRules.html" title="interface in opennlp.tools.parser"><code>HeadRules</code></a> to use.</dd>
 <dd><code>iterations</code> - The number of iterations to be conducted.</dd>
 <dd><code>cutoff</code> - The cut-off parameter to be used.</dd>
 <dt>Returns:</dt>
 <dd>A valid <a href="../ParserModel.html" title="class in opennlp.tools.parser"><code>ParserModel</code></a>.</dd>
 <dt>Throws:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - Thrown if IO errors occurred during training.</dd>
 </dl>
 </section>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </section>
 <!-- ========= END OF CLASS DATA ========= -->
 </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>