| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_161) on Thu Apr 30 21:50:54 PDT 2020 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>NCModelAdapter (Apache NLPCraft 0.5.0)</title> |
| <meta name="date" content="2020-04-30"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="NCModelAdapter (Apache NLPCraft 0.5.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <link href="https://stackpath.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet"> <script src="../../../../resources/sh/scripts/XRegExp.js" type="text/javascript"></script> <script src="../../../../resources/sh/scripts/shCore.js" type="text/javascript"></script> <script src="../../../../resources/sh/scripts/shAutoloader.js" type="text/javascript"></script> <link href="../../../../resources/sh/styles/shCoreNLPCraft.css" rel="stylesheet" type="text/css" title="Style"> <link href="../../../../resources/sh/styles/shThemeNLPCraft.css" rel="stylesheet" type="text/css" title="Style"> <link href="https://fonts.googleapis.com/css?family=Roboto+Mono" rel="stylesheet"> <script async defer src="https://buttons.github.io/buttons.js"></script> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/NCModelAdapter.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.5.0</span></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/nlpcraft/model/NCModel.html" title="interface in org.apache.nlpcraft.model"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/nlpcraft/model/NCModelFactory.html" title="interface in org.apache.nlpcraft.model"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/nlpcraft/model/NCModelAdapter.html" target="_top">Frames</a></li> |
| <li><a href="NCModelAdapter.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.nlpcraft.model</div> |
| <h2 title="Class NCModelAdapter" class="title">Class NCModelAdapter</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.nlpcraft.model.NCModelAdapter</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../org/apache/nlpcraft/model/NCLifecycle.html" title="interface in org.apache.nlpcraft.model">NCLifecycle</a>, <a href="../../../../org/apache/nlpcraft/model/NCMetadata.html" title="interface in org.apache.nlpcraft.model">NCMetadata</a>, <a href="../../../../org/apache/nlpcraft/model/NCModel.html" title="interface in org.apache.nlpcraft.model">NCModel</a>, <a href="../../../../org/apache/nlpcraft/model/NCModelView.html" title="interface in org.apache.nlpcraft.model">NCModelView</a></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../org/apache/nlpcraft/model/NCModelFileAdapter.html" title="class in org.apache.nlpcraft.model">NCModelFileAdapter</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">NCModelAdapter</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="../../../../org/apache/nlpcraft/model/NCModel.html" title="interface in org.apache.nlpcraft.model">NCModel</a></pre> |
| <div class="block">Adapter for data models. In most cases new data models should extend either this adapter or |
| <a href="../../../../org/apache/nlpcraft/model/NCModelFileAdapter.html" title="class in org.apache.nlpcraft.model"><code>NCModelFileAdapter</code></a>. |
| <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/src/main/scala/org/apache/nlpcraft/examples/">examples</a>.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/nlpcraft/model/NCModelFileAdapter.html" title="class in org.apache.nlpcraft.model"><code>NCModelFileAdapter</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.nlpcraft.model.NCModelView"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.nlpcraft.model.<a href="../../../../org/apache/nlpcraft/model/NCModelView.html" title="interface in org.apache.nlpcraft.model">NCModelView</a></h3> |
| <code><a href="../../../../org/apache/nlpcraft/model/NCModelView.html#DFLT_ENABLED_BUILTIN_TOKENS">DFLT_ENABLED_BUILTIN_TOKENS</a>, <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#DFLT_IS_DUP_SYNONYMS_ALLOWED">DFLT_IS_DUP_SYNONYMS_ALLOWED</a>, <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#DFLT_IS_NO_NOUNS_ALLOWED">DFLT_IS_NO_NOUNS_ALLOWED</a>, <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#DFLT_IS_NO_USER_TOKENS_ALLOWED">DFLT_IS_NO_USER_TOKENS_ALLOWED</a>, <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#DFLT_IS_NON_ENGLISH_ALLOWED">DFLT_IS_NON_ENGLISH_ALLOWED</a>, <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#DFLT_IS_NOT_LATIN_CHARSET_ALLOWED">DFLT_IS_NOT_LATIN_CHARSET_ALLOWED</a>, <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#DFLT_IS_PERMUTATE_SYNONYMS">DFLT_IS_PERMUTATE_SYNONYMS</a>, <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#DFLT_IS_SWEAR_WORDS_ALLOWED">DFLT_IS_SWEAR_WORDS_ALLOWED</a>, <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#DFLT_JIGGLE_FACTOR">DFLT_JIGGLE_FACTOR</a>, <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#DFLT_MAX_FREE_WORDS">DFLT_MAX_FREE_WORDS</a>, <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#DFLT_MAX_SUSPICIOUS_WORDS">DFLT_MAX_SUSPICIOUS_WORDS</a>, <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#DFLT_MAX_TOKENS">DFLT_MAX_TOKENS</a>, <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#DFLT_MAX_TOTAL_SYNONYMS">DFLT_MAX_TOTAL_SYNONYMS</a>, <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#DFLT_MAX_UNKNOWN_WORDS">DFLT_MAX_UNKNOWN_WORDS</a>, <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#DFLT_MAX_WORDS">DFLT_MAX_WORDS</a>, <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#DFLT_METADATA">DFLT_METADATA</a>, <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#DFLT_MIN_NON_STOPWORDS">DFLT_MIN_NON_STOPWORDS</a>, <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#DFLT_MIN_TOKENS">DFLT_MIN_TOKENS</a>, <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#DFLT_MIN_WORDS">DFLT_MIN_WORDS</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/nlpcraft/model/NCModelAdapter.html#NCModelAdapter-java.lang.String-java.lang.String-java.lang.String-">NCModelAdapter</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> id, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ver)</code> |
| <div class="block">Creates new model with the given mandatory parameters.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/nlpcraft/model/NCModelAdapter.html#getId--">getId</a></span>()</code> |
| <div class="block">Gets unique, <i>immutable</i> ID of this model.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/nlpcraft/model/NCModelAdapter.html#getName--">getName</a></span>()</code> |
| <div class="block">Gets descriptive name of this model.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/nlpcraft/model/NCModelAdapter.html#getVersion--">getVersion</a></span>()</code> |
| <div class="block">Gets the version of this model using semantic versioning.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.nlpcraft.model.NCModel"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.nlpcraft.model.<a href="../../../../org/apache/nlpcraft/model/NCModel.html" title="interface in org.apache.nlpcraft.model">NCModel</a></h3> |
| <code><a href="../../../../org/apache/nlpcraft/model/NCModel.html#onContext-org.apache.nlpcraft.model.NCContext-">onContext</a>, <a href="../../../../org/apache/nlpcraft/model/NCModel.html#onError-org.apache.nlpcraft.model.NCContext-java.lang.Throwable-">onError</a>, <a href="../../../../org/apache/nlpcraft/model/NCModel.html#onMatchedIntent-org.apache.nlpcraft.model.NCIntentMatch-">onMatchedIntent</a>, <a href="../../../../org/apache/nlpcraft/model/NCModel.html#onParsedVariant-org.apache.nlpcraft.model.NCVariant-">onParsedVariant</a>, <a href="../../../../org/apache/nlpcraft/model/NCModel.html#onRejection-org.apache.nlpcraft.model.NCIntentMatch-org.apache.nlpcraft.model.NCRejection-">onRejection</a>, <a href="../../../../org/apache/nlpcraft/model/NCModel.html#onResult-org.apache.nlpcraft.model.NCIntentMatch-org.apache.nlpcraft.model.NCResult-">onResult</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.nlpcraft.model.NCModelView"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.nlpcraft.model.<a href="../../../../org/apache/nlpcraft/model/NCModelView.html" title="interface in org.apache.nlpcraft.model">NCModelView</a></h3> |
| <code><a href="../../../../org/apache/nlpcraft/model/NCModelView.html#getAdditionalStopWords--">getAdditionalStopWords</a>, <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#getDescription--">getDescription</a>, <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#getElements--">getElements</a>, <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#getEnabledBuiltInTokens--">getEnabledBuiltInTokens</a>, <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#getExamples--">getExamples</a>, <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#getExcludedStopWords--">getExcludedStopWords</a>, <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#getJiggleFactor--">getJiggleFactor</a>, <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#getMacros--">getMacros</a>, <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#getMaxFreeWords--">getMaxFreeWords</a>, <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#getMaxSuspiciousWords--">getMaxSuspiciousWords</a>, <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#getMaxTokens--">getMaxTokens</a>, <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#getMaxTotalSynonyms--">getMaxTotalSynonyms</a>, <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#getMaxUnknownWords--">getMaxUnknownWords</a>, <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#getMaxWords--">getMaxWords</a>, <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#getMetadata--">getMetadata</a>, <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#getMinNonStopwords--">getMinNonStopwords</a>, <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#getMinTokens--">getMinTokens</a>, <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#getMinWords--">getMinWords</a>, <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#getParsers--">getParsers</a>, <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#getSuspiciousWords--">getSuspiciousWords</a>, <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#isDupSynonymsAllowed--">isDupSynonymsAllowed</a>, <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#isNonEnglishAllowed--">isNonEnglishAllowed</a>, <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#isNoNounsAllowed--">isNoNounsAllowed</a>, <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#isNotLatinCharsetAllowed--">isNotLatinCharsetAllowed</a>, <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#isNoUserTokensAllowed--">isNoUserTokensAllowed</a>, <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#isPermutateSynonyms--">isPermutateSynonyms</a>, <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#isSwearWordsAllowed--">isSwearWordsAllowed</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.nlpcraft.model.NCMetadata"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.nlpcraft.model.<a href="../../../../org/apache/nlpcraft/model/NCMetadata.html" title="interface in org.apache.nlpcraft.model">NCMetadata</a></h3> |
| <code><a href="../../../../org/apache/nlpcraft/model/NCMetadata.html#meta-java.lang.String-">meta</a>, <a href="../../../../org/apache/nlpcraft/model/NCMetadata.html#meta-java.lang.String-T-">meta</a>, <a href="../../../../org/apache/nlpcraft/model/NCMetadata.html#metaOpt-java.lang.String-">metaOpt</a>, <a href="../../../../org/apache/nlpcraft/model/NCMetadata.html#metax-java.lang.String-">metax</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.nlpcraft.model.NCLifecycle"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.nlpcraft.model.<a href="../../../../org/apache/nlpcraft/model/NCLifecycle.html" title="interface in org.apache.nlpcraft.model">NCLifecycle</a></h3> |
| <code><a href="../../../../org/apache/nlpcraft/model/NCLifecycle.html#onDiscard--">onDiscard</a>, <a href="../../../../org/apache/nlpcraft/model/NCLifecycle.html#onInit--">onInit</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="NCModelAdapter-java.lang.String-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>NCModelAdapter</h4> |
| <pre>public NCModelAdapter(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> id, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ver)</pre> |
| <div class="block">Creates new model with the given mandatory parameters.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>id</code> - Model <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#getId--"><code>ID</code></a>.</dd> |
| <dd><code>name</code> - Model <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#getName--"><code>name</code></a>.</dd> |
| <dd><code>ver</code> - Model <a href="../../../../org/apache/nlpcraft/model/NCModelView.html#getVersion--"><code>version</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getId</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getId()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/nlpcraft/model/NCModelView.html#getId--">NCModelView</a></code></span></div> |
| <div class="block">Gets unique, <i>immutable</i> ID of this model. |
| <p> |
| Note that <b>model IDs are immutable</b> while name and version |
| can be changed freely. Changing model ID is equal to creating a completely new model. |
| Model IDs (unlike name and version) are not exposed to the end user and only serve a |
| technical purpose. ID's max length is 32 characters. |
| <p> |
| <b>JSON</b> |
| <br> |
| If using JSON/YAML model presentation this is set by <code>id</code> property: |
| <pre class="brush: js"> |
| { |
| "id": "my.model.id" |
| } |
| </pre></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/nlpcraft/model/NCModelView.html#getId--">getId</a></code> in interface <code><a href="../../../../org/apache/nlpcraft/model/NCModelView.html" title="interface in org.apache.nlpcraft.model">NCModelView</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Unique, <i>immutable</i> ID of this model.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getName</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getName()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/nlpcraft/model/NCModelView.html#getName--">NCModelView</a></code></span></div> |
| <div class="block">Gets descriptive name of this model. Name's max length is 64 characters. |
| <p> |
| <b>JSON</b> |
| <br> |
| If using JSON/YAML model presentation this is set by <code>name</code> property: |
| <pre class="brush: js"> |
| { |
| "name": "My Model" |
| } |
| </pre></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/nlpcraft/model/NCModelView.html#getName--">getName</a></code> in interface <code><a href="../../../../org/apache/nlpcraft/model/NCModelView.html" title="interface in org.apache.nlpcraft.model">NCModelView</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Descriptive name for this model.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getVersion--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getVersion</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getVersion()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/nlpcraft/model/NCModelView.html#getVersion--">NCModelView</a></code></span></div> |
| <div class="block">Gets the version of this model using semantic versioning. Version's max length is 16 characters. |
| <p> |
| <b>JSON</b> |
| <br> |
| If using JSON/YAML model presentation this is set by <code>version</code> property: |
| <pre class="brush: js"> |
| { |
| "version": "1.0.0" |
| } |
| </pre></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/nlpcraft/model/NCModelView.html#getVersion--">getVersion</a></code> in interface <code><a href="../../../../org/apache/nlpcraft/model/NCModelView.html" title="interface in org.apache.nlpcraft.model">NCModelView</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A version compatible with (<a href="http://www.semver.org">www.semver.org</a>) specification.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/NCModelAdapter.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.5.0</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/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 ../../../../resources/sh/scripts/shBrushJava.js', 'js jscript javascript ../../../../resources/sh/scripts/shBrushJScript.js', 'text plain ../../../../resources/sh/scripts/shBrushPlain.js', 'py python ../../../../resources/sh/scripts/shBrushPython.js', 'ruby rails ror rb ../../../../resources/sh/scripts/shBrushRuby.js', 'scala ../../../../resources/sh/scripts/shBrushScala.js', 'sql ../../../../resources/sh/scripts/shBrushSql.js', 'xml xhtml xslt html ../../../../resources/sh/scripts/shBrushXml.js' ); SyntaxHighlighter.all(); </script></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/nlpcraft/model/NCModel.html" title="interface in org.apache.nlpcraft.model"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/nlpcraft/model/NCModelFactory.html" title="interface in org.apache.nlpcraft.model"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/nlpcraft/model/NCModelAdapter.html" target="_top">Frames</a></li> |
| <li><a href="NCModelAdapter.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <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"> </center></small></p> |
| </body> |
| </html> |
