@sap/async-xsjs 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (178) hide show
  1. package/CHANGELOG.md +26 -0
  2. package/LICENSE +37 -0
  3. package/README.md +445 -0
  4. package/differences.md +162 -0
  5. package/docs/$.Application.html +262 -0
  6. package/docs/$.Session.html +674 -0
  7. package/docs/$.db.CallableStatement.html +2524 -0
  8. package/docs/$.db.Connection.html +511 -0
  9. package/docs/$.db.ParameterMetaData.html +805 -0
  10. package/docs/$.db.PreparedStatement.html +1796 -0
  11. package/docs/$.db.ResultSet.html +1308 -0
  12. package/docs/$.db.ResultSetMetaData.html +800 -0
  13. package/docs/$.db.SQLException.html +259 -0
  14. package/docs/$.db.html +773 -0
  15. package/docs/$.hdb.ColumnMetadata.html +438 -0
  16. package/docs/$.hdb.Connection.html +663 -0
  17. package/docs/$.hdb.ProcedureResult.html +280 -0
  18. package/docs/$.hdb.ResultSet.html +324 -0
  19. package/docs/$.hdb.ResultSetIterator.html +315 -0
  20. package/docs/$.hdb.ResultSetMetaData.html +259 -0
  21. package/docs/$.hdb.SQLException.html +259 -0
  22. package/docs/$.hdb.html +557 -0
  23. package/docs/$.html +471 -0
  24. package/docs/$.jobs.Job.html +783 -0
  25. package/docs/$.jobs.JobLog.html +380 -0
  26. package/docs/$.jobs.JobSchedules.html +852 -0
  27. package/docs/$.jobs.html +238 -0
  28. package/docs/$.net.Destination.html +304 -0
  29. package/docs/$.net.Mail.Part.html +510 -0
  30. package/docs/$.net.Mail.html +504 -0
  31. package/docs/$.net.SMTPConnection.html +347 -0
  32. package/docs/$.net.html +749 -0
  33. package/docs/$.net.http.Client.html +562 -0
  34. package/docs/$.net.http.Destination.html +237 -0
  35. package/docs/$.net.http.Request.html +567 -0
  36. package/docs/$.net.http.html +292 -0
  37. package/docs/$.security.AntiVirus.html +361 -0
  38. package/docs/$.security.Store.html +636 -0
  39. package/docs/$.security.crypto.html +414 -0
  40. package/docs/$.security.html +247 -0
  41. package/docs/$.security.x509.html +373 -0
  42. package/docs/$.text.analysis.Session.html +983 -0
  43. package/docs/$.text.analysis.html +242 -0
  44. package/docs/$.text.html +246 -0
  45. package/docs/$.text.mining.Session.html +2018 -0
  46. package/docs/$.text.mining.html +242 -0
  47. package/docs/$.trace.html +525 -0
  48. package/docs/$.util.SAXParser.html +955 -0
  49. package/docs/$.util.Zip.html +474 -0
  50. package/docs/$.util.codec.html +414 -0
  51. package/docs/$.util.compression.html +357 -0
  52. package/docs/$.util.html +325 -0
  53. package/docs/$.util.sql.html +290 -0
  54. package/docs/$.web.Body.html +333 -0
  55. package/docs/$.web.EntityList.html +296 -0
  56. package/docs/$.web.TupelList.html +496 -0
  57. package/docs/$.web.WebEntityRequest.html +393 -0
  58. package/docs/$.web.WebEntityResponse.html +392 -0
  59. package/docs/$.web.WebRequest.html +560 -0
  60. package/docs/$.web.WebResponse.html +609 -0
  61. package/docs/$.web.html +246 -0
  62. package/docs/Copyright-SAP.html +39 -0
  63. package/docs/Disclaimer-SAP.html +55 -0
  64. package/docs/index.html +232 -0
  65. package/docs/styles/jsdoc-default.css +382 -0
  66. package/lib/AppConfig.js +36 -0
  67. package/lib/AuditLogger.js +41 -0
  68. package/lib/cacert.js +26 -0
  69. package/lib/ctypes.js +153 -0
  70. package/lib/destinations/dest-provider.js +57 -0
  71. package/lib/index.js +235 -0
  72. package/lib/jobs/Action.js +40 -0
  73. package/lib/jobs/Job.js +100 -0
  74. package/lib/jobs/JobManager.js +150 -0
  75. package/lib/jobs/JobsRuntime.js +133 -0
  76. package/lib/jobs/SqlScriptJobRunner.js +36 -0
  77. package/lib/jobs/XsjsJobRunner.js +78 -0
  78. package/lib/jobs/index.js +11 -0
  79. package/lib/logging.js +16 -0
  80. package/lib/middleware.js +125 -0
  81. package/lib/odata/ODataService.js +125 -0
  82. package/lib/odata/index.js +7 -0
  83. package/lib/odata/service-factory.js +26 -0
  84. package/lib/passport-noauth.js +17 -0
  85. package/lib/routes.js +115 -0
  86. package/lib/runtime.js +740 -0
  87. package/lib/sandbox.js +40 -0
  88. package/lib/utils/XsJsFunctionRunner.js +57 -0
  89. package/lib/utils/XsJsLibFunctionRunner.js +57 -0
  90. package/lib/utils/buffer-utils.js +77 -0
  91. package/lib/utils/compression-utils.js +14 -0
  92. package/lib/utils/date-utils.js +104 -0
  93. package/lib/utils/errors/HttpError.js +20 -0
  94. package/lib/utils/errors/wrap-app-error.js +18 -0
  95. package/lib/utils/index.js +17 -0
  96. package/lib/utils/xs-function-runner.js +51 -0
  97. package/lib/utils/xs-types.js +21 -0
  98. package/lib/utils/xspath.js +36 -0
  99. package/lib/utils/xsstack.js +28 -0
  100. package/lib/views/error.html +28 -0
  101. package/lib/xsjs/Application.js +28 -0
  102. package/lib/xsjs/Locale.js +53 -0
  103. package/lib/xsjs/Session.js +31 -0
  104. package/lib/xsjs/constants.js +71 -0
  105. package/lib/xsjs/db/common/DbBase.js +85 -0
  106. package/lib/xsjs/db/common/DbOptions.js +163 -0
  107. package/lib/xsjs/db/common/arguments-validation.js +102 -0
  108. package/lib/xsjs/db/common/connection.js +12 -0
  109. package/lib/xsjs/db/common/enums.js +93 -0
  110. package/lib/xsjs/db/common/execute-batch.js +38 -0
  111. package/lib/xsjs/db/common/parse-time.js +139 -0
  112. package/lib/xsjs/db/dbapi/CallableStatement.js +192 -0
  113. package/lib/xsjs/db/dbapi/Connection.js +78 -0
  114. package/lib/xsjs/db/dbapi/DB.js +39 -0
  115. package/lib/xsjs/db/dbapi/ParameterMetaData.js +118 -0
  116. package/lib/xsjs/db/dbapi/PreparedStatement.js +78 -0
  117. package/lib/xsjs/db/dbapi/ResultSet.js +220 -0
  118. package/lib/xsjs/db/dbapi/ResultSetMetaData.js +116 -0
  119. package/lib/xsjs/db/dbapi/Statement.js +514 -0
  120. package/lib/xsjs/db/dbapi/conversions.js +113 -0
  121. package/lib/xsjs/db/dbapi/fetch-rows.js +32 -0
  122. package/lib/xsjs/db/hdbapi/Connection.js +525 -0
  123. package/lib/xsjs/db/hdbapi/HDB.js +32 -0
  124. package/lib/xsjs/db/hdbapi/ResultSetIterator.js +40 -0
  125. package/lib/xsjs/db/hdbapi/convert.js +77 -0
  126. package/lib/xsjs/db/hdbapi/table-string-parser.js +52 -0
  127. package/lib/xsjs/db/index.js +4 -0
  128. package/lib/xsjs/index.js +13 -0
  129. package/lib/xsjs/jobs/Job.js +228 -0
  130. package/lib/xsjs/jobs/Jobs.js +11 -0
  131. package/lib/xsjs/jobs/Logs.js +127 -0
  132. package/lib/xsjs/jobs/Schedule.js +110 -0
  133. package/lib/xsjs/jobs/Schedules.js +108 -0
  134. package/lib/xsjs/net/Destination.js +43 -0
  135. package/lib/xsjs/net/http/Client.js +220 -0
  136. package/lib/xsjs/net/http/HTTP.js +72 -0
  137. package/lib/xsjs/net/index.js +5 -0
  138. package/lib/xsjs/net/smtp/Mail.js +38 -0
  139. package/lib/xsjs/net/smtp/Part.js +30 -0
  140. package/lib/xsjs/net/smtp/SMTPConnection.js +39 -0
  141. package/lib/xsjs/net/smtp/index.js +18 -0
  142. package/lib/xsjs/net/smtp/nodemailer-util.js +77 -0
  143. package/lib/xsjs/require.js +39 -0
  144. package/lib/xsjs/security/AntiVirus.js +31 -0
  145. package/lib/xsjs/security/Store.js +119 -0
  146. package/lib/xsjs/security/crypto.js +23 -0
  147. package/lib/xsjs/security/index.js +5 -0
  148. package/lib/xsjs/security/x509.js +12 -0
  149. package/lib/xsjs/text/analysis/Session.js +128 -0
  150. package/lib/xsjs/text/index.js +30 -0
  151. package/lib/xsjs/text/mining/Session.js +82 -0
  152. package/lib/xsjs/trace/trace.js +41 -0
  153. package/lib/xsjs/util/SAXParser.js +174 -0
  154. package/lib/xsjs/util/Zip.js +220 -0
  155. package/lib/xsjs/util/codec.js +33 -0
  156. package/lib/xsjs/util/compression.js +24 -0
  157. package/lib/xsjs/util/index.js +22 -0
  158. package/lib/xsjs/web/BasicWebEntity.js +41 -0
  159. package/lib/xsjs/web/EntityList.js +11 -0
  160. package/lib/xsjs/web/TupelLists/CookiesTupelList.js +47 -0
  161. package/lib/xsjs/web/TupelLists/HeadersTupelList.js +55 -0
  162. package/lib/xsjs/web/TupelLists/ParametersTupelList.js +83 -0
  163. package/lib/xsjs/web/TupelLists/TupelListBase.js +45 -0
  164. package/lib/xsjs/web/WebBody.js +135 -0
  165. package/lib/xsjs/web/WebEntityRequest.js +40 -0
  166. package/lib/xsjs/web/WebEntityResponse.js +26 -0
  167. package/lib/xsjs/web/WebRequest.js +209 -0
  168. package/lib/xsjs/web/WebResponse.js +183 -0
  169. package/lib/xsjs/web/index.js +4 -0
  170. package/lib/xsjs/web/utils/HeadersParser.js +53 -0
  171. package/lib/xsjs/web/utils/HttpRequestParser.js +93 -0
  172. package/lib/xsjs/web/utils/MultipartParser.js +163 -0
  173. package/lib/xsjs/web/utils/MultipartResponseBuilder.js +73 -0
  174. package/lib/xsjs/web/utils/SetCookieParser.js +32 -0
  175. package/lib/xsjslib/TextBundleWrapper.js +46 -0
  176. package/lib/xsjslib/index.js +11 -0
  177. package/npm-shrinkwrap.json +11540 -0
  178. package/package.json +84 -0
