| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.2) on Thu Dec 31 14:31:42 PST 2020 --> |
| <title>NCToken (Apache NLPCraft 0.7.3)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2020-12-31"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="NCToken (Apache NLPCraft 0.7.3)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":18,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":18,"i7":6,"i8":18,"i9":6,"i10":6,"i11":6,"i12":6,"i13":18,"i14":6,"i15":18,"i16":18,"i17":18,"i18":18,"i19":18,"i20":18}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"><link href="https://stackpath.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet"> <script src="https://nlpcraft.apache.org/javadoc/resources/sh/scripts/XRegExp.js" type="text/javascript"></script> <script src="https://nlpcraft.apache.org/javadoc/resources/sh/scripts/shCore.js" type="text/javascript"></script> <script src="https://nlpcraft.apache.org/javadoc/resources/sh/scripts/shAutoloader.js" type="text/javascript"></script> <link href="https://nlpcraft.apache.org/javadoc/resources/sh/styles/shCoreNLPCraft.css" rel="stylesheet" type="text/css" title="Style"> <link href="https://nlpcraft.apache.org/javadoc/resources/sh/styles/shThemeNLPCraft.css" rel="stylesheet" type="text/css" title="Style"> <link href="https://fonts.googleapis.com/css?family=Roboto+Mono" rel="stylesheet"> <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet"> <script async defer src="https://buttons.github.io/buttons.js"></script> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/NCToken.html">Use</a></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">Help</a></li> |
| </ul> |
| <div class="aboutLanguage">Apache NLPCraft <span style="font-size: 80%">0.7.3</span></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.nlpcraft.model</a></div> |
| <h2 title="Interface NCToken" class="title">Interface NCToken</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="NCMetadata.html" title="interface in org.apache.nlpcraft.model">NCMetadata</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">NCToken</span> |
| extends <a href="NCMetadata.html" title="interface in org.apache.nlpcraft.model">NCMetadata</a></pre> |
| <div class="block">Detected model element. A token is a detected model element and is a part of the |
| parsed user input. Sequence of tokens represents a fully parsed (see <a href="NCContext.html#getVariants()"><code>NCContext.getVariants()</code></a> method) user input. A single |
| token corresponds to a one or more words, sequential or not, in the user sentence. |
| <p> |
| Note that tokens can be used to define other tokens (i.e. tokens are composable). Because of that tokens naturally |
| form a tree hierarchy - see methods <a href="#findPartTokens(java.lang.String...)"><code>findPartTokens(String...)</code></a>, <a href="#getAliases()"><code>getAliases()</code></a>, <a href="#isOfAlias(java.lang.String)"><code>isOfAlias(String)</code></a> |
| and <a href="#getPartTokens()"><code>getPartTokens()</code></a>. |
| Note also that detected model elements that tokens represent also form another hierarchy, namely a model element hierarchy that |
| user can also access via <a href="#getAncestors()"><code>getAncestors()</code></a>, <a href="#getParentId()"><code>getParentId()</code></a> methods. These two hierarchies should be not |
| be confused. |
| <p> |
| <b>Configuring Token Providers</b><br> |
| Token providers (built-in or 3rd party) have to be enabled in the REST server <a href="https://nlpcraft.apache.org/server-and-probe.html">configuration</a>. |
| Data models also have to specify tokens they are expecting the REST server and probe to detect. This is done to |
| limit the unnecessary processing since implicit enabling of all token providers and all tokens can lead to a |
| significant slow down of processing. REST server <a href="https://nlpcraft.apache.org/server-and-probe.html">configuration</a> |
| property <code>nlpcraft.server.tokenProvides</code> provides the list of enabled token providers. |
| Data models provide their required tokens in <a href="NCModelView.html#getEnabledBuiltInTokens()"><code>NCModelView.getEnabledBuiltInTokens()</code></a> method. |
| <p> |
| Read full documentation in <a target=_ href="https://nlpcraft.apache.org/data-model.html">Data Model</a> section and review |
| <a target=_ href="https://github.com/apache/incubator-nlpcraft/tree/master/nlpcraft/src/main/scala/org/apache/nlpcraft/examples/">examples</a>.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="NCElement.html" title="interface in org.apache.nlpcraft.model"><code>NCElement</code></a>, |
| <a href="NCContext.html#getVariants()"><code>NCContext.getVariants()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="NCToken.html" title="interface in org.apache.nlpcraft.model">NCToken</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#findPartTokens(java.lang.String...)">findPartTokens</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>... idOrAlias)</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the list of all part tokens with given IDs or aliases traversing entire part token graph.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAliases()">getAliases</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets optional list of aliases this token is known by.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAncestors()">getAncestors</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the list of all parent IDs from this token up to the root.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEndCharIndex()">getEndCharIndex</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets end character index of this token in the original text.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getGroups()">getGroups</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the list of groups this token belongs to.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getId()">getId</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">If this token represents user defined model element this method returns |
| the ID of that element.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>default int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIndex()">getIndex</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">A shortcut method that gets index of this token in the sentence.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="NCModelView.html" title="interface in org.apache.nlpcraft.model">NCModelView</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getModel()">getModel</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets reference to the model this token belongs to.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOriginalText()">getOriginalText</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">A shortcut method that gets original user input text for this token.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParentId()">getParentId</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the optional parent ID of the model element this token represents.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="NCToken.html" title="interface in org.apache.nlpcraft.model">NCToken</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPartTokens()">getPartTokens</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the list of tokens this tokens is composed of.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getServerRequestId()">getServerRequestId</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets ID of the server request this token is part of.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStartCharIndex()">getStartCharIndex</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets start character index of this token in the original text.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUnid()">getUnid</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">A shortcut method that gets internal globally unique system ID of the token.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getValue()">getValue</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the value if this token was detected via element's value (or its synonyms).</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>default boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isChildOf(java.lang.String)">isChildOf</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> tokId)</code></th> |
| <td class="colLast"> |
| <div class="block">Tests whether this token is a child of given token ID.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>default boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isFreeWord()">isFreeWord</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">A shortcut method checking whether or not this token represents a free word.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>default boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isMemberOf(java.lang.String)">isMemberOf</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> grp)</code></th> |
| <td class="colLast"> |
| <div class="block">Tests whether or not this token belongs to the given group.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>default boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isOfAlias(java.lang.String)">isOfAlias</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> alias)</code></th> |
| <td class="colLast"> |
| <div class="block">Tests whether or not this token has given alias.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>default boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isStopWord()">isStopWord</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">A shortcut method checking whether or not this token is a stopword.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>default boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isUserDefined()">isUserDefined</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Tests whether or not this token is a user-defined token.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.nlpcraft.model.NCMetadata"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.nlpcraft.model.<a href="NCMetadata.html" title="interface in org.apache.nlpcraft.model">NCMetadata</a></h3> |
| <code><a href="NCMetadata.html#getMetadata()">getMetadata</a>, <a href="NCMetadata.html#meta(java.lang.String)">meta</a>, <a href="NCMetadata.html#meta(java.lang.String,T)">meta</a>, <a href="NCMetadata.html#metaOpt(java.lang.String)">metaOpt</a>, <a href="NCMetadata.html#metax(java.lang.String)">metax</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getModel()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getModel</h4> |
| <pre class="methodSignature"><a href="NCModelView.html" title="interface in org.apache.nlpcraft.model">NCModelView</a> getModel()</pre> |
| <div class="block">Gets reference to the model this token belongs to.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Model reference.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getServerRequestId()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServerRequestId</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getServerRequestId()</pre> |
| <div class="block">Gets ID of the server request this token is part of.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>ID of the server request this token is part of.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getId()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getId</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getId()</pre> |
| <div class="block">If this token represents user defined model element this method returns |
| the ID of that element. Otherwise, it returns ID of the built-in system token. |
| Note that a sentence can have multiple tokens with the same element ID.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>ID of the element (system or user defined).</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="NCElement.html#getId()"><code>NCElement.getId()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getParentId()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParentId</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getParentId()</pre> |
| <div class="block">Gets the optional parent ID of the model element this token represents. This only available |
| for user-defined model elements (built-in tokens do not have parents).</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>ID of the token's element immediate parent or <code>null</code> if not available.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="NCElement.html#getParentId()"><code>NCElement.getParentId()</code></a>, |
| <a href="#getAncestors()"><code>getAncestors()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getAncestors()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAncestors</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> getAncestors()</pre> |
| <div class="block">Gets the list of all parent IDs from this token up to the root. This only available |
| for user-defined model elements (built-in tokens do not have parents).</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>List, potentially empty but never <code>null</code>, of all parent IDs from this token up to the root.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#getParentId()"><code>getParentId()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isChildOf(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isChildOf</h4> |
| <pre class="methodSignature">default boolean isChildOf​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> tokId)</pre> |
| <div class="block">Tests whether this token is a child of given token ID. It is equivalent to: |
| <pre class="brush: java"> |
| return getAncestors().contains(tokId); |
| </pre></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>tokId</code> - Ancestor token ID.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> this token is a child of given token ID, <code>false</code> otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getPartTokens()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPartTokens</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="NCToken.html" title="interface in org.apache.nlpcraft.model">NCToken</a>> getPartTokens()</pre> |
| <div class="block">Gets the list of tokens this tokens is composed of. This method returns only immediate part tokens.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>List of constituent tokens, potentially empty but never <code>null</code>, that this token is composed of.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#findPartTokens(java.lang.String...)"><code>findPartTokens(String...)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="findPartTokens(java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>findPartTokens</h4> |
| <pre class="methodSignature">default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="NCToken.html" title="interface in org.apache.nlpcraft.model">NCToken</a>> findPartTokens​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>... idOrAlias)</pre> |
| <div class="block">Gets the list of all part tokens with given IDs or aliases traversing entire part token graph.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>idOrAlias</code> - List of token IDs or aliases, potentially empty. If empty, the entire tree of part tokens |
| is return as a list.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>List of all part tokens with given IDs or aliases. Potentially empty but never <code>null</code>.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#getPartTokens()"><code>getPartTokens()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getAliases()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAliases</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> getAliases()</pre> |
| <div class="block">Gets optional list of aliases this token is known by. Token can get an alias if it is a part of |
| other composed token and token DSL expression that was used to match it specified an alias. Note |
| that token can have zero, one or more aliases.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>List of aliases this token is known by. Can be empty, but never <code>null</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isOfAlias(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isOfAlias</h4> |
| <pre class="methodSignature">default boolean isOfAlias​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> alias)</pre> |
| <div class="block">Tests whether or not this token has given alias. It is equivalent to: |
| <pre class="brush: java"> |
| return getAliases().contains(alias); |
| </pre></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>alias</code> - Alias to test.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>True</code> if this token has alias <code>alias</code>, <code>false</code> otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getValue()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValue</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getValue()</pre> |
| <div class="block">Gets the value if this token was detected via element's value (or its synonyms). Otherwise |
| returns <code>null</code>. Only applicable for user-defined model elements (built-in tokens |
| do not have values).</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Value for the user-defined model element or <code>null</code>, if not available.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="NCElement.html#getValues()"><code>NCElement.getValues()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getGroups()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getGroups</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> getGroups()</pre> |
| <div class="block">Gets the list of groups this token belongs to. By default, if not specified explicitly, the group |
| is token's ID.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Token groups list. Never <code>null</code> - but can be empty.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="NCElement.html#getGroups()"><code>NCElement.getGroups()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isMemberOf(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isMemberOf</h4> |
| <pre class="methodSignature">default boolean isMemberOf​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> grp)</pre> |
| <div class="block">Tests whether or not this token belongs to the given group. It is equivalent to: |
| <pre class="brush: java"> |
| return getGroups().contains(grp); |
| </pre></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>grp</code> - Group to test.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>True</code> if this token belongs to the group <code>grp</code>, <code>false</code> otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getStartCharIndex()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStartCharIndex</h4> |
| <pre class="methodSignature">int getStartCharIndex()</pre> |
| <div class="block">Gets start character index of this token in the original text.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Start character index of this token.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getEndCharIndex()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEndCharIndex</h4> |
| <pre class="methodSignature">int getEndCharIndex()</pre> |
| <div class="block">Gets end character index of this token in the original text.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>End character index of this token.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isStopWord()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isStopWord</h4> |
| <pre class="methodSignature">default boolean isStopWord()</pre> |
| <div class="block">A shortcut method checking whether or not this token is a stopword. Stopwords are some extremely common |
| words which add little value in helping understanding user input and are excluded from the |
| processing entirely. For example, words like a, the, can, of, about, over, etc. are |
| typical stopwords in English. NLPCraft has built-in set of stopwords. |
| <p> |
| This method is equivalent to: |
| <pre class="brush: java"> |
| return meta("nlpcraft:nlp:stopword"); |
| </pre></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Whether or not this token is a stopword.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isFreeWord()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isFreeWord</h4> |
| <pre class="methodSignature">default boolean isFreeWord()</pre> |
| <div class="block">A shortcut method checking whether or not this token represents a free word. A free word is a |
| token that was detected neither as a part of user defined or system tokens. |
| <p> |
| This method is equivalent to: |
| <pre class="brush: java"> |
| return meta("nlpcraft:nlp:freeword"); |
| </pre></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Whether or not this token is a freeword.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getOriginalText()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOriginalText</h4> |
| <pre class="methodSignature">default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getOriginalText()</pre> |
| <div class="block">A shortcut method that gets original user input text for this token. |
| <p> |
| This method is equivalent to: |
| <pre class="brush: java"> |
| return meta("nlpcraft:nlp:origtext"); |
| </pre></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Original user input text for this token.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getIndex()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIndex</h4> |
| <pre class="methodSignature">default int getIndex()</pre> |
| <div class="block">A shortcut method that gets index of this token in the sentence. |
| <p> |
| This method is equivalent to: |
| <pre class="brush: java"> |
| return meta("nlpcraft:nlp:index"); |
| </pre></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Index of this token in the sentence.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getUnid()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUnid</h4> |
| <pre class="methodSignature">default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getUnid()</pre> |
| <div class="block">A shortcut method that gets internal globally unique system ID of the token. |
| <p> |
| This method is equivalent to: |
| <pre class="brush: java"> |
| return meta("nlpcraft:nlp:unid"); |
| </pre></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Internal globally unique system ID of the token.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isUserDefined()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>isUserDefined</h4> |
| <pre class="methodSignature">default boolean isUserDefined()</pre> |
| <div class="block">Tests whether or not this token is a user-defined token.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>{code true} if this token is defined by the model element in the user model, <code>false</code> otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/NCToken.html">Use</a></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">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><span style="vertical-align: super">Apache NLPCraft <span style="font-size: 80%">0.7.3</span></span> <a style="vertical-align: super; margin-right: 10px" href="https://github.com/apache/incubator-nlpcraft" target="github"><i class="fa fa-github github-logo"></i></a> <a class="github-button" href="https://github.com/apache/incubator-nlpcraft/tree/master/nlpcraft/src/main/scala/org/apache/nlpcraft/examples" data-icon="octicon-eye" aria-label="NLPCraft Examples">Examples</a> <a class="github-button" href="https://github.com/apache/incubator-nlpcraft" data-icon="octicon-star" aria-label="Star on GitHub">Star</a> <a class="github-button" href="https://github.com/apache/incubator-nlpcraft/fork" data-icon="octicon-repo-forked" aria-label="Fork on GitHub">Fork</a> <script type="text/javascript"> SyntaxHighlighter.defaults["auto-links"] = false; SyntaxHighlighter.defaults["tab-size"] = 2; SyntaxHighlighter.autoloader( 'java https://nlpcraft.apache.org/javadoc/resources/sh/scripts/shBrushJava.js', 'js jscript javascript https://nlpcraft.apache.org/javadoc/resources/sh/scripts/shBrushJScript.js', 'text plain https://nlpcraft.apache.org/javadoc/resources/sh/scripts/shBrushPlain.js', 'py python https://nlpcraft.apache.org/javadoc/resources/sh/scripts/shBrushPython.js', 'ruby rails ror rb https://nlpcraft.apache.org/javadoc/resources/sh/scripts/shBrushRuby.js', 'scala https://nlpcraft.apache.org/javadoc/resources/sh/scripts/shBrushScala.js', 'sql https://nlpcraft.apache.org/javadoc/resources/sh/scripts/shBrushSql.js', 'xml xhtml xslt html https://nlpcraft.apache.org/javadoc/resources/sh/scripts/shBrushXml.js' ); SyntaxHighlighter.all(); </script></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small><center> <br/> <span style="font-size: larger">Copyright © 2020 Apache Software Foundation</span> <br/> <br/> <img src="https://www.apache.org/img/ASF20thAnniversary.jpg" height="64px" alt="ASF Logo"> </center></small></p> |
| </footer> |
| </body> |
| </html> |
