| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>AbstractBottomUpParser (Apache OpenNLP Tools 2.3.3 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: opennlp.tools.parser, class: AbstractBottomUpParser"> |
| <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: </li> |
| <li>Nested | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">opennlp.tools.parser</a></div> |
| <h1 title="Class AbstractBottomUpParser" class="title">Class AbstractBottomUpParser</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.tools.parser.AbstractBottomUpParser</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> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="chunking/Parser.html" title="class in opennlp.tools.parser.chunking">Parser</a></code>, <code><a href="treeinsert/Parser.html" title="class in opennlp.tools.parser.treeinsert">Parser</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">AbstractBottomUpParser</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> |
| implements <a href="Parser.html" title="interface in opennlp.tools.parser">Parser</a></span></div> |
| <div class="block">Abstract class which contains code to tag and chunk parses for bottom up parsing and |
| leaves implementation of advancing parses and completing parses to extend class. |
| <p> |
| <b>Note:</b> <br> The nodes within the returned parses are shared with other parses |
| and therefore their parent node references will not be consistent with their child |
| node reference. <a href="#setParents(opennlp.tools.parser.Parse)"><code>setParents</code></a> can be used to make the parents consistent |
| with a particular parse, but subsequent calls to <code>setParents</code> can invalidate |
| the results of earlier calls.<br></div> |
| </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="#COMPLETE" class="member-name-link">COMPLETE</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Outcome used when a constituent is complete.</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="#CONT" class="member-name-link">CONT</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Prefix for outcomes continuing a constituent.</div> |
| </div> |
| <div class="col-first even-row-color"><code>static final double</code></div> |
| <div class="col-second even-row-color"><code><a href="#defaultAdvancePercentage" class="member-name-link">defaultAdvancePercentage</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The default amount of probability mass required of advanced outcomes.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static final int</code></div> |
| <div class="col-second odd-row-color"><code><a href="#defaultBeamSize" class="member-name-link">defaultBeamSize</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">The default beam size used if no beam size is given.</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="#INC_NODE" class="member-name-link">INC_NODE</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The label for the top if an incomplete 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="#INCOMPLETE" class="member-name-link">INCOMPLETE</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Outcome used when a constituent is incomplete.</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="#OTHER" class="member-name-link">OTHER</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Outcome for token which is not contained in a basal constituent.</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="#START" class="member-name-link">START</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Prefix for outcomes starting a constituent.</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="#TOK_NODE" class="member-name-link">TOK_NODE</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The label for a token 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="#TOP_NODE" class="member-name-link">TOP_NODE</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">The label for the top node.</div> |
| </div> |
| </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.postag.POSTagger,opennlp.tools.chunker.Chunker,opennlp.tools.parser.HeadRules,int,double)" class="member-name-link">AbstractBottomUpParser</a><wbr>(<a href="../postag/POSTagger.html" title="interface in opennlp.tools.postag">POSTagger</a> tagger, |
| <a href="../chunker/Chunker.html" title="interface in opennlp.tools.chunker">Chunker</a> chunker, |
| <a href="HeadRules.html" title="interface in opennlp.tools.parser">HeadRules</a> headRules, |
| int beamSize, |
| double advancePercentage)</code></div> |
| <div class="col-last even-row-color"> </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-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-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="../dictionary/Dictionary.html" title="class in opennlp.tools.dictionary">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="#buildDictionary(opennlp.tools.util.ObjectStream,opennlp.tools.parser.HeadRules,int)" class="member-name-link">buildDictionary</a><wbr>(<a href="../util/ObjectStream.html" title="interface in opennlp.tools.util">ObjectStream</a><<a href="Parse.html" title="class in opennlp.tools.parser">Parse</a>> data, |
| <a href="HeadRules.html" title="interface in opennlp.tools.parser">HeadRules</a> rules, |
| int cutoff)</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 n-gram <a href="../dictionary/Dictionary.html" title="class in opennlp.tools.dictionary"><code>Dictionary</code></a> from the specified data stream using <a href="HeadRules.html" title="interface in opennlp.tools.parser"><code>HeadRules</code></a> |
| and specified cut-off.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../dictionary/Dictionary.html" title="class in opennlp.tools.dictionary">Dictionary</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#buildDictionary(opennlp.tools.util.ObjectStream,opennlp.tools.parser.HeadRules,opennlp.tools.util.TrainingParameters)" class="member-name-link">buildDictionary</a><wbr>(<a href="../util/ObjectStream.html" title="interface in opennlp.tools.util">ObjectStream</a><<a href="Parse.html" title="class in opennlp.tools.parser">Parse</a>> data, |
| <a href="HeadRules.html" title="interface in opennlp.tools.parser">HeadRules</a> rules, |
| <a href="../util/TrainingParameters.html" title="class in opennlp.tools.util">TrainingParameters</a> params)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a n-gram <a href="../dictionary/Dictionary.html" title="class in opennlp.tools.dictionary"><code>Dictionary</code></a> from the specified data stream using the specified |
| head rule and specified cut-off.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Parse.html" title="class in opennlp.tools.parser">Parse</a>[]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#collapsePunctuation(opennlp.tools.parser.Parse%5B%5D,java.util.Set)" class="member-name-link">collapsePunctuation</a><wbr>(<a href="Parse.html" title="class in opennlp.tools.parser">Parse</a>[] chunks, |
| <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><<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>> punctSet)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Removes the punctuation from the specified set of <code>chunks</code>, adds it to the |
| parses adjacent to the punctuation is specified, and returns a new array of parses |
| with the punctuation removed.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Parse.html" title="class in opennlp.tools.parser">Parse</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#parse(opennlp.tools.parser.Parse)" class="member-name-link">parse</a><wbr>(<a href="Parse.html" title="class in opennlp.tools.parser">Parse</a> tokens)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a <a href="Parse.html" title="class in opennlp.tools.parser"><code>Parse</code></a> for the specified <a href="Parse.html" title="class in opennlp.tools.parser"><code>Parse</code></a> of <code>tokens</code>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Parse.html" title="class in opennlp.tools.parser">Parse</a>[]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#parse(opennlp.tools.parser.Parse,int)" class="member-name-link">parse</a><wbr>(<a href="Parse.html" title="class in opennlp.tools.parser">Parse</a> tokens, |
| int numParses)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the specified number of parses or fewer for the specified tokens.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setErrorReporting(boolean)" class="member-name-link">setErrorReporting</a><wbr>(boolean errorReporting)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Specifies whether the parser should report when it was unable to find a parse for |
| a particular sentence.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#setParents(opennlp.tools.parser.Parse)" class="member-name-link">setParents</a><wbr>(<a href="Parse.html" title="class in opennlp.tools.parser">Parse</a> p)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Assigns parent references for the specified parse so that they |
| are consistent with the children references.</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"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="defaultBeamSize"> |
| <h3>defaultBeamSize</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">defaultBeamSize</span></div> |
| <div class="block">The default beam size used if no beam size is given.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../constant-values.html#opennlp.tools.parser.AbstractBottomUpParser.defaultBeamSize">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="defaultAdvancePercentage"> |
| <h3>defaultAdvancePercentage</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">double</span> <span class="element-name">defaultAdvancePercentage</span></div> |
| <div class="block">The default amount of probability mass required of advanced outcomes.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../constant-values.html#opennlp.tools.parser.AbstractBottomUpParser.defaultAdvancePercentage">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="TOP_NODE"> |
| <h3>TOP_NODE</h3> |
| <div class="member-signature"><span class="modifiers">public static final</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">TOP_NODE</span></div> |
| <div class="block">The label for the top node.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../constant-values.html#opennlp.tools.parser.AbstractBottomUpParser.TOP_NODE">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="INC_NODE"> |
| <h3>INC_NODE</h3> |
| <div class="member-signature"><span class="modifiers">public static final</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">INC_NODE</span></div> |
| <div class="block">The label for the top if an incomplete node.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../constant-values.html#opennlp.tools.parser.AbstractBottomUpParser.INC_NODE">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="TOK_NODE"> |
| <h3>TOK_NODE</h3> |
| <div class="member-signature"><span class="modifiers">public static final</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">TOK_NODE</span></div> |
| <div class="block">The label for a token node.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../constant-values.html#opennlp.tools.parser.AbstractBottomUpParser.TOK_NODE">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="START"> |
| <h3>START</h3> |
| <div class="member-signature"><span class="modifiers">public static final</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">START</span></div> |
| <div class="block">Prefix for outcomes starting a constituent.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../constant-values.html#opennlp.tools.parser.AbstractBottomUpParser.START">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="CONT"> |
| <h3>CONT</h3> |
| <div class="member-signature"><span class="modifiers">public static final</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">CONT</span></div> |
| <div class="block">Prefix for outcomes continuing a constituent.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../constant-values.html#opennlp.tools.parser.AbstractBottomUpParser.CONT">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="OTHER"> |
| <h3>OTHER</h3> |
| <div class="member-signature"><span class="modifiers">public static final</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">OTHER</span></div> |
| <div class="block">Outcome for token which is not contained in a basal constituent.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../constant-values.html#opennlp.tools.parser.AbstractBottomUpParser.OTHER">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="COMPLETE"> |
| <h3>COMPLETE</h3> |
| <div class="member-signature"><span class="modifiers">public static final</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">COMPLETE</span></div> |
| <div class="block">Outcome used when a constituent is complete.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../constant-values.html#opennlp.tools.parser.AbstractBottomUpParser.COMPLETE">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="INCOMPLETE"> |
| <h3>INCOMPLETE</h3> |
| <div class="member-signature"><span class="modifiers">public static final</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">INCOMPLETE</span></div> |
| <div class="block">Outcome used when a constituent is incomplete.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../constant-values.html#opennlp.tools.parser.AbstractBottomUpParser.INCOMPLETE">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="<init>(opennlp.tools.postag.POSTagger,opennlp.tools.chunker.Chunker,opennlp.tools.parser.HeadRules,int,double)"> |
| <h3>AbstractBottomUpParser</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">AbstractBottomUpParser</span><wbr><span class="parameters">(<a href="../postag/POSTagger.html" title="interface in opennlp.tools.postag">POSTagger</a> tagger, |
| <a href="../chunker/Chunker.html" title="interface in opennlp.tools.chunker">Chunker</a> chunker, |
| <a href="HeadRules.html" title="interface in opennlp.tools.parser">HeadRules</a> headRules, |
| int beamSize, |
| double advancePercentage)</span></div> |
| </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="setErrorReporting(boolean)"> |
| <h3>setErrorReporting</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setErrorReporting</span><wbr><span class="parameters">(boolean errorReporting)</span></div> |
| <div class="block">Specifies whether the parser should report when it was unable to find a parse for |
| a particular sentence.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>errorReporting</code> - <code>true</code> if un-parsed sentences should be reported, |
| <code>false</code> otherwise.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setParents(opennlp.tools.parser.Parse)"> |
| <h3>setParents</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">setParents</span><wbr><span class="parameters">(<a href="Parse.html" title="class in opennlp.tools.parser">Parse</a> p)</span></div> |
| <div class="block">Assigns parent references for the specified parse so that they |
| are consistent with the children references.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>p</code> - The <a href="Parse.html" title="class in opennlp.tools.parser"><code>Parse</code></a> whose parent references need to be assigned.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="collapsePunctuation(opennlp.tools.parser.Parse[],java.util.Set)"> |
| <h3>collapsePunctuation</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="Parse.html" title="class in opennlp.tools.parser">Parse</a>[]</span> <span class="element-name">collapsePunctuation</span><wbr><span class="parameters">(<a href="Parse.html" title="class in opennlp.tools.parser">Parse</a>[] chunks, |
| <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><<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>> punctSet)</span></div> |
| <div class="block">Removes the punctuation from the specified set of <code>chunks</code>, adds it to the |
| parses adjacent to the punctuation is specified, and returns a new array of parses |
| with the punctuation removed.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>chunks</code> - A set of <a href="Parse.html" title="class in opennlp.tools.parser"><code>parses</code></a>.</dd> |
| <dd><code>punctSet</code> - The set of punctuation to be removed.</dd> |
| <dt>Returns:</dt> |
| <dd>Array of <a href="Parse.html" title="class in opennlp.tools.parser"><code>parses</code></a> which is a subset of chunks with punctuation removed.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="parse(opennlp.tools.parser.Parse,int)"> |
| <h3>parse</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Parse.html" title="class in opennlp.tools.parser">Parse</a>[]</span> <span class="element-name">parse</span><wbr><span class="parameters">(<a href="Parse.html" title="class in opennlp.tools.parser">Parse</a> tokens, |
| int numParses)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Parser.html#parse(opennlp.tools.parser.Parse,int)">Parser</a></code></span></div> |
| <div class="block">Returns the specified number of parses or fewer for the specified tokens. |
| <p> |
| |
| <b>Note:</b> The nodes within |
| the returned parses are shared with other parses and therefore their parent node references |
| will not be consistent with their child node reference. |
| <p> |
| |
| <a href="Parse.html#setParent(opennlp.tools.parser.Parse)"><code>Parse.setParent(Parse)</code></a> can be used to make the parents consistent with a |
| particular parse, but subsequent calls to <code>setParents</code> can invalidate the |
| results of earlier calls.<br></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Parser.html#parse(opennlp.tools.parser.Parse,int)">parse</a></code> in interface <code><a href="Parser.html" title="interface in opennlp.tools.parser">Parser</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>tokens</code> - A <a href="Parse.html" title="class in opennlp.tools.parser"><code>Parse</code></a> containing the tokens with a single parent node.</dd> |
| <dd><code>numParses</code> - The number of parses desired.</dd> |
| <dt>Returns:</dt> |
| <dd>the specified number of <a href="Parse.html" title="class in opennlp.tools.parser"><code>parses</code></a> for the specified <code>tokens</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="parse(opennlp.tools.parser.Parse)"> |
| <h3>parse</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Parse.html" title="class in opennlp.tools.parser">Parse</a></span> <span class="element-name">parse</span><wbr><span class="parameters">(<a href="Parse.html" title="class in opennlp.tools.parser">Parse</a> tokens)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Parser.html#parse(opennlp.tools.parser.Parse)">Parser</a></code></span></div> |
| <div class="block">Returns a <a href="Parse.html" title="class in opennlp.tools.parser"><code>Parse</code></a> for the specified <a href="Parse.html" title="class in opennlp.tools.parser"><code>Parse</code></a> of <code>tokens</code>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Parser.html#parse(opennlp.tools.parser.Parse)">parse</a></code> in interface <code><a href="Parser.html" title="interface in opennlp.tools.parser">Parser</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>tokens</code> - The root node of a flat parse containing only tokens.</dd> |
| <dt>Returns:</dt> |
| <dd>A full parse of the specified tokens or the flat chunks of the tokens if a |
| full parse could not be found.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="buildDictionary(opennlp.tools.util.ObjectStream,opennlp.tools.parser.HeadRules,opennlp.tools.util.TrainingParameters)"> |
| <h3>buildDictionary</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="../dictionary/Dictionary.html" title="class in opennlp.tools.dictionary">Dictionary</a></span> <span class="element-name">buildDictionary</span><wbr><span class="parameters">(<a href="../util/ObjectStream.html" title="interface in opennlp.tools.util">ObjectStream</a><<a href="Parse.html" title="class in opennlp.tools.parser">Parse</a>> data, |
| <a href="HeadRules.html" title="interface in opennlp.tools.parser">HeadRules</a> rules, |
| <a href="../util/TrainingParameters.html" title="class in opennlp.tools.util">TrainingParameters</a> params)</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">Creates a n-gram <a href="../dictionary/Dictionary.html" title="class in opennlp.tools.dictionary"><code>Dictionary</code></a> from the specified data stream using the specified |
| head rule and specified cut-off.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>data</code> - The data stream of <a href="Parse.html" title="class in opennlp.tools.parser"><code>parses</code></a>.</dd> |
| <dd><code>rules</code> - The <a href="HeadRules.html" title="interface in opennlp.tools.parser"><code>HeadRules</code></a> for the parses.</dd> |
| <dd><code>params</code> - The <a href="../util/TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> which can contain a <code>cutoff</code>, |
| the minimum number of entries required for the n-gram to be saved as |
| part of the <a href="../dictionary/Dictionary.html" title="class in opennlp.tools.dictionary"><code>Dictionary</code></a>.</dd> |
| <dt>Returns:</dt> |
| <dd>A <a href="../dictionary/Dictionary.html" title="class in opennlp.tools.dictionary"><code>Dictionary</code></a> instance.</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></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="buildDictionary(opennlp.tools.util.ObjectStream,opennlp.tools.parser.HeadRules,int)"> |
| <h3>buildDictionary</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="../dictionary/Dictionary.html" title="class in opennlp.tools.dictionary">Dictionary</a></span> <span class="element-name">buildDictionary</span><wbr><span class="parameters">(<a href="../util/ObjectStream.html" title="interface in opennlp.tools.util">ObjectStream</a><<a href="Parse.html" title="class in opennlp.tools.parser">Parse</a>> data, |
| <a href="HeadRules.html" title="interface in opennlp.tools.parser">HeadRules</a> rules, |
| int 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">Creates a n-gram <a href="../dictionary/Dictionary.html" title="class in opennlp.tools.dictionary"><code>Dictionary</code></a> from the specified data stream using <a href="HeadRules.html" title="interface in opennlp.tools.parser"><code>HeadRules</code></a> |
| and specified cut-off.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>data</code> - The data stream of <a href="Parse.html" title="class in opennlp.tools.parser"><code>parses</code></a>.</dd> |
| <dd><code>rules</code> - The <a href="HeadRules.html" title="interface in opennlp.tools.parser"><code>HeadRules</code></a> for the <a href="Parse.html" title="class in opennlp.tools.parser"><code>parses</code></a>.</dd> |
| <dd><code>cutoff</code> - The minimum number of entries required for the n-gram to be |
| saved as part of the dictionary.</dd> |
| <dt>Returns:</dt> |
| <dd>A <a href="../dictionary/Dictionary.html" title="class in opennlp.tools.dictionary"><code>Dictionary</code></a> instance.</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></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> |