package/docs/$.text.analysis.Session.html ADDED
@@ -0,0 +1,983 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+
4
+ <head>
5
+ <meta charset="utf-8">
6
+ <title>JSDoc: Class: Session</title>
7
+ <script src="scripts/prettify/prettify.js"></script>
8
+ <script src="scripts/prettify/lang-css.js"></script>
9
+ <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
10
+
11
+
12
+ <script src="scripts/launch-8b3c5ca29b9e.min.js"></script>
13
+ <script src="scripts/highlight.js"></script>
14
+ <link rel="canonical" href="$.text.analysis.Session.html">
15
+ </head>
16
+ <body>
17
+ <div id="main">
18
+ <h1 class="page-title">Class: Session</h1>
19
+ <section>
20
+ <header>
21
+ <h2>
22
+ <span class="ancestors"><a href="$.html">$</a><a href="$.text.html">.text</a><a
23
+ href="$.text.analysis.html">.analysis</a>.</span>
24
+ Session
25
+ </h2>
26
+ <div class="class-description">$.text.analysis.Session represents a Text Analysis session.
27
+ <p class="message warning"><b>Caution</b><br>
28
+ The information in this section applies to a feature that is included in the component
29
+ SAP HANA Advanced Data Processing. To make use of this feature, you must have purchased a license
30
+ to use SAP HANA Advanced Data Processing.
31
+ </p></div>
32
+ </header>
33
+ <article>
34
+ <div class="container-overview">
35
+ <dt>
36
+ <h4 class="name" id="Session"><span class="type-signature"></span>new Session<span
37
+ class="signature">(p)</span><span class="type-signature"> &rarr; {<a
38
+ href="$.text.analysis.Session.html">$.text.analysis.Session</a>}</span></h4>
39
+ </dt>
40
+ <dd>
41
+ <div class="description">
42
+ The Session object represents a Text Analysis session.
43
+ <p>
44
+ This constructor function creates a Text Analysis session object.
45
+ Text Analysis functions can subsequently be invoked using this object and they will use
46
+ the configuration it was initialized with.
47
+ </p>
48
+ </div>
49
+ <h5>Parameters:</h5>
50
+ <table class="params">
51
+ <thead>
52
+ <tr>
53
+ <th>Name</th>
54
+ <th>Type</th>
55
+ <th class="last">Description</th>
56
+ </tr>
57
+ </thead>
58
+ <tbody>
59
+ <tr>
60
+ <td class="name"><code>p</code></td>
61
+ <td class="type">
62
+ <span class="param-type">object</span>
63
+ </td>
64
+ <td class="description last">Encapsulates constructor parameters.
65
+ <h6>Properties</h6>
66
+ <table class="params">
67
+ <thead>
68
+ <tr>
69
+ <th>Name</th>
70
+ <th>Type</th>
71
+ <th class="last">Description</th>
72
+ </tr>
73
+ </thead>
74
+ <tbody>
75
+ <tr>
76
+ <td class="name"><code>configuration</code></td>
77
+ <td class="type">
78
+ <span class="param-type">string</span>
79
+ </td>
80
+ <td class="description last">Name of (or, generally, a Repository path to) a
81
+ Text Analysis configuration object.
82
+ All subsequent operations on the session will assume this configuration.
83
+ The default path is sap.hana.ta.config
84
+ </td>
85
+ </tr>
86
+ </tbody>
87
+ </table>
88
+ </td>
89
+ </tr>
90
+ </tbody>
91
+ </table>
92
+ <dl class="details">
93
+ </dl>
94
+ <h5>Returns:</h5>
95
+ <div class="param-desc">
96
+ A Text Analysis session object that holds context for the session
97
+ and is used to call the Text Analysis method functions.
98
+ </div>
99
+ <dl>
100
+ <dt>
101
+ Type
102
+ </dt>
103
+ <dd>
104
+ <span class="param-type"><a href="$.text.analysis.Session.html">$.text.analysis.Session</a></span>
105
+ </dd>
106
+ </dl>
107
+ <h5>Example</h5>
108
+ <pre class="prettyprint"><code>var TA = new $.text.analysis.Session({
109
+ configuration: 'sap.hana.ta.config::LINGANALYSIS_FULL.hdbtextconfig'
110
+ });</code></pre>
111
+ </dd>
112
+ </div>
113
+ <h3 class="subsection-title">Methods</h3>
114
+ <dl>
115
+ <dt>
116
+ <h4 class="name" id="analyze"><span class="type-signature">async </span>analyze<span
117
+ class="signature">(p)</span><span class="type-signature"> &rarr; {<a
118
+ href="$.text.analysis.Session.html#AnalyzeResult">$.text.analysis.Session~AnalyzeResult</a>}</span>
119
+ </h4>
120
+ </dt>
121
+ <dd>
122
+ <div class="description">
123
+ This function performs text analysis of the given input document.
124
+ </div>
125
+ <h5>Parameters:</h5>
126
+ <table class="params">
127
+ <thead>
128
+ <tr>
129
+ <th>Name</th>
130
+ <th>Type</th>
131
+ <th class="last">Description</th>
132
+ </tr>
133
+ </thead>
134
+ <tbody>
135
+ <tr>
136
+ <td class="name"><code>p</code></td>
137
+ <td class="type">
138
+ <span class="param-type">object</span>
139
+ </td>
140
+ <td class="description last">Encapsulates analyze parameters.
141
+ <h6>Properties</h6>
142
+ <table class="params">
143
+ <thead>
144
+ <tr>
145
+ <th>Name</th>
146
+ <th>Type</th>
147
+ <th>Argument</th>
148
+ <th class="last">Description</th>
149
+ </tr>
150
+ </thead>
151
+ <tbody>
152
+ <tr>
153
+ <td class="name"><code>inputDocumentText|<br/>inputDocumentBinaryContent</code>
154
+ </td>
155
+ <td class="type">
156
+ <span class="param-type">string</span>
157
+ |
158
+ <span class="param-type">ArrayBuffer</span>
159
+ </td>
160
+ <td class="attributes">
161
+ </td>
162
+ <td class="description last">Input document to process. One and only one of the
163
+ following:
164
+ <table>
165
+ <tr>
166
+ <td>inputDocumentText</td>
167
+ <td>The literal text of the document (type: string). Supported
168
+ formats are:
169
+ plain text, html and xml.
170
+ </td>
171
+ </tr>
172
+ <tr>
173
+ <td>inputDocumentBinaryContent</td>
174
+ <td>The document to be processed in the original format (type:
175
+ ArrayBuffer).
176
+ </td>
177
+ </tr>
178
+ </table>
179
+ </td>
180
+ </tr>
181
+ <tr>
182
+ <td class="name"><code>language</code></td>
183
+ <td class="type">
184
+ <span class="param-type">string</span>
185
+ </td>
186
+ <td class="attributes">
187
+ &lt;optional><br>
188
+ </td>
189
+ <td class="description last">Language code of input text. Available languages
190
+ are listed
191
+ in SYS.M_TEXT_ANALYSIS_LANGUAGES view.
192
+ </td>
193
+ </tr>
194
+ <tr>
195
+ <td class="name"><code>mimeType</code></td>
196
+ <td class="type">
197
+ <span class="param-type">string</span>
198
+ </td>
199
+ <td class="attributes">
200
+ &lt;optional><br>
201
+ </td>
202
+ <td class="description last">Mime type of input text. Available mime types are
203
+ listed
204
+ in SYS.M_TEXT_ANALYSIS_MIME_TYPES view.
205
+ </td>
206
+ </tr>
207
+ <tr>
208
+ <td class="name"><code>includePlainText</code></td>
209
+ <td class="type">
210
+ <span class="param-type">boolen</span>
211
+ </td>
212
+ <td class="attributes">
213
+ &lt;optional><br>
214
+ </td>
215
+ <td class="description last">If true, the result will contain the 'plainText'
216
+ property with the plain text output.
217
+ By default, false.
218
+ </td>
219
+ </tr>
220
+ <tr>
221
+ <td class="name"><code>tokenSeparators</code></td>
222
+ <td class="type">
223
+ <span class="param-type">string</span>
224
+ </td>
225
+ <td class="attributes">
226
+ &lt;optional><br>
227
+ </td>
228
+ <td class="description last">A set of additional characters used for token
229
+ separation.
230
+ Only ASCII characters are considered. By default, empty string.
231
+ </td>
232
+ </tr>
233
+ <tr>
234
+ <td class="name"><code>languageDetection</code></td>
235
+ <td class="type">
236
+ <span class="param-type">Array.&lt;string></span>
237
+ </td>
238
+ <td class="attributes">
239
+ &lt;optional><br>
240
+ </td>
241
+ <td class="description last">The set of languages to be used for automatic
242
+ language detection.
243
+ Available languages are listed in SYS.M_TEXT_ANALYSIS_LANGUAGES view.
244
+ </td>
245
+ </tr>
246
+ </tbody>
247
+ </table>
248
+ </td>
249
+ </tr>
250
+ </tbody>
251
+ </table>
252
+ <dl class="details">
253
+ </dl>
254
+ <h5>Throws:</h5>
255
+ <div class="param-desc">
256
+ Throws an error if the parameters object is not valid or the execution fails.
257
+ </div>
258
+ <h5>Returns:</h5>
259
+ <div class="param-desc">
260
+ AnalyzeResult object.
261
+ </div>
262
+ <dl>
263
+ <dt>
264
+ Type
265
+ </dt>
266
+ <dd>
267
+ <span class="param-type"><a href="$.text.analysis.Session.html#AnalyzeResult">$.text.analysis.Session~AnalyzeResult</a></span>
268
+ </dd>
269
+ </dl>
270
+ <h5>Example</h5>
271
+ <pre class="prettyprint"><code>var taResult = <b>await </b>TA.analyze({
272
+ inputDocumentText: 'This is a sample sentence.'
273
+ });</code></pre>
274
+ </dd>
275
+ </dl>
276
+ <h3 class="subsection-title">Type Definitions</h3>
277
+ <dl>
278
+ <dt>
279
+ <h4 class="name" id="AnalyzeResult">AnalyzeResult</h4>
280
+ </dt>
281
+ <dd>
282
+ <div class="description">
283
+ Represents a result from a call to the Text Analysis Session analyze() method
284
+ </div>
285
+ <h5>Type:</h5>
286
+ <ul>
287
+ <li>
288
+ <span class="param-type">object</span>
289
+ </li>
290
+ </ul>
291
+ <dl class="details">
292
+ <h5 class="subsection-title">Properties:</h5>
293
+ <dl>
294
+ <table class="props">
295
+ <thead>
296
+ <tr>
297
+ <th>Name</th>
298
+ <th>Type</th>
299
+ <th>Argument</th>
300
+ <th class="last">Description</th>
301
+ </tr>
302
+ </thead>
303
+ <tbody>
304
+ <tr>
305
+ <td class="name"><code>language</code></td>
306
+ <td class="type">
307
+ <span class="param-type">string</span>
308
+ </td>
309
+ <td class="attributes">
310
+ </td>
311
+ <td class="description last">Language code of the input document.</td>
312
+ </tr>
313
+ <tr>
314
+ <td class="name"><code>mimeType</code></td>
315
+ <td class="type">
316
+ <span class="param-type">string</span>
317
+ </td>
318
+ <td class="attributes">
319
+ </td>
320
+ <td class="description last">Mime type of the input document.</td>
321
+ </tr>
322
+ <tr>
323
+ <td class="name"><code>textSize</code></td>
324
+ <td class="type">
325
+ <span class="param-type">integer</span>
326
+ </td>
327
+ <td class="attributes">
328
+ </td>
329
+ <td class="description last">Size of the input document in code units.</td>
330
+ </tr>
331
+ <tr>
332
+ <td class="name"><code>plainText</code></td>
333
+ <td class="type">
334
+ <span class="param-type">string</span>
335
+ </td>
336
+ <td class="attributes">
337
+ &lt;optional><br>
338
+ </td>
339
+ <td class="description last">Plain text extracted from the document. Present only if
340
+ includePlainText was specified in a call to analyze.
341
+ </td>
342
+ </tr>
343
+ <tr>
344
+ <td class="name"><code>tokens</code></td>
345
+ <td class="type">
346
+ <span class="param-type">Array.&lt;<a href="$.text.analysis.Session.html#Token">$.text.analysis.Session~Token</a>></span>
347
+ </td>
348
+ <td class="attributes">
349
+ </td>
350
+ <td class="description last">Tokens from the input document.</td>
351
+ </tr>
352
+ <tr>
353
+ <td class="name"><code>entities</code></td>
354
+ <td class="type">
355
+ <span class="param-type">Array.&lt;<a
356
+ href="$.text.analysis.Session.html#Entity">$.text.analysis.Session~Entity</a>></span>
357
+ </td>
358
+ <td class="attributes">
359
+ </td>
360
+ <td class="description last">Named entities from the input document.</td>
361
+ </tr>
362
+ <tr>
363
+ <td class="name"><code>metadata</code></td>
364
+ <td class="type">
365
+ <span class="param-type">Array.&lt;<a href="$.text.analysis.Session.html#Meta">$.text.analysis.Session~Meta</a>></span>
366
+ </td>
367
+ <td class="attributes">
368
+ </td>
369
+ <td class="description last">document metadata from the input document.</td>
370
+ </tr>
371
+ <tr>
372
+ <td class="name"><code>grammaticalRoles</code></td>
373
+ <td class="type">
374
+ <span class="param-type">Array.&lt;<a
375
+ href="$.text.analysis.Session.html#GrammaticalRoles">$.text.analysis.Session~GrammaticalRoles</a>></span>
376
+ </td>
377
+ <td class="attributes">
378
+ </td>
379
+ <td class="description last">grammatical role dependents from the input document.
380
+ </td>
381
+ </tr>
382
+ </tbody>
383
+ </table>
384
+ </dl>
385
+ </dl>
386
+ </dd>
387
+ <dt>
388
+ <h4 class="name" id="Entity">Entity</h4>
389
+ </dt>
390
+ <dd>
391
+ <div class="description">
392
+ Represents a named entity retrieved from a call to the Text Analysis Session analyze() method
393
+ </div>
394
+ <h5>Type:</h5>
395
+ <ul>
396
+ <li>
397
+ <span class="param-type">object</span>
398
+ </li>
399
+ </ul>
400
+ <dl class="details">
401
+ <h5 class="subsection-title">Properties:</h5>
402
+ <dl>
403
+ <table class="props">
404
+ <thead>
405
+ <tr>
406
+ <th>Name</th>
407
+ <th>Type</th>
408
+ <th>Argument</th>
409
+ <th class="last">Description</th>
410
+ </tr>
411
+ </thead>
412
+ <tbody>
413
+ <tr>
414
+ <td class="name"><code>id</code></td>
415
+ <td class="type">
416
+ <span class="param-type">integer</span>
417
+ </td>
418
+ <td class="attributes">
419
+ </td>
420
+ <td class="description last">A unique identification number for the entity within
421
+ the result set.
422
+ </td>
423
+ </tr>
424
+ <tr>
425
+ <td class="name"><code>text</code></td>
426
+ <td class="type">
427
+ <span class="param-type">string</span>
428
+ </td>
429
+ <td class="attributes">
430
+ </td>
431
+ <td class="description last">Text of the entity.</td>
432
+ </tr>
433
+ <tr>
434
+ <td class="name"><code>normalizedForm</code></td>
435
+ <td class="type">
436
+ <span class="param-type">string</span>
437
+ </td>
438
+ <td class="attributes">
439
+ </td>
440
+ <td class="description last">Normalized text of the entity.</td>
441
+ </tr>
442
+ <tr>
443
+ <td class="name"><code>label</code></td>
444
+ <td class="type">
445
+ <span class="param-type">string</span>
446
+ </td>
447
+ <td class="attributes">
448
+ </td>
449
+ <td class="description last">Label of the entity.</td>
450
+ </tr>
451
+ <tr>
452
+ <td class="name"><code>labelPath</code></td>
453
+ <td class="type">
454
+ <span class="param-type">string</span>
455
+ </td>
456
+ <td class="attributes">
457
+ </td>
458
+ <td class="description last">Label path of the entity.</td>
459
+ </tr>
460
+ <tr>
461
+ <td class="name"><code>offset</code></td>
462
+ <td class="type">
463
+ <span class="param-type">integer</span>
464
+ </td>
465
+ <td class="attributes">
466
+ </td>
467
+ <td class="description last">Offset of the entity.</td>
468
+ </tr>
469
+ <tr>
470
+ <td class="name"><code>parent</code></td>
471
+ <td class="type">
472
+ <span class="param-type">integer</span>
473
+ </td>
474
+ <td class="attributes">
475
+ &lt;optional><br>
476
+ </td>
477
+ <td class="description last">id of the parent entity, if exists.</td>
478
+ </tr>
479
+ <tr>
480
+ <td class="name"><code>paragraph</code></td>
481
+ <td class="type">
482
+ <span class="param-type">integer</span>
483
+ </td>
484
+ <td class="attributes">
485
+ </td>
486
+ <td class="description last">Paragraph of the entity.</td>
487
+ </tr>
488
+ <tr>
489
+ <td class="name"><code>sentence</code></td>
490
+ <td class="type">
491
+ <span class="param-type">integer</span>
492
+ </td>
493
+ <td class="attributes">
494
+ </td>
495
+ <td class="description last">Sentence of the entity.</td>
496
+ </tr>
497
+ </tbody>
498
+ </table>
499
+ </dl>
500
+ </dl>
501
+ </dd>
502
+ <dt>
503
+ <h4 class="name" id="GrammaticalRoleGovernor">GrammaticalRoleGovernor</h4>
504
+ </dt>
505
+ <dd>
506
+ <div class="description">
507
+ Represents an object containing the dependency information of a component in a grammatical role
508
+ relationship
509
+ </div>
510
+ <h5>Type:</h5>
511
+ <ul>
512
+ <li>
513
+ <span class="param-type">object</span>
514
+ </li>
515
+ </ul>
516
+ <dl class="details">
517
+ <h5 class="subsection-title">Properties:</h5>
518
+ <dl>
519
+ <table class="props">
520
+ <thead>
521
+ <tr>
522
+ <th>Name</th>
523
+ <th>Type</th>
524
+ <th class="last">Description</th>
525
+ </tr>
526
+ </thead>
527
+ <tbody>
528
+ <tr>
529
+ <td class="name"><code>id</code></td>
530
+ <td class="type">
531
+ <span class="param-type">integer</span>
532
+ </td>
533
+ <td class="description last">A unique id number of the governor, if the current
534
+ component is a dependent. Otherwise, -1.
535
+ </td>
536
+ </tr>
537
+ <tr>
538
+ <td class="name"><code>type</code></td>
539
+ <td class="type">
540
+ <span class="param-type">string</span>
541
+ </td>
542
+ <td class="description last">Type of grammatical role relationship, or "MainVerb" +
543
+ voicing of the verb, if the current component is a governor.
544
+ </td>
545
+ </tr>
546
+ </tbody>
547
+ </table>
548
+ </dl>
549
+ </dl>
550
+ </dd>
551
+ <dt>
552
+ <h4 class="name" id="GrammaticalRoles">GrammaticalRoles</h4>
553
+ </dt>
554
+ <dd>
555
+ <div class="description">
556
+ Represents a component of a grammatical role relationship, retrieved from a call to the Text
557
+ Analysis Session analyze() method
558
+ </div>
559
+ <h5>Type:</h5>
560
+ <ul>
561
+ <li>
562
+ <span class="param-type">object</span>
563
+ </li>
564
+ </ul>
565
+ <dl class="details">
566
+ <h5 class="subsection-title">Properties:</h5>
567
+ <dl>
568
+ <table class="props">
569
+ <thead>
570
+ <tr>
571
+ <th>Name</th>
572
+ <th>Type</th>
573
+ <th class="last">Description</th>
574
+ </tr>
575
+ </thead>
576
+ <tbody>
577
+ <tr>
578
+ <td class="name"><code>id</code></td>
579
+ <td class="type">
580
+ <span class="param-type">integer</span>
581
+ </td>
582
+ <td class="description last">A unique identification number for the component.</td>
583
+ </tr>
584
+ <tr>
585
+ <td class="name"><code>paragraph</code></td>
586
+ <td class="type">
587
+ <span class="param-type">integer</span>
588
+ </td>
589
+ <td class="description last">Paragraph of the component.</td>
590
+ </tr>
591
+ <tr>
592
+ <td class="name"><code>sentence</code></td>
593
+ <td class="type">
594
+ <span class="param-type">integer</span>
595
+ </td>
596
+ <td class="description last">Sentence of the component.</td>
597
+ </tr>
598
+ <tr>
599
+ <td class="name"><code>offset</code></td>
600
+ <td class="type">
601
+ <span class="param-type">integer</span>
602
+ </td>
603
+ <td class="description last">Offset of the component.</td>
604
+ </tr>
605
+ <tr>
606
+ <td class="name"><code>text</code></td>
607
+ <td class="type">
608
+ <span class="param-type">string</span>
609
+ </td>
610
+ <td class="description last">Text of the component.</td>
611
+ </tr>
612
+ <tr>
613
+ <td class="name"><code>governors</code></td>
614
+ <td class="type">
615
+ <span class="param-type">Array.&lt;<a
616
+ href="$.text.analysis.Session.html#GrammaticalRoleGovernor">$.text.analysis.Session~GrammaticalRoleGovernor</a>></span>
617
+ </td>
618
+ <td class="description last">array of objects each containing the id of the governor
619
+ in the relationship and the dependency type
620
+ </td>
621
+ </tr>
622
+ </tbody>
623
+ </table>
624
+ </dl>
625
+ </dl>
626
+ </dd>
627
+ <dt>
628
+ <h4 class="name" id="Meta">Meta</h4>
629
+ </dt>
630
+ <dd>
631
+ <div class="description">
632
+ Represents a document meta information retrieved from a call to the Text Analysis Session
633
+ analyze() method
634
+ </div>
635
+ <h5>Type:</h5>
636
+ <ul>
637
+ <li>
638
+ <span class="param-type">object</span>
639
+ </li>
640
+ </ul>
641
+ <dl class="details">
642
+ <h5 class="subsection-title">Properties:</h5>
643
+ <dl>
644
+ <table class="props">
645
+ <thead>
646
+ <tr>
647
+ <th>Name</th>
648
+ <th>Type</th>
649
+ <th>Argument</th>
650
+ <th class="last">Description</th>
651
+ </tr>
652
+ </thead>
653
+ <tbody>
654
+ <tr>
655
+ <td class="name"><code>id</code></td>
656
+ <td class="type">
657
+ <span class="param-type">integer</span>
658
+ </td>
659
+ <td class="attributes">
660
+ </td>
661
+ <td class="description last">A unique identification number for the meta information
662
+ within the result set.
663
+ </td>
664
+ </tr>
665
+ <tr>
666
+ <td class="name"><code>token</code></td>
667
+ <td class="type">
668
+ <span class="param-type">string</span>
669
+ </td>
670
+ <td class="attributes">
671
+ </td>
672
+ <td class="description last">Text of the meta information.</td>
673
+ </tr>
674
+ <tr>
675
+ <td class="name"><code>tokenType</code></td>
676
+ <td class="type">
677
+ <span class="param-type">string</span>
678
+ </td>
679
+ <td class="attributes">
680
+ </td>
681
+ <td class="description last">Type of the meta information.</td>
682
+ </tr>
683
+ <tr>
684
+ <td class="name"><code>offset</code></td>
685
+ <td class="type">
686
+ <span class="param-type">integer</span>
687
+ </td>
688
+ <td class="attributes">
689
+ </td>
690
+ <td class="description last">Offset of the entity.</td>
691
+ </tr>
692
+ <tr>
693
+ <td class="name"><code>parent</code></td>
694
+ <td class="type">
695
+ <span class="param-type">integer</span>
696
+ </td>
697
+ <td class="attributes">
698
+ &lt;optional><br>
699
+ </td>
700
+ <td class="description last">id of the parent entity, if exists.</td>
701
+ </tr>
702
+ </tbody>
703
+ </table>
704
+ </dl>
705
+ </dl>
706
+ </dd>
707
+ <dt>
708
+ <h4 class="name" id="Token">Token</h4>
709
+ </dt>
710
+ <dd>
711
+ <div class="description">
712
+ Represents a token retrieved from a call to the Text Analysis Session analyze() method
713
+ </div>
714
+ <h5>Type:</h5>
715
+ <ul>
716
+ <li>
717
+ <span class="param-type">object</span>
718
+ </li>
719
+ </ul>
720
+ <dl class="details">
721
+ <h5 class="subsection-title">Properties:</h5>
722
+ <dl>
723
+ <table class="props">
724
+ <thead>
725
+ <tr>
726
+ <th>Name</th>
727
+ <th>Type</th>
728
+ <th class="last">Description</th>
729
+ </tr>
730
+ </thead>
731
+ <tbody>
732
+ <tr>
733
+ <td class="name"><code>token</code></td>
734
+ <td class="type">
735
+ <span class="param-type">string</span>
736
+ </td>
737
+ <td class="description last">Text of the token.</td>
738
+ </tr>
739
+ <tr>
740
+ <td class="name"><code>normalizedToken</code></td>
741
+ <td class="type">
742
+ <span class="param-type">string</span>
743
+ </td>
744
+ <td class="description last">Normalized text of the token.</td>
745
+ </tr>
746
+ <tr>
747
+ <td class="name"><code>partOfSpeech</code></td>
748
+ <td class="type">
749
+ <span class="param-type">string</span>
750
+ </td>
751
+ <td class="description last">Part of speech of the token.</td>
752
+ </tr>
753
+ <tr>
754
+ <td class="name"><code>offset</code></td>
755
+ <td class="type">
756
+ <span class="param-type">integer</span>
757
+ </td>
758
+ <td class="description last">Offset of the token.</td>
759
+ </tr>
760
+ <tr>
761
+ <td class="name"><code>paragraph</code></td>
762
+ <td class="type">
763
+ <span class="param-type">integer</span>
764
+ </td>
765
+ <td class="description last">Paragraph of the token.</td>
766
+ </tr>
767
+ <tr>
768
+ <td class="name"><code>sentence</code></td>
769
+ <td class="type">
770
+ <span class="param-type">integer</span>
771
+ </td>
772
+ <td class="description last">Sentence of the token.</td>
773
+ </tr>
774
+ <tr>
775
+ <td class="name"><code>stems</code></td>
776
+ <td class="type">
777
+ <span class="param-type">Array.&lt;string></span>
778
+ </td>
779
+ <td class="description last">Stems for the token.</td>
780
+ </tr>
781
+ </tbody>
782
+ </table>
783
+ </dl>
784
+ </dl>
785
+ </dd>
786
+ </dl>
787
+ </article>
788
+ </section>
789
+ </div>
790
+ <nav>
791
+ <h2><a href="index.html">Index</a></h2>
792
+ <h3>Classes</h3>
793
+ <table>
794
+ <tr>
795
+ <td><a href="$.security.AntiVirus.html">AntiVirus</a></td>
796
+ <td class="oblique">$.security</td>
797
+ </tr>
798
+ <tr>
799
+ <td><a href="$.Application.html">Application</a></td>
800
+ <td class="oblique">$</td>
801
+ </tr>
802
+ <tr>
803
+ <td><a href="$.web.Body.html">Body</a></td>
804
+ <td class="oblique">$.web</td>
805
+ </tr>
806
+ <tr>
807
+ <td><a href="$.db.CallableStatement.html">CallableStatement</a></td>
808
+ <td class="oblique">$.db</td>
809
+ </tr>
810
+ <tr>
811
+ <td><a href="$.net.http.Client.html">Client</a></td>
812
+ <td class="oblique">$.net.http</td>
813
+ </tr>
814
+ <tr>
815
+ <td><a href="$.hdb.ColumnMetadata.html">ColumnMetadata</a></td>
816
+ <td class="oblique">$.hdb</td>
817
+ </tr>
818
+ <tr>
819
+ <td><a href="$.db.Connection.html">Connection</a></td>
820
+ <td class="oblique">$.db</td>
821
+ </tr>
822
+ <tr>
823
+ <td><a href="$.hdb.Connection.html">Connection</a></td>
824
+ <td class="oblique">$.hdb</td>
825
+ </tr>
826
+ <tr>
827
+ <td><a href="$.net.Destination.html">Destination</a></td>
828
+ <td class="oblique">$.net</td>
829
+ </tr>
830
+ <tr>
831
+ <td><a href="$.net.http.Destination.html">Destination</a></td>
832
+ <td class="oblique">$.net.http</td>
833
+ </tr>
834
+ <tr>
835
+ <td><a href="$.web.EntityList.html">EntityList</a></td>
836
+ <td class="oblique">$.web</td>
837
+ </tr>
838
+ <tr>
839
+ <td><a href="$.jobs.Job.html">Job</a></td>
840
+ <td class="oblique">$.jobs</td>
841
+ </tr>
842
+ <tr>
843
+ <td><a href="$.jobs.JobLog.html">JobLog</a></td>
844
+ <td class="oblique">$.jobs</td>
845
+ </tr>
846
+ <tr>
847
+ <td><a href="$.jobs.JobSchedules.html">JobSchedules</a></td>
848
+ <td class="oblique">$.jobs</td>
849
+ </tr>
850
+ <tr>
851
+ <td><a href="$.net.Mail.html">Mail</a></td>
852
+ <td class="oblique">$.net</td>
853
+ </tr>
854
+ <tr>
855
+ <td><a href="$.db.ParameterMetaData.html">ParameterMetaData</a></td>
856
+ <td class="oblique">$.db</td>
857
+ </tr>
858
+ <tr>
859
+ <td><a href="$.net.Mail.Part.html">Part</a></td>
860
+ <td class="oblique">$.net.Mail</td>
861
+ </tr>
862
+ <tr>
863
+ <td><a href="$.db.PreparedStatement.html">PreparedStatement</a></td>
864
+ <td class="oblique">$.db</td>
865
+ </tr>
866
+ <tr>
867
+ <td><a href="$.hdb.ProcedureResult.html">ProcedureResult</a></td>
868
+ <td class="oblique">$.hdb</td>
869
+ </tr>
870
+ <tr>
871
+ <td><a href="$.net.http.Request.html">Request</a></td>
872
+ <td class="oblique">$.net.http</td>
873
+ </tr>
874
+ <tr>
875
+ <td><a href="$.db.ResultSet.html">ResultSet</a></td>
876
+ <td class="oblique">$.db</td>
877
+ </tr>
878
+ <tr>
879
+ <td><a href="$.hdb.ResultSet.html">ResultSet</a></td>
880
+ <td class="oblique">$.hdb</td>
881
+ </tr>
882
+ <tr>
883
+ <td><a href="$.hdb.ResultSetIterator.html">ResultSetIterator</a></td>
884
+ <td class="oblique">$.hdb</td>
885
+ </tr>
886
+ <tr>
887
+ <td><a href="$.db.ResultSetMetaData.html">ResultSetMetaData</a></td>
888
+ <td class="oblique">$.db</td>
889
+ </tr>
890
+ <tr>
891
+ <td><a href="$.hdb.ResultSetMetaData.html">ResultSetMetaData</a></td>
892
+ <td class="oblique">$.hdb</td>
893
+ </tr>
894
+ <tr>
895
+ <td><a href="$.util.SAXParser.html">SAXParser</a></td>
896
+ <td class="oblique">$.util</td>
897
+ </tr>
898
+ <tr>
899
+ <td><a href="$.Session.html">Session</a></td>
900
+ <td class="oblique">$</td>
901
+ </tr>
902
+ <tr>
903
+ <td><a href="$.text.analysis.Session.html">Session</a></td>
904
+ <td class="oblique">$.text.analysis</td>
905
+ </tr>
906
+ <tr>
907
+ <td><a href="$.text.mining.Session.html">Session</a></td>
908
+ <td class="oblique">$.text.mining</td>
909
+ </tr>
910
+ <tr>
911
+ <td><a href="$.net.SMTPConnection.html">SMTPConnection</a></td>
912
+ <td class="oblique">$.net</td>
913
+ </tr>
914
+ <tr>
915
+ <td><a href="$.db.SQLException.html">SQLException</a></td>
916
+ <td class="oblique">$.db</td>
917
+ </tr>
918
+ <tr>
919
+ <td><a href="$.hdb.SQLException.html">SQLException</a></td>
920
+ <td class="oblique">$.hdb</td>
921
+ </tr>
922
+ <tr>
923
+ <td><a href="$.security.Store.html">Store</a></td>
924
+ <td class="oblique">$.security</td>
925
+ </tr>
926
+ <tr>
927
+ <td><a href="$.web.TupelList.html">TupelList</a></td>
928
+ <td class="oblique">$.web</td>
929
+ </tr>
930
+ <tr>
931
+ <td><a href="$.web.WebEntityRequest.html">WebEntityRequest</a></td>
932
+ <td class="oblique">$.web</td>
933
+ </tr>
934
+ <tr>
935
+ <td><a href="$.web.WebEntityResponse.html">WebEntityResponse</a></td>
936
+ <td class="oblique">$.web</td>
937
+ </tr>
938
+ <tr>
939
+ <td><a href="$.web.WebRequest.html">WebRequest</a></td>
940
+ <td class="oblique">$.web</td>
941
+ </tr>
942
+ <tr>
943
+ <td><a href="$.web.WebResponse.html">WebResponse</a></td>
944
+ <td class="oblique">$.web</td>
945
+ </tr>
946
+ <tr>
947
+ <td><a href="$.util.Zip.html">Zip</a></td>
948
+ <td class="oblique">$.util</td>
949
+ </tr>
950
+ </table>
951
+ <h3>Namespaces</h3>
952
+ <ul>
953
+ <li><a href="$.html"><span class="oblique"></span>$</a></li>
954
+ <li><a href="$.db.html"><span class="oblique">$.</span>db</a></li>
955
+ <li><a href="$.hdb.html"><span class="oblique">$.</span>hdb</a></li>
956
+ <li><a href="$.jobs.html"><span class="oblique">$.</span>jobs</a></li>
957
+ <li><a href="$.net.html"><span class="oblique">$.</span>net</a></li>
958
+ <li><a href="$.net.http.html"><span class="oblique">$.net.</span>http</a></li>
959
+ <li><a href="$.security.html"><span class="oblique">$.</span>security</a></li>
960
+ <li><a href="$.security.crypto.html"><span class="oblique">$.security.</span>crypto</a></li>
961
+ <li><a href="$.security.x509.html"><span class="oblique">$.security.</span>x509</a></li>
962
+ <li><a href="$.text.html"><span class="oblique">$.</span>text</a></li>
963
+ <li><a href="$.text.analysis.html"><span class="oblique">$.text.</span>analysis</a></li>
964
+ <li><a href="$.text.mining.html"><span class="oblique">$.text.</span>mining</a></li>
965
+ <li><a href="$.trace.html"><span class="oblique">$.</span>trace</a></li>
966
+ <li><a href="$.util.html"><span class="oblique">$.</span>util</a></li>
967
+ <li><a href="$.util.codec.html"><span class="oblique">$.util.</span>codec</a></li>
968
+ <li><a href="$.util.compression.html"><span class="oblique">$.util.</span>compression</a></li>
969
+ <li><a href="$.util.sql.html"><span class="oblique">$.util.</span>sql</a></li>
970
+ <li><a href="$.web.html"><span class="oblique">$.</span>web</a></li>
971
+ </ul>
972
+ </nav>
973
+ <br clear="both">
974
+ <footer>
975
+ <a href="Copyright-SAP.html">Copyright</a>
976
+ &
977
+ <a href="Disclaimer-SAP.html">Disclaimer</a>
978
+ </footer>
979
+ <script>prettyPrint();</script>
980
+ <script src="scripts/linenumber.js"></script>
981
+ </body>
982
+
983
+ </html>