You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nlpcraft.apache.org by ar...@apache.org on 2020/12/04 02:37:58 UTC
[incubator-nlpcraft-java-client] branch master-0.7.2-update
updated: Review.
This is an automated email from the ASF dual-hosted git repository.
aradzinski pushed a commit to branch master-0.7.2-update
in repository https://gitbox.apache.org/repos/asf/incubator-nlpcraft-java-client.git
The following commit(s) were added to refs/heads/master-0.7.2-update by this push:
new 082d32d Review.
082d32d is described below
commit 082d32d518788bdbb027777114fc26e111a1d6fb
Author: Aaron Radzinski <ar...@datalingvo.com>
AuthorDate: Thu Dec 3 18:37:47 2020 -0800
Review.
---
javadoc/stylesheet.css | 554 ++++++++++++++++-----
pom.xml | 5 +-
.../java/org/apache/nlpcraft/client/NCClient.java | 22 +-
.../apache/nlpcraft/client/NCClientBuilder.java | 2 +-
.../org/apache/nlpcraft/client/NCSuggestion.java | 17 +-
.../apache/nlpcraft/client/NCSuggestionData.java | 47 +-
.../apache/nlpcraft/client/impl/NCClientImpl.java | 10 -
.../nlpcraft/client/impl/beans/NCAskBean.java | 3 -
.../nlpcraft/client/impl/beans/NCAskSyncBean.java | 3 -
.../nlpcraft/client/impl/beans/NCCheckBean.java | 3 -
.../nlpcraft/client/impl/beans/NCCompanyBean.java | 31 +-
.../client/impl/beans/NCCompanyTokenResetBean.java | 3 -
.../client/impl/beans/NCErrorMessageBean.java | 7 -
.../client/impl/beans/NCFeedbackAddBean.java | 3 -
.../client/impl/beans/NCFeedbackAllBean.java | 3 -
.../nlpcraft/client/impl/beans/NCFeedbackBean.java | 68 +--
.../nlpcraft/client/impl/beans/NCModelBean.java | 11 +-
.../nlpcraft/client/impl/beans/NCProbeBean.java | 113 +----
.../client/impl/beans/NCProbesAllBean.java | 3 -
.../client/impl/beans/NCRequestStateBean.java | 90 ++--
.../nlpcraft/client/impl/beans/NCSigninBean.java | 3 -
.../client/impl/beans/NCStatusResponseBean.java | 3 -
.../client/impl/beans/NCSuggestionBean.java | 15 +-
.../client/impl/beans/NCSuggestionDataBean.java | 42 +-
.../client/impl/beans/NCSuggestionResultBean.java | 1 -
.../client/impl/beans/NCTokenCreationBean.java | 7 +-
.../nlpcraft/client/impl/beans/NCUserAddBean.java | 3 -
.../nlpcraft/client/impl/beans/NCUserBean.java | 51 +-
.../nlpcraft/client/impl/beans/NCUsersAllBean.java | 3 -
.../org/apache/nlpcraft/client/package-info.java | 14 +
30 files changed, 640 insertions(+), 500 deletions(-)
diff --git a/javadoc/stylesheet.css b/javadoc/stylesheet.css
index 30779e5..5d48c84 100644
--- a/javadoc/stylesheet.css
+++ b/javadoc/stylesheet.css
@@ -15,36 +15,52 @@
* limitations under the License.
*/
+/*
+ * Styles for individual HTML elements.
+ *
+ * These are styles that are specific to individual HTML elements. Changing them affects the style of a particular
+ * HTML element throughout the page.
+ */
+
body {
background-color:#ffffff;
color:#353833;
- font-family:Helvetica, sans-serif;
- font-size:15px;
+ font-family: Verdana, Helvetica, Arial, sans-serif;
+ font-size:14px;
margin:0;
+ padding:0;
+ height:100%;
+ width:100%;
+}
+iframe {
+ margin:0;
+ padding:0;
+ height:100%;
+ width:100%;
+ overflow-y:scroll;
+ border:none;
}
a:link, a:visited {
+ text-decoration: none;
color:#4A6782;
- text-decoration:none;
-}
-a:hover, a:focus {
- color:#bb7a2a;
- text-decoration:none;
}
-a:active {
- color:#4A6782;
+a[href]:hover, a[href]:focus {
text-decoration:none;
+ color:#bb7a2a;
}
a[name] {
color:#353833;
- text-decoration:none;
}
-a[name]:hover {
- color:#353833;
- text-decoration:none;
+a[name]:before, a[name]:target, a[id]:before, a[id]:target {
+ content:"";
+ display:inline-block;
+ position:relative;
+ padding-top:129px;
+ margin-top:-129px;
}
pre {
- font-family: monospace;
- font-size: 90%;
+ font-family:"Roboto Mono", monospace;
+ font-size:14px;
}
h1 {
font-size:20px;
@@ -57,7 +73,7 @@ h3 {
font-style:italic;
}
h4 {
- font-size:14px;
+ font-size:13px;
}
h5 {
font-size:12px;
@@ -69,33 +85,36 @@ ul {
list-style-type:disc;
}
code, tt {
- font-family: monospace;
+ font-family:"Roboto Mono", monospace;
+ font-size:14px;
padding-top:4px;
margin-top:8px;
line-height:1.4em;
- color: #4A6782;
}
dt code {
- font-family: monospace;
+ font-family:"Roboto Mono", monospace;
+ font-size:14px;
padding-top:4px;
- color: #4A6782;
}
table tr td dt code {
- font-family: monospace;
+ font-family:"Roboto Mono", monospace;
+ font-size:14px;
vertical-align:top;
padding-top:4px;
- color: #4A6782;
-}
-a code {
- color: inherit !important;
- text-decoration: underline;
}
sup {
font-size:8px;
}
+
+/*
+ * Styles for HTML generated by javadoc.
+ *
+ * These are style classes that are used by the standard doclet to generate HTML documentation.
+ */
+
/*
-Document title and Copyright styles
-*/
+ * Styles for document title and copyright.
+ */
.clear {
clear:both;
height:0;
@@ -126,25 +145,33 @@ Document title and Copyright styles
font-weight:bold;
}
/*
-Navigation bar styles
-*/
+ * Styles for navigation bar.
+ */
.bar {
background-color:#4D7A97;
color:#FFFFFF;
- padding: .6em .5em .6em .8em;
+ padding:.8em .5em .4em .8em;
height:auto;/*height:1.8em;*/
font-size:11px;
margin:0;
}
+.navPadding {
+ padding-top: 107px;
+}
+.fixedNav {
+ position:fixed;
+ width:100%;
+ z-index:999;
+ background-color:#ffffff;
+}
.topNav {
background-color:#4D7A97;
color:#FFFFFF;
float:left;
- padding:0;
width:100%;
clear:right;
height:2.8em;
- padding-top:10px;
+ padding: 10px 0 0;
overflow:hidden;
font-size:12px;
}
@@ -153,11 +180,10 @@ Navigation bar styles
background-color:#4D7A97;
color:#FFFFFF;
float:left;
- padding:0;
width:100%;
clear:right;
height:2.8em;
- padding-top:10px;
+ padding: 10px 0 0;
overflow:hidden;
font-size:12px;
}
@@ -185,7 +211,22 @@ ul.navList li{
padding: 5px 6px;
text-transform:uppercase;
}
-ul.subNavList li{
+ul.navListSearch {
+ float:right;
+ margin:0 0 0 0;
+ padding:0;
+}
+ul.navListSearch li {
+ list-style:none;
+ float:right;
+ padding: 5px 6px;
+ text-transform:uppercase;
+}
+ul.navListSearch li label {
+ position:relative;
+ right:-16px;
+}
+ul.subNavList li {
list-style:none;
float:left;
}
@@ -211,22 +252,30 @@ ul.subNavList li{
overflow:hidden;
}
/*
-Page header and footer styles
-*/
+ * Styles for page header and footer.
+ */
.header, .footer {
clear:both;
margin:0 20px;
padding:5px 0 0 0;
}
-.indexHeader {
- margin:10px;
+.indexNav {
position:relative;
+ font-size:12px;
+ background-color:#dee3e9;
}
-.indexHeader span{
- margin-right:15px;
+.indexNav ul {
+ margin-top:0;
+ padding:5px;
}
-.indexHeader h1 {
- font-size:14px;
+.indexNav ul li {
+ display:inline;
+ list-style-type:none;
+ padding-right:10px;
+ text-transform:uppercase;
+}
+.indexNav h1 {
+ font-size:13px;
}
.title {
color:#2c4557;
@@ -244,11 +293,11 @@ Page header and footer styles
}
.header ul li, .footer ul li {
list-style:none;
- font-size:14px;
+ font-size:13px;
}
/*
-Heading styles
-*/
+ * Styles for headings.
+ */
div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 {
background-color:#dee3e9;
border:1px solid #d0d9e0;
@@ -269,9 +318,10 @@ ul.blockList li.blockList h2 {
padding:0 0 20px 0;
}
/*
-Page layout container styles
-*/
-.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer {
+ * Styles for page layout containers.
+ */
+.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer,
+.allClassesContainer, .allPackagesContainer {
clear:both;
padding:10px 20px;
position:relative;
@@ -279,10 +329,10 @@ Page layout container styles
.indexContainer {
margin:10px;
position:relative;
- font-size:14px;
+ font-size:12px;
}
.indexContainer h2 {
- font-size:14px;
+ font-size:13px;
padding:0 0 3px 0;
}
.indexContainer ul {
@@ -301,7 +351,8 @@ Page layout container styles
}
.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd {
margin:5px 0 10px 0;
- font-size:15px;
+ font-size:14px;
+ font-family: Verdana, Georgia, "Times New Roman", Times, serif;
}
.serializedFormContainer dl.nameValue dt {
margin-left:1px;
@@ -315,8 +366,11 @@ Page layout container styles
display:inline;
}
/*
-List styles
-*/
+ * Styles for lists.
+ */
+li.circle {
+ list-style:circle;
+}
ul.horizontal li {
display:inline;
font-size:0.9em;
@@ -369,19 +423,22 @@ table tr td dl, table tr td dl dt, table tr td dl dd {
margin-bottom:1px;
}
/*
-Table styles
-*/
-.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary {
+ * Styles for tables.
+ */
+.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary,
+.requiresSummary, .packagesSummary, .providesSummary, .usesSummary {
width:100%;
+ border-spacing:0;
border-left:1px solid #EEE;
border-right:1px solid #EEE;
border-bottom:1px solid #EEE;
}
-.overviewSummary, .memberSummary {
+.overviewSummary, .memberSummary, .requiresSummary, .packagesSummary, .providesSummary, .usesSummary {
padding:0;
}
.overviewSummary caption, .memberSummary caption, .typeSummary caption,
-.useSummary caption, .constantsSummary caption, .deprecatedSummary caption {
+.useSummary caption, .constantsSummary caption, .deprecatedSummary caption,
+.requiresSummary caption, .packagesSummary caption, .providesSummary caption, .usesSummary caption {
position:relative;
text-align:left;
background-repeat:no-repeat;
@@ -389,36 +446,46 @@ Table styles
font-weight:bold;
clear:none;
overflow:hidden;
- padding:0;
- padding-top:10px;
- padding-left:1px;
+ padding: 10px 0 0 1px;
margin:0;
white-space:pre;
}
.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link,
-.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link,
+.constantsSummary caption a:link, .deprecatedSummary caption a:link,
+.requiresSummary caption a:link, .packagesSummary caption a:link, .providesSummary caption a:link,
+.usesSummary caption a:link,
.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover,
-.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover,
+.constantsSummary caption a:hover, .deprecatedSummary caption a:hover,
+.requiresSummary caption a:hover, .packagesSummary caption a:hover, .providesSummary caption a:hover,
+.usesSummary caption a:hover,
.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active,
-.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active,
+.constantsSummary caption a:active, .deprecatedSummary caption a:active,
+.requiresSummary caption a:active, .packagesSummary caption a:active, .providesSummary caption a:active,
+.usesSummary caption a:active,
.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited,
-.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited {
+.constantsSummary caption a:visited, .deprecatedSummary caption a:visited,
+.requiresSummary caption a:visited, .packagesSummary caption a:visited, .providesSummary caption a:visited,
+.usesSummary caption a:visited {
color:#FFFFFF;
}
+.useSummary caption a:link, .useSummary caption a:hover, .useSummary caption a:active,
+.useSummary caption a:visited {
+ color:#1f389c;
+}
.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span,
-.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span {
+.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span,
+.requiresSummary caption span, .packagesSummary caption span, .providesSummary caption span,
+.usesSummary caption span {
white-space:nowrap;
- padding-top:5px;
- padding-left:12px;
- padding-right:12px;
- padding-bottom:7px;
+ padding: 5px 12px 7px;
display:inline-block;
float:left;
background-color:#F8981D;
border: none;
height:16px;
}
-.memberSummary caption span.activeTableTab span {
+.memberSummary caption span.activeTableTab span, .packagesSummary caption span.activeTableTab span,
+.overviewSummary caption span.activeTableTab span, .typeSummary caption span.activeTableTab span {
white-space:nowrap;
padding-top:5px;
padding-left:12px;
@@ -429,7 +496,8 @@ Table styles
background-color:#F8981D;
height:16px;
}
-.memberSummary caption span.tableTab span {
+.memberSummary caption span.tableTab span, .packagesSummary caption span.tableTab span,
+.overviewSummary caption span.tableTab span, .typeSummary caption span.tableTab span {
white-space:nowrap;
padding-top:5px;
padding-left:12px;
@@ -440,7 +508,10 @@ Table styles
background-color:#4D7A97;
height:16px;
}
-.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab {
+.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab,
+.packagesSummary caption span.tableTab, .packagesSummary caption span.activeTableTab,
+.overviewSummary caption span.tableTab, .overviewSummary caption span.activeTableTab,
+.typeSummary caption span.tableTab, .typeSummary caption span.activeTableTab {
padding-top:0;
padding-left:0;
padding-right:0;
@@ -449,14 +520,16 @@ Table styles
display:inline;
}
.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd,
-.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd {
+.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd,
+.requiresSummary .tabEnd, .packagesSummary .tabEnd, .providesSummary .tabEnd, .usesSummary .tabEnd {
display:none;
width:5px;
position:relative;
float:left;
background-color:#F8981D;
}
-.memberSummary .activeTableTab .tabEnd {
+.memberSummary .activeTableTab .tabEnd, .packagesSummary .activeTableTab .tabEnd,
+.overviewSummary .activeTableTab .tabEnd, .typeSummary .activeTableTab .tabEnd {
display:none;
width:5px;
margin-right:3px;
@@ -464,66 +537,88 @@ Table styles
float:left;
background-color:#F8981D;
}
-.memberSummary .tableTab .tabEnd {
+.memberSummary .tableTab .tabEnd, .packagesSummary .tableTab .tabEnd,
+.overviewSummary .tableTab .tabEnd, .typeSummary .tableTab .tabEnd {
display:none;
width:5px;
margin-right:3px;
position:relative;
background-color:#4D7A97;
float:left;
-
+}
+.rowColor th, .altColor th {
+ font-weight:normal;
}
.overviewSummary td, .memberSummary td, .typeSummary td,
-.useSummary td, .constantsSummary td, .deprecatedSummary td {
+.useSummary td, .constantsSummary td, .deprecatedSummary td,
+.requiresSummary td, .packagesSummary td, .providesSummary td, .usesSummary td {
text-align:left;
padding:0 0 12px 10px;
}
-th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th,
-td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{
+th.colFirst, th.colSecond, th.colLast, th.colConstructorName, th.colDeprecatedItemName, .useSummary th,
+.constantsSummary th, .packagesSummary th, td.colFirst, td.colSecond, td.colLast, .useSummary td,
+.constantsSummary td {
vertical-align:top;
padding-right:0;
padding-top:8px;
padding-bottom:3px;
}
-th.colFirst, th.colLast, th.colOne, .constantsSummary th {
+th.colFirst, th.colSecond, th.colLast, th.colConstructorName, th.colDeprecatedItemName, .constantsSummary th,
+.packagesSummary th {
background:#dee3e9;
text-align:left;
padding:8px 3px 3px 7px;
}
td.colFirst, th.colFirst {
- white-space:nowrap;
- font-size:14px;
+ font-size:13px;
}
-td.colLast, th.colLast {
- font-size:14px;
+td.colSecond, th.colSecond, td.colLast, th.colConstructorName, th.colDeprecatedItemName, th.colLast {
+ font-size:13px;
}
-td.colOne, th.colOne {
- font-size:14px;
+.constantsSummary th, .packagesSummary th {
+ font-size:13px;
+}
+.providesSummary th.colFirst, .providesSummary th.colLast, .providesSummary td.colFirst,
+.providesSummary td.colLast {
+ white-space:normal;
+ font-size:13px;
}
.overviewSummary td.colFirst, .overviewSummary th.colFirst,
-.useSummary td.colFirst, .useSummary th.colFirst,
-.overviewSummary td.colOne, .overviewSummary th.colOne,
+.requiresSummary td.colFirst, .requiresSummary th.colFirst,
+.packagesSummary td.colFirst, .packagesSummary td.colSecond, .packagesSummary th.colFirst, .packagesSummary th,
+.usesSummary td.colFirst, .usesSummary th.colFirst,
+.providesSummary td.colFirst, .providesSummary th.colFirst,
.memberSummary td.colFirst, .memberSummary th.colFirst,
-.memberSummary td.colOne, .memberSummary th.colOne,
-.typeSummary td.colFirst{
- width:25%;
+.memberSummary td.colSecond, .memberSummary th.colSecond, .memberSummary th.colConstructorName,
+.typeSummary td.colFirst, .typeSummary th.colFirst {
vertical-align:top;
}
-td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover {
+.packagesSummary th.colLast, .packagesSummary td.colLast {
+ white-space:normal;
+}
+td.colFirst a:link, td.colFirst a:visited,
+td.colSecond a:link, td.colSecond a:visited,
+th.colFirst a:link, th.colFirst a:visited,
+th.colSecond a:link, th.colSecond a:visited,
+th.colConstructorName a:link, th.colConstructorName a:visited,
+th.colDeprecatedItemName a:link, th.colDeprecatedItemName a:visited,
+.constantValuesContainer td a:link, .constantValuesContainer td a:visited,
+.allClassesContainer td a:link, .allClassesContainer td a:visited,
+.allPackagesContainer td a:link, .allPackagesContainer td a:visited {
font-weight:bold;
}
.tableSubHeadingColor {
background-color:#EEEEFF;
}
-.altColor {
+.altColor, .altColor th {
background-color:#FFFFFF;
}
-.rowColor {
+.rowColor, .rowColor th {
background-color:#EEEEEF;
}
/*
-Content styles
-*/
+ * Styles for contents.
+ */
.description pre {
margin-top:0;
}
@@ -534,27 +629,22 @@ Content styles
.docSummary {
padding:0;
}
-
ul.blockList ul.blockList ul.blockList li.blockList h3 {
font-style:normal;
}
-
div.block {
- font-size:15px;
- font-family: Helvetica, "Times New Roman", Times, serif;
+ font-size:14px;
+ font-family: Verdana, Georgia, "Times New Roman", Times, serif;
}
-
td.colLast div {
padding-top:0;
}
-
-
td.colLast a {
padding-bottom:3px;
}
/*
-Formatting effect styles
-*/
+ * Styles for formatting effect.
+ */
.sourceLineNo {
color:green;
padding:0 30px 0 0;
@@ -569,23 +659,257 @@ h1.hidden {
margin:3px 10px 2px 0;
color:#474747;
}
-.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink,
-.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel,
-.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink {
+.deprecatedLabel, .descfrmTypeLabel, .implementationLabel, .memberNameLabel, .memberNameLink,
+.moduleLabelInPackage, .moduleLabelInType, .overrideSpecifyLabel, .packageLabelInType,
+.packageHierarchyLabel, .paramLabel, .returnLabel, .seeLabel, .simpleTagLabel,
+.throwsLabel, .typeNameLabel, .typeNameLink, .searchTagLink {
font-weight:bold;
}
.deprecationComment, .emphasizedPhrase, .interfaceName {
font-style:italic;
}
-
-div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase,
+.deprecationBlock {
+ font-size:14px;
+ font-family: Verdana, Georgia, "Times New Roman", Times, serif;
+ border-style:solid;
+ border-width:thin;
+ border-radius:10px;
+ padding:10px;
+ margin-bottom:10px;
+ margin-right:10px;
+ display:inline-block;
+}
+div.block div.deprecationComment, div.block div.block span.emphasizedPhrase,
div.block div.block span.interfaceName {
font-style:normal;
}
-
-div.contentContainer ul.blockList li.blockList h2{
+div.contentContainer ul.blockList li.blockList h2 {
padding-bottom:0;
}
+/*
+ * Styles for IFRAME.
+ */
+.mainContainer {
+ margin:0 auto;
+ padding:0;
+ height:100%;
+ width:100%;
+ position:fixed;
+ top:0;
+ left:0;
+}
+.leftContainer {
+ height:100%;
+ position:fixed;
+ width:320px;
+}
+.leftTop {
+ position:relative;
+ float:left;
+ width:315px;
+ top:0;
+ left:0;
+ height:30%;
+ border-right:6px solid #ccc;
+ border-bottom:6px solid #ccc;
+}
+.leftBottom {
+ position:relative;
+ float:left;
+ width:315px;
+ bottom:0;
+ left:0;
+ height:70%;
+ border-right:6px solid #ccc;
+ border-top:1px solid #000;
+}
+.rightContainer {
+ position:absolute;
+ left:320px;
+ top:0;
+ bottom:0;
+ height:100%;
+ right:0;
+ border-left:1px solid #000;
+}
+.rightIframe {
+ padding:0;
+ height:100%;
+ right:30px;
+ width:100%;
+ overflow:visible;
+ margin: 0 0 30px;
+}
+/*
+ * Styles specific to HTML5 elements.
+ */
+main, nav, header, footer, section {
+ display:block;
+}
+/*
+ * Styles for javadoc search.
+ */
+.ui-autocomplete-category {
+ font-weight:bold;
+ font-size:15px;
+ padding:7px 0 7px 3px;
+ background-color:#4D7A97;
+ color:#FFFFFF;
+}
+.resultItem {
+ font-size:13px;
+}
+.ui-autocomplete {
+ max-height:85%;
+ max-width:65%;
+ overflow-y:scroll;
+ overflow-x:scroll;
+ white-space:nowrap;
+ box-shadow: 0 3px 6px rgba(0,0,0,0.16), 0 3px 6px rgba(0,0,0,0.23);
+}
+ul.ui-autocomplete {
+ position:fixed;
+ z-index:999999;
+}
+ul.ui-autocomplete li {
+ float:left;
+ clear:both;
+ width:100%;
+}
+.resultHighlight {
+ font-weight:bold;
+}
+#search {
+ background-image:url('resources/glass.png');
+ background-size:13px;
+ background-repeat:no-repeat;
+ background-position:2px 3px;
+ padding-left:20px;
+ position:relative;
+ right:-18px;
+}
+#reset {
+ background-color: rgb(255,255,255);
+ background-image:url('resources/x.png');
+ background-position:center;
+ background-repeat:no-repeat;
+ background-size:12px;
+ border:0 none;
+ width:16px;
+ height:17px;
+ position:relative;
+ left:-4px;
+ top:-4px;
+ font-size:0;
+}
+.watermark {
+ color:#545454;
+}
+.searchTagDescResult {
+ font-style:italic;
+ font-size:11px;
+}
+.searchTagHolderResult {
+ font-style:italic;
+ font-size:12px;
+}
+.searchTagResult:before, .searchTagResult:target {
+ color:red;
+}
+.moduleGraph span {
+ display:none;
+ position:absolute;
+}
+.moduleGraph:hover span {
+ display:block;
+ margin: -100px 0 0 100px;
+ z-index: 1;
+}
+.methodSignature {
+ white-space:normal;
+ color: #4d7a97;
+ font-weight: 700;
+}
+
+/*
+ * Styles for user-provided tables.
+ *
+ * borderless:
+ * No borders, vertical margins, styled caption.
+ * This style is provided for use with existing doc comments.
+ * In general, borderless tables should not be used for layout purposes.
+ *
+ * plain:
+ * Plain borders around table and cells, vertical margins, styled caption.
+ * Best for small tables or for complex tables for tables with cells that span
+ * rows and columns, when the "striped" style does not work well.
+ *
+ * striped:
+ * Borders around the table and vertical borders between cells, striped rows,
+ * vertical margins, styled caption.
+ * Best for tables that have a header row, and a body containing a series of simple rows.
+ */
+
+table.borderless,
+table.plain,
+table.striped {
+ margin-top: 10px;
+ margin-bottom: 10px;
+}
+table.borderless > caption,
+table.plain > caption,
+table.striped > caption {
+ font-weight: bold;
+ font-size: smaller;
+}
+table.borderless th, table.borderless td,
+table.plain th, table.plain td,
+table.striped th, table.striped td {
+ padding: 2px 5px;
+}
+table.borderless,
+table.borderless > thead > tr > th, table.borderless > tbody > tr > th, table.borderless > tr > th,
+table.borderless > thead > tr > td, table.borderless > tbody > tr > td, table.borderless > tr > td {
+ border: none;
+}
+table.borderless > thead > tr, table.borderless > tbody > tr, table.borderless > tr {
+ background-color: transparent;
+}
+table.plain {
+ border-collapse: collapse;
+ border: 1px solid black;
+}
+table.plain > thead > tr, table.plain > tbody tr, table.plain > tr {
+ background-color: transparent;
+}
+table.plain > thead > tr > th, table.plain > tbody > tr > th, table.plain > tr > th,
+table.plain > thead > tr > td, table.plain > tbody > tr > td, table.plain > tr > td {
+ border: 1px solid black;
+}
+table.striped {
+ border-collapse: collapse;
+ border: 1px solid black;
+}
+table.striped > thead {
+ background-color: #E3E3E3;
+}
+table.striped > thead > tr > th, table.striped > thead > tr > td {
+ border: 1px solid black;
+}
+table.striped > tbody > tr:nth-child(even) {
+ background-color: #EEE
+}
+table.striped > tbody > tr:nth-child(odd) {
+ background-color: #FFF
+}
+table.striped > tbody > tr > th, table.striped > tbody > tr > td {
+ border-left: 1px solid black;
+ border-right: 1px solid black;
+}
+table.striped > tbody > tr > th {
+ font-weight: normal;
+}
+
/* ================================================================= */
diff --git a/pom.xml b/pom.xml
index 28b3c7e..b1fbaaf 100644
--- a/pom.xml
+++ b/pom.xml
@@ -219,13 +219,14 @@
<link href="{@docRoot}/resources/sh/styles/shCoreNlpCraft.css" rel="stylesheet" type="text/css" title="Style">
<link href="{@docRoot}/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>
]]>
</top>
<!-- Disabled because of https://bugs.openjdk.java.net/browse/JDK-8193030 -->
<!-- <subpackages>org.apache.nlpcraft.client</subpackages> -->
<excludePackageNames>
- org.apache.nlpcraft.client.impl
+ org.apache.nlpcraft.client.impl:org.apache.nlpcraft.client.impl.beans
</excludePackageNames>
<groups>
<group>
@@ -267,7 +268,7 @@
</footer>
<doctitle>
<![CDATA[
- Apache NLPCraft - Java Client API <span style="font-size: 80%">${project.version}</span>
+ <img style="margin-top: 15px" src="https://nlpcraft.apache.org/images/nlpcraft_logo_darkblue.png" height="54px">
]]>
</doctitle>
<windowtitle>Apache NLPCraft - Java Client ${project.version}</windowtitle>
diff --git a/src/main/java/org/apache/nlpcraft/client/NCClient.java b/src/main/java/org/apache/nlpcraft/client/NCClient.java
index 9e9d4f4..283d913 100644
--- a/src/main/java/org/apache/nlpcraft/client/NCClient.java
+++ b/src/main/java/org/apache/nlpcraft/client/NCClient.java
@@ -21,9 +21,9 @@ import java.io.*;
import java.util.*;
/**
- * Java client API. Java REST client provides native and easy-to-use wrapper for NLPCraft
- * <a target=_ href="https://nlpcraft.apache.org/using-rest.html">REST APIs</a> for any JVM-based languages
- * like Java, Scala, Kotlin or Groovy. Note that NLPCraft REST APIs allow to submit the request to existing
+ * <b>Java client API</b> provides native JVM wrapper for NLPCraft
+ * <a target=_ href="https://nlpcraft.apache.org/using-rest.html">REST APIs</a>. Note that NLPCraft REST APIs allow to
+ * submit the request to existing
* deployed data model and perform other related, auxiliary operations. To create data models you need to
* use main <a target=_ href="https://nlpcraft.apache.org/apis/latest/index.html">NLPCraft APIs</a>.
* <p>
@@ -49,7 +49,7 @@ import java.util.*;
* // Perform any necessary calls...
* NCResult res = cli.askSync("my.model.id", txt);
*
- * // Close client & sign out at the end.
+ * // Close client & sign out at the end.
* cli.close();
* </pre>
*
@@ -543,7 +543,19 @@ public interface NCClient {
*/
void deleteCompany() throws NCClientException, IOException;
- // TODO:
+ /**
+ * Runs <a href="https://nlpcraft.apache.org/tools/syn_tool.html">synonym suggestion tool</a> for given model
+ * ID and minimal score.
+ *
+ * @param mdlId ID Of the model to run the tool for.
+ * @param minScore Minimum score to include into the result, ranging from 0 to 1, default is 0.
+ * Score of 0 will include all results, and score of 1 will include only results with the absolutely highest
+ * confidence score. Values between 0.5 and 0.7 is generally suggested.
+ * @return Suggestion data container.
+ * @throws NCClientException Thrown in case of client-specific errors.
+ * @throws IOException Thrown in case of generic I/O errors.
+ * @see <a href="https://nlpcraft.apache.org/tools/syn_tool.html">Synonym suggestion tool</a>.
+ */
NCSuggestionData suggestSynonyms(String mdlId, Double minScore) throws NCClientException, IOException;
/**
diff --git a/src/main/java/org/apache/nlpcraft/client/NCClientBuilder.java b/src/main/java/org/apache/nlpcraft/client/NCClientBuilder.java
index b004425..c0a238b 100644
--- a/src/main/java/org/apache/nlpcraft/client/NCClientBuilder.java
+++ b/src/main/java/org/apache/nlpcraft/client/NCClientBuilder.java
@@ -40,7 +40,7 @@ import java.util.function.Supplier;
* // Perform any necessary calls...
* NCResult res = cli.askSync("my.model.id", txt);
*
- * // Close client & sign out at the end.
+ * // Close client & sign out at the end.
* cli.close();
* </pre>
*/
diff --git a/src/main/java/org/apache/nlpcraft/client/NCSuggestion.java b/src/main/java/org/apache/nlpcraft/client/NCSuggestion.java
index 18437e8..cb90f1c 100644
--- a/src/main/java/org/apache/nlpcraft/client/NCSuggestion.java
+++ b/src/main/java/org/apache/nlpcraft/client/NCSuggestion.java
@@ -17,8 +17,23 @@
package org.apache.nlpcraft.client;
-// TODO:
+/**
+ * Individual synonym suggestion returned from {@link NCSuggestionData#getSynonyms()} method.
+ *
+ * @see <a href="https://nlpcraft.apache.org/tools/syn_tool.html">Synonym suggestion tool</a>.
+ */
public interface NCSuggestion {
+ /**
+ * Gets score of the suggested synonym.
+ *
+ * @return Score of the suggested synonym.
+ */
double getScore();
+
+ /**
+ * Gets synonym.
+ *
+ * @return A synonym.
+ */
String getSynonym();
}
diff --git a/src/main/java/org/apache/nlpcraft/client/NCSuggestionData.java b/src/main/java/org/apache/nlpcraft/client/NCSuggestionData.java
index 81b9b27..967b7f0 100644
--- a/src/main/java/org/apache/nlpcraft/client/NCSuggestionData.java
+++ b/src/main/java/org/apache/nlpcraft/client/NCSuggestionData.java
@@ -20,13 +20,58 @@ package org.apache.nlpcraft.client;
import java.util.List;
import java.util.Map;
-// TODO:
+/**
+ * Result container returned by {@link NCClient#suggestSynonyms(String, Double)} method.
+ *
+ * @see <a href="https://nlpcraft.apache.org/tools/syn_tool.html">Synonym suggestion tool</a>.
+ */
public interface NCSuggestionData {
+ /**
+ * Gets model ID.
+ *
+ * @return model ID.
+ */
String getModelId();
+
+ /**
+ * Gets minimal score used.
+ *
+ * @return Minimal score used.
+ */
double getMinScore();
+
+ /**
+ * Gets duration of the operation in milliseconds.
+ *
+ * @return Duration of the operation in milliseconds.
+ */
long getDurationMs();
+
+ /**
+ * Gets timestamp of the operation.
+ *
+ * @return Timestamp of the operation.
+ */
long getTimestamp();
+
+ /**
+ * Gets optional error message.
+ *
+ * @return Error message or {@code null} if there was no error.
+ */
String getError();
+
+ /**
+ * Gets list of synonym suggestions for each model element ID.
+ *
+ * @return List of synonym suggestions for each model element ID.
+ */
List<Map<String, List<NCSuggestion>>> getSynonyms();
+
+ /**
+ * Optional list of warnings.
+ *
+ * @return List of warnings or {@code null} if there's no warnings.
+ */
List<String> getWarnings();
}
diff --git a/src/main/java/org/apache/nlpcraft/client/impl/NCClientImpl.java b/src/main/java/org/apache/nlpcraft/client/impl/NCClientImpl.java
index c44aa2d..e2957c9 100644
--- a/src/main/java/org/apache/nlpcraft/client/impl/NCClientImpl.java
+++ b/src/main/java/org/apache/nlpcraft/client/impl/NCClientImpl.java
@@ -439,16 +439,6 @@ public class NCClientImpl implements NCClient {
}
/**
- * @param v
- * @param name
- * @throws IllegalArgumentException
- */
- private void notNull(Object v, String name) throws IllegalArgumentException {
- if (v == null)
- throw new IllegalArgumentException(String.format("Parameter cannot be null: '%s'", name));
- }
-
- /**
*
* @return
* @throws IOException
diff --git a/src/main/java/org/apache/nlpcraft/client/impl/beans/NCAskBean.java b/src/main/java/org/apache/nlpcraft/client/impl/beans/NCAskBean.java
index 774a781..4423647 100644
--- a/src/main/java/org/apache/nlpcraft/client/impl/beans/NCAskBean.java
+++ b/src/main/java/org/apache/nlpcraft/client/impl/beans/NCAskBean.java
@@ -25,9 +25,6 @@ import com.google.gson.annotations.*;
public class NCAskBean extends NCStatusResponseBean {
@SerializedName("srvReqId") private String srvReqId;
- /**
- * Gets server request ID.
- */
public String getServerRequestId() {
return srvReqId;
}
diff --git a/src/main/java/org/apache/nlpcraft/client/impl/beans/NCAskSyncBean.java b/src/main/java/org/apache/nlpcraft/client/impl/beans/NCAskSyncBean.java
index 53c436b..aac9c33 100644
--- a/src/main/java/org/apache/nlpcraft/client/impl/beans/NCAskSyncBean.java
+++ b/src/main/java/org/apache/nlpcraft/client/impl/beans/NCAskSyncBean.java
@@ -25,9 +25,6 @@ import com.google.gson.annotations.SerializedName;
public class NCAskSyncBean extends NCStatusResponseBean {
@SerializedName("state") private NCRequestStateBean state;
- /**
- * Gets request state.
- */
public NCRequestStateBean getState() {
return state;
}
diff --git a/src/main/java/org/apache/nlpcraft/client/impl/beans/NCCheckBean.java b/src/main/java/org/apache/nlpcraft/client/impl/beans/NCCheckBean.java
index 40828d5..93a3a99 100644
--- a/src/main/java/org/apache/nlpcraft/client/impl/beans/NCCheckBean.java
+++ b/src/main/java/org/apache/nlpcraft/client/impl/beans/NCCheckBean.java
@@ -27,9 +27,6 @@ import java.util.List;
public class NCCheckBean extends NCStatusResponseBean {
@SerializedName("states") private List<NCRequestStateBean> states;
- /**
- * Gets the list of request states.
- */
public List<NCRequestStateBean> getStates() {
return states;
}
diff --git a/src/main/java/org/apache/nlpcraft/client/impl/beans/NCCompanyBean.java b/src/main/java/org/apache/nlpcraft/client/impl/beans/NCCompanyBean.java
index 287428b..5b522f8 100644
--- a/src/main/java/org/apache/nlpcraft/client/impl/beans/NCCompanyBean.java
+++ b/src/main/java/org/apache/nlpcraft/client/impl/beans/NCCompanyBean.java
@@ -33,43 +33,28 @@ public class NCCompanyBean extends NCStatusResponseBean implements NCCompany {
@SerializedName("address") private String address;
@SerializedName("postalCode") private String postalCode;
- @Override
- public long getId() {
+ @Override public long getId() {
return id;
}
-
- @Override
- public String getName() {
+ @Override public String getName() {
return name;
}
-
- @Override
- public String getWebsite() {
+ @Override public String getWebsite() {
return website;
}
-
- @Override
- public String getCountry() {
+ @Override public String getCountry() {
return country;
}
-
- @Override
- public String getRegion() {
+ @Override public String getRegion() {
return region;
}
-
- @Override
- public String getCity() {
+ @Override public String getCity() {
return city;
}
-
- @Override
- public String getAddress() {
+ @Override public String getAddress() {
return address;
}
-
- @Override
- public String getPostalCode() {
+ @Override public String getPostalCode() {
return postalCode;
}
}
diff --git a/src/main/java/org/apache/nlpcraft/client/impl/beans/NCCompanyTokenResetBean.java b/src/main/java/org/apache/nlpcraft/client/impl/beans/NCCompanyTokenResetBean.java
index db419f7..5fed10d 100644
--- a/src/main/java/org/apache/nlpcraft/client/impl/beans/NCCompanyTokenResetBean.java
+++ b/src/main/java/org/apache/nlpcraft/client/impl/beans/NCCompanyTokenResetBean.java
@@ -25,9 +25,6 @@ import com.google.gson.annotations.SerializedName;
public class NCCompanyTokenResetBean extends NCStatusResponseBean {
@SerializedName("token") private String token;
- /**
- * Gets new company token.
- */
public String getToken() {
return token;
}
diff --git a/src/main/java/org/apache/nlpcraft/client/impl/beans/NCErrorMessageBean.java b/src/main/java/org/apache/nlpcraft/client/impl/beans/NCErrorMessageBean.java
index 05cc30d..73c0d79 100644
--- a/src/main/java/org/apache/nlpcraft/client/impl/beans/NCErrorMessageBean.java
+++ b/src/main/java/org/apache/nlpcraft/client/impl/beans/NCErrorMessageBean.java
@@ -26,16 +26,9 @@ public class NCErrorMessageBean {
@SerializedName("code") private String code;
@SerializedName("msg") private String msg;
- /**
- * Gets error code.
- */
public String getCode() {
return code;
}
-
- /**
- * Gets error message.
- */
public String getMessage() {
return msg;
}
diff --git a/src/main/java/org/apache/nlpcraft/client/impl/beans/NCFeedbackAddBean.java b/src/main/java/org/apache/nlpcraft/client/impl/beans/NCFeedbackAddBean.java
index b55f0d6..d94d03b 100644
--- a/src/main/java/org/apache/nlpcraft/client/impl/beans/NCFeedbackAddBean.java
+++ b/src/main/java/org/apache/nlpcraft/client/impl/beans/NCFeedbackAddBean.java
@@ -25,9 +25,6 @@ import com.google.gson.annotations.SerializedName;
public class NCFeedbackAddBean extends NCStatusResponseBean {
@SerializedName("id") private Long id;
- /**
- * ID of the newly added feedback record.
- */
public Long getId() {
return id;
}
diff --git a/src/main/java/org/apache/nlpcraft/client/impl/beans/NCFeedbackAllBean.java b/src/main/java/org/apache/nlpcraft/client/impl/beans/NCFeedbackAllBean.java
index 8464432..91f753a 100644
--- a/src/main/java/org/apache/nlpcraft/client/impl/beans/NCFeedbackAllBean.java
+++ b/src/main/java/org/apache/nlpcraft/client/impl/beans/NCFeedbackAllBean.java
@@ -27,9 +27,6 @@ import java.util.List;
public class NCFeedbackAllBean extends NCStatusResponseBean {
@SerializedName("feedback") private List<NCFeedbackBean> feedback;
- /**
- * Gets the list of all feedback records.
- */
public List<NCFeedbackBean> getFeedback() {
return feedback;
}
diff --git a/src/main/java/org/apache/nlpcraft/client/impl/beans/NCFeedbackBean.java b/src/main/java/org/apache/nlpcraft/client/impl/beans/NCFeedbackBean.java
index c40b2a4..119ab65 100644
--- a/src/main/java/org/apache/nlpcraft/client/impl/beans/NCFeedbackBean.java
+++ b/src/main/java/org/apache/nlpcraft/client/impl/beans/NCFeedbackBean.java
@@ -29,75 +29,41 @@ public class NCFeedbackBean implements NCFeedback {
private double score;
private String comment;
private long createTstamp;
-
- @Override
- public long getId() {
+
+ @Override public String getServerRequestId() {
+ return srvReqId;
+ }
+ @Override public long getCreateTimestamp() {
+ return createTstamp;
+ }
+ @Override public long getUserId() {
+ return usrId;
+ }
+ @Override public double getScore() {
+ return score;
+ }
+ @Override public String getComment() {
+ return comment;
+ }
+ @Override public long getId() {
return id;
}
- /**
- * Sets feedback record ID.
- */
public void setId(long id) {
this.id = id;
}
-
- @Override
- public String getServerRequestId() {
- return srvReqId;
- }
-
- /**
- * Sets server request ID.
- */
public void setServerRequestId(String srvReqId) {
this.srvReqId = srvReqId;
}
-
- @Override
- public long getUserId() {
- return usrId;
- }
-
- /**
- * Sets user ID.
- */
public void setUsrId(long usrId) {
this.usrId = usrId;
}
-
- @Override
- public double getScore() {
- return score;
- }
-
- /**
- * Sets feedback score.
- */
public void setScore(double score) {
this.score = score;
}
-
- @Override
- public String getComment() {
- return comment;
- }
-
- /**
- * Sets feedback comment.
- */
public void setComment(String comment) {
this.comment = comment;
}
-
- @Override
- public long getCreateTimestamp() {
- return createTstamp;
- }
-
- /**
- * Sets create timestamp.
- */
public void setCreateTstamp(long createTstamp) {
this.createTstamp = createTstamp;
}
diff --git a/src/main/java/org/apache/nlpcraft/client/impl/beans/NCModelBean.java b/src/main/java/org/apache/nlpcraft/client/impl/beans/NCModelBean.java
index fa6a293..1fcf975 100644
--- a/src/main/java/org/apache/nlpcraft/client/impl/beans/NCModelBean.java
+++ b/src/main/java/org/apache/nlpcraft/client/impl/beans/NCModelBean.java
@@ -28,18 +28,13 @@ public class NCModelBean implements NCModel {
@SerializedName("name") private String name;
@SerializedName("version") private String version;
- @Override
- public String getId() {
+ @Override public String getId() {
return id;
}
-
- @Override
- public String getName() {
+ @Override public String getName() {
return name;
}
-
- @Override
- public String getVersion() {
+ @Override public String getVersion() {
return version;
}
}
\ No newline at end of file
diff --git a/src/main/java/org/apache/nlpcraft/client/impl/beans/NCProbeBean.java b/src/main/java/org/apache/nlpcraft/client/impl/beans/NCProbeBean.java
index 9f8add9..86f9dda 100644
--- a/src/main/java/org/apache/nlpcraft/client/impl/beans/NCProbeBean.java
+++ b/src/main/java/org/apache/nlpcraft/client/impl/beans/NCProbeBean.java
@@ -49,98 +49,23 @@ public class NCProbeBean implements NCProbe {
@SerializedName("macAddr") private String macAddr;
@SerializedName("models") private Set<NCModelBean> models;
- @Override
- public String getProbeToken() {
- return probeToken;
- }
-
- @Override
- public String getId() {
- return id;
- }
-
- @Override
- public String getProbeGuid() {
- return probeGuid;
- }
-
- @Override
- public String getProbeApiVersion() {
- return probeApiVersion;
- }
-
- @Override
- public String getProbeApiDate() {
- return probeApiDate;
- }
-
- @Override
- public String getOsVersion() {
- return osVersion;
- }
-
- @Override
- public String getOsName() {
- return osName;
- }
-
- @Override
- public String getOsArchitecture() {
- return osArch;
- }
-
- @Override
- public long getStartTimestamp() {
- return startTstamp;
- }
-
- @Override
- public String getTimezoneId() {
- return tmzId;
- }
-
- @Override
- public String getTimezoneAbbreviation() {
- return tmzAbbr;
- }
-
- @Override
- public String getTimezoneName() {
- return tmzName;
- }
-
- @Override
- public String getUserName() {
- return userName;
- }
-
- @Override
- public String getJavaVersion() {
- return javaVersion;
- }
-
- @Override
- public String getJavaVendor() {
- return javaVendor;
- }
-
- @Override
- public String getHostName() {
- return hostName;
- }
-
- @Override
- public String getHostAddress() {
- return hostAddr;
- }
-
- @Override
- public String getMacAddress() {
- return macAddr;
- }
-
- @Override
- public Set<NCModel> getModels() {
- return models != null ? new HashSet<>(models) : Collections.emptySet();
- }
+ @Override public String getProbeToken() { return probeToken; }
+ @Override public String getId() { return id; }
+ @Override public String getProbeGuid() { return probeGuid; }
+ @Override public String getProbeApiVersion() { return probeApiVersion; }
+ @Override public String getProbeApiDate() { return probeApiDate; }
+ @Override public String getOsVersion() { return osVersion; }
+ @Override public String getOsName() { return osName; }
+ @Override public String getOsArchitecture() { return osArch; }
+ @Override public long getStartTimestamp() { return startTstamp; }
+ @Override public String getTimezoneId() { return tmzId; }
+ @Override public String getTimezoneAbbreviation() { return tmzAbbr; }
+ @Override public String getTimezoneName() { return tmzName; }
+ @Override public String getUserName() { return userName; }
+ @Override public String getJavaVersion() { return javaVersion; }
+ @Override public String getJavaVendor() { return javaVendor; }
+ @Override public String getHostName() { return hostName; }
+ @Override public String getHostAddress() { return hostAddr; }
+ @Override public String getMacAddress() { return macAddr; }
+ @Override public Set<NCModel> getModels() { return models != null ? new HashSet<>(models) : Collections.emptySet(); }
}
diff --git a/src/main/java/org/apache/nlpcraft/client/impl/beans/NCProbesAllBean.java b/src/main/java/org/apache/nlpcraft/client/impl/beans/NCProbesAllBean.java
index 9434003..e9a9f64 100644
--- a/src/main/java/org/apache/nlpcraft/client/impl/beans/NCProbesAllBean.java
+++ b/src/main/java/org/apache/nlpcraft/client/impl/beans/NCProbesAllBean.java
@@ -27,9 +27,6 @@ import java.util.List;
public class NCProbesAllBean extends NCStatusResponseBean {
@SerializedName("probes") private List<NCProbeBean> probes;
- /**
- * Gets all probes.
- */
public List<NCProbeBean> getProbes() {
return probes;
}
diff --git a/src/main/java/org/apache/nlpcraft/client/impl/beans/NCRequestStateBean.java b/src/main/java/org/apache/nlpcraft/client/impl/beans/NCRequestStateBean.java
index 544e390..f50f9cf 100644
--- a/src/main/java/org/apache/nlpcraft/client/impl/beans/NCRequestStateBean.java
+++ b/src/main/java/org/apache/nlpcraft/client/impl/beans/NCRequestStateBean.java
@@ -21,7 +21,6 @@ import org.apache.nlpcraft.client.NCResult;
/**
* REST bean.
- * TODO: doc
*/
public class NCRequestStateBean implements NCResult {
private String srvReqId;
@@ -36,101 +35,70 @@ public class NCRequestStateBean implements NCResult {
private String error;
private String logHolder;
- @Override
- public String getServerRequestId() {
+ @Override public String getServerRequestId() {
return srvReqId;
}
-
- @Override
- public String getText() {
- return txt;
- }
-
- @Override
- public long getUserId() {
- return usrId;
- }
-
- @Override
- public String getModelId() {
- return mdlId;
- }
-
- @Override
- public String getProbeId() {
- return probeId;
- }
-
- @Override
- public String getResultType() {
- return resType;
- }
-
- @Override
- public String getResultBody() {
- return resBody;
- }
-
- @Override
- public boolean isReady() {
- return "QRY_READY".equals(status);
- }
-
- @Override
- public Integer getErrorCode() {
- return errorCode;
- }
-
- @Override
- public String getErrorMessage() {
- return error;
- }
-
- @Override
- public String getLogHolder() {
+ @Override public String getText() {
+ return txt;
+}
+ @Override public long getUserId() {
+ return usrId;
+}
+ @Override public String getModelId() {
+ return mdlId;
+}
+ @Override public String getProbeId() {
+ return probeId;
+}
+ @Override public String getResultType() {
+ return resType;
+}
+ @Override public String getResultBody() {
+ return resBody;
+}
+ @Override public boolean isReady() {
+ return "QRY_READY".equals(status);
+}
+ @Override public Integer getErrorCode() {
+ return errorCode;
+}
+ @Override public String getErrorMessage() {
+ return error;
+}
+ @Override public String getLogHolder() {
return logHolder;
}
public void setSrvReqId(String srvReqId) {
this.srvReqId = srvReqId;
}
-
public void setTxt(String txt) {
this.txt = txt;
}
-
public void setUsrId(long usrId) {
this.usrId = usrId;
}
-
public void setMdlId(String mdlId) {
this.mdlId = mdlId;
}
-
public void setProbeId(String probeId) {
this.probeId = probeId;
}
-
public void setResType(String resType) {
this.resType = resType;
}
-
public void setResBody(String resBody) {
this.resBody = resBody;
}
-
public void setStatus(String status) {
this.status = status;
}
-
public void setErrorCode(Integer errorCode) {
this.errorCode = errorCode;
}
-
public void setError(String error) {
this.error = error;
}
-
public void setLogHolder(String logHolder) {
this.logHolder = logHolder;
}
diff --git a/src/main/java/org/apache/nlpcraft/client/impl/beans/NCSigninBean.java b/src/main/java/org/apache/nlpcraft/client/impl/beans/NCSigninBean.java
index 1e69237..1051b85 100644
--- a/src/main/java/org/apache/nlpcraft/client/impl/beans/NCSigninBean.java
+++ b/src/main/java/org/apache/nlpcraft/client/impl/beans/NCSigninBean.java
@@ -25,9 +25,6 @@ import com.google.gson.annotations.SerializedName;
public class NCSigninBean extends NCStatusResponseBean {
@SerializedName("acsTok") private String acsTok;
- /**
- * Gets newly acquired access token.
- */
public String getAccessToken() {
return acsTok;
}
diff --git a/src/main/java/org/apache/nlpcraft/client/impl/beans/NCStatusResponseBean.java b/src/main/java/org/apache/nlpcraft/client/impl/beans/NCStatusResponseBean.java
index 4a101e9..c3ac263 100644
--- a/src/main/java/org/apache/nlpcraft/client/impl/beans/NCStatusResponseBean.java
+++ b/src/main/java/org/apache/nlpcraft/client/impl/beans/NCStatusResponseBean.java
@@ -25,9 +25,6 @@ import com.google.gson.annotations.SerializedName;
public class NCStatusResponseBean {
@SerializedName("status") private String status;
- /**
- * Gets response status.
- */
public String getStatus() {
return status;
}
diff --git a/src/main/java/org/apache/nlpcraft/client/impl/beans/NCSuggestionBean.java b/src/main/java/org/apache/nlpcraft/client/impl/beans/NCSuggestionBean.java
index 267edf9..943bfde 100644
--- a/src/main/java/org/apache/nlpcraft/client/impl/beans/NCSuggestionBean.java
+++ b/src/main/java/org/apache/nlpcraft/client/impl/beans/NCSuggestionBean.java
@@ -27,21 +27,10 @@ public class NCSuggestionBean implements NCSuggestion {
@SerializedName("score") private double score;
@SerializedName("synonym") private String synonym;
- @Override
- public double getScore() {
+ @Override public double getScore() {
return score;
}
-
- @Override
- public String getSynonym() {
+ @Override public String getSynonym() {
return synonym;
}
-
- @Override
- public String toString() {
- return "NCSynonymSuggestionBean{" +
- "score=" + score +
- ", synonym='" + synonym + '\'' +
- '}';
- }
}
diff --git a/src/main/java/org/apache/nlpcraft/client/impl/beans/NCSuggestionDataBean.java b/src/main/java/org/apache/nlpcraft/client/impl/beans/NCSuggestionDataBean.java
index 938d543..d1e7d75 100644
--- a/src/main/java/org/apache/nlpcraft/client/impl/beans/NCSuggestionDataBean.java
+++ b/src/main/java/org/apache/nlpcraft/client/impl/beans/NCSuggestionDataBean.java
@@ -38,30 +38,18 @@ public class NCSuggestionDataBean implements NCSuggestionData {
@SerializedName("suggestions") private List<Map<String, List<NCSuggestionBean>>> suggestions;
@SerializedName("warnings") private java.util.List<String> warnings;
- @Override
- public String getModelId() {
+ @Override public List<String> getWarnings() { return warnings; }
+ @Override public String getModelId() {
return modelId;
}
-
- @Override
- public double getMinScore() {
+ @Override public double getMinScore() {
return minScore;
}
-
- @Override
- public long getDurationMs() {
+ @Override public long getDurationMs() {
return durationMs;
}
-
- @Override
- public long getTimestamp() {
- return timestamp;
- }
-
- @Override
- public String getError() {
- return error;
- }
+ @Override public long getTimestamp() { return timestamp; }
+ @Override public String getError() { return error; }
@Override
public List<Map<String, List<NCSuggestion>>> getSynonyms() {
@@ -76,22 +64,4 @@ public class NCSuggestionDataBean implements NCSuggestionData {
)
).collect(Collectors.toList());
}
-
- @Override
- public List<String> getWarnings() {
- return warnings;
- }
-
- @Override
- public String toString() {
- return "NCSuggestionSynonymBean{" +
- "modelId='" + modelId + '\'' +
- ", minScore=" + minScore +
- ", durationMs=" + durationMs +
- ", timestamp=" + timestamp +
- ", error='" + error + '\'' +
- ", suggestions=" + suggestions +
- ", warnings=" + warnings +
- '}';
- }
}
diff --git a/src/main/java/org/apache/nlpcraft/client/impl/beans/NCSuggestionResultBean.java b/src/main/java/org/apache/nlpcraft/client/impl/beans/NCSuggestionResultBean.java
index 9a2fc60..304bb39 100644
--- a/src/main/java/org/apache/nlpcraft/client/impl/beans/NCSuggestionResultBean.java
+++ b/src/main/java/org/apache/nlpcraft/client/impl/beans/NCSuggestionResultBean.java
@@ -25,7 +25,6 @@ import com.google.gson.annotations.SerializedName;
public class NCSuggestionResultBean extends NCStatusResponseBean {
@SerializedName("result") private NCSuggestionDataBean result;
- // TODO:
public NCSuggestionDataBean getResult() {
return result;
}
diff --git a/src/main/java/org/apache/nlpcraft/client/impl/beans/NCTokenCreationBean.java b/src/main/java/org/apache/nlpcraft/client/impl/beans/NCTokenCreationBean.java
index 65aa440..fb1dc78 100644
--- a/src/main/java/org/apache/nlpcraft/client/impl/beans/NCTokenCreationBean.java
+++ b/src/main/java/org/apache/nlpcraft/client/impl/beans/NCTokenCreationBean.java
@@ -27,13 +27,10 @@ public class NCTokenCreationBean extends NCStatusResponseBean implements NCNewCo
@SerializedName("token") private String token;
@SerializedName("adminId") private long adminId;
- @Override
- public String getToken() {
+ @Override public String getToken() {
return token;
}
-
- @Override
- public long getAdminUserId() {
+ @Override public long getAdminUserId() {
return adminId;
}
}
diff --git a/src/main/java/org/apache/nlpcraft/client/impl/beans/NCUserAddBean.java b/src/main/java/org/apache/nlpcraft/client/impl/beans/NCUserAddBean.java
index 0077791..e6086e3 100644
--- a/src/main/java/org/apache/nlpcraft/client/impl/beans/NCUserAddBean.java
+++ b/src/main/java/org/apache/nlpcraft/client/impl/beans/NCUserAddBean.java
@@ -25,9 +25,6 @@ import com.google.gson.annotations.SerializedName;
public class NCUserAddBean extends NCStatusResponseBean {
@SerializedName("id") private long id;
- /**
- * Gets ID of the newly created user.
- */
public long getId() {
return id;
}
diff --git a/src/main/java/org/apache/nlpcraft/client/impl/beans/NCUserBean.java b/src/main/java/org/apache/nlpcraft/client/impl/beans/NCUserBean.java
index e734105..4f9b5df 100644
--- a/src/main/java/org/apache/nlpcraft/client/impl/beans/NCUserBean.java
+++ b/src/main/java/org/apache/nlpcraft/client/impl/beans/NCUserBean.java
@@ -35,43 +35,28 @@ public class NCUserBean extends NCStatusResponseBean implements NCUser {
@SerializedName("isAdmin") private boolean isAdmin;
@SerializedName("properties") private Map<String, String> properties;
- @Override
- public long getId() {
+ @Override public long getId() {
return id;
}
-
- @Override
- public String getEmail() {
+ @Override public String getEmail() {
return email;
}
-
- @Override
- public String getFirstName() {
- return firstName;
- }
-
- @Override
- public String getLastName() {
- return lastName;
- }
-
- @Override
- public String getAvatarUrl() {
- return avatarUrl;
- }
-
- @Override
- public boolean isAdmin() {
- return isAdmin;
- }
-
- @Override
- public String getExternalId() {
- return usrExtId;
- }
-
- @Override
- public Map<String, String> getProperties() {
+ @Override public String getFirstName() {
+ return firstName;
+}
+ @Override public String getLastName() {
+ return lastName;
+}
+ @Override public String getAvatarUrl() {
+ return avatarUrl;
+}
+ @Override public boolean isAdmin() {
+ return isAdmin;
+}
+ @Override public String getExternalId() {
+ return usrExtId;
+}
+ @Override public Map<String, String> getProperties() {
return properties;
}
}
diff --git a/src/main/java/org/apache/nlpcraft/client/impl/beans/NCUsersAllBean.java b/src/main/java/org/apache/nlpcraft/client/impl/beans/NCUsersAllBean.java
index c35bac1..3808dd3 100644
--- a/src/main/java/org/apache/nlpcraft/client/impl/beans/NCUsersAllBean.java
+++ b/src/main/java/org/apache/nlpcraft/client/impl/beans/NCUsersAllBean.java
@@ -27,9 +27,6 @@ import java.util.List;
public class NCUsersAllBean extends NCStatusResponseBean {
@SerializedName("users") private List<NCUserBean> users;
- /**
- * Gets the list of users.
- */
public List<NCUserBean> getUsers() {
return users;
}
diff --git a/src/main/java/org/apache/nlpcraft/client/package-info.java b/src/main/java/org/apache/nlpcraft/client/package-info.java
index 08c01cc..84eb8d9 100644
--- a/src/main/java/org/apache/nlpcraft/client/package-info.java
+++ b/src/main/java/org/apache/nlpcraft/client/package-info.java
@@ -19,5 +19,19 @@
* NLPCraft Java Client API - provides native wrapper for
* <a target=_ href="https://nlpcraft.apache.org/using-rest.html">REST APIs</a> for any JVM-based languages
* like Java, Scala, Kotlin or Groovy.
+ * <p>
+ * <b>Usage</b><br>
+ * Java client usage is straightforward - create client instance using {@link org.apache.nlpcraft.client.NCClientBuilder} and use the
+ * client instance for all API calls:
+ * <pre class="brush: java">
+ * // Get client instance with all defaults.
+ * NCClient cli = new NCClientBuilder().build();
+ *
+ * // Perform any necessary calls...
+ * NCResult res = cli.askSync("my.model.id", txt);
+ *
+ * // Close client & sign out at the end.
+ * cli.close();
+ * </pre>
*/
package org.apache.nlpcraft.client;
\ No newline at end of file