QueryResultsWrapper.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!-- NewPage -->
  3. <html lang="en">
  4. <head>
  5. <!-- Generated by javadoc (1.8.0_402-402) on Fri Oct 18 12:22:14 CST 2024 -->
  6. <title>QueryResultsWrapper</title>
  7. <meta name="date" content="2024-10-18">
  8. <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
  9. <script type="text/javascript" src="../../../script.js"></script>
  10. </head>
  11. <body>
  12. <script type="text/javascript"><!--
  13. try {
  14. if (location.href.indexOf('is-external=true') == -1) {
  15. parent.document.title="QueryResultsWrapper";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":10,"i1":10,"i2":10};
  22. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
  23. var altColor = "altColor";
  24. var rowColor = "rowColor";
  25. var tableTab = "tableTab";
  26. var activeTableTab = "activeTableTab";
  27. </script>
  28. <noscript>
  29. <div>JavaScript is disabled on your browser.</div>
  30. </noscript>
  31. <!-- ========= START OF TOP NAVBAR ======= -->
  32. <div class="topNav"><a name="navbar.top">
  33. <!-- -->
  34. </a>
  35. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  36. <a name="navbar.top.firstrow">
  37. <!-- -->
  38. </a>
  39. <ul class="navList" title="Navigation">
  40. <li><a href="../../../overview-summary.html">Overview</a></li>
  41. <li><a href="package-summary.html">Package</a></li>
  42. <li class="navBarCell1Rev">Class</li>
  43. <li><a href="package-tree.html">Tree</a></li>
  44. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
  45. <li><a href="../../../index-files/index-1.html">Index</a></li>
  46. <li><a href="../../../help-doc.html">Help</a></li>
  47. </ul>
  48. </div>
  49. <div class="subNav">
  50. <ul class="navList">
  51. <li><a href="../../../io/milvus/response/MutationResultWrapper.html" title="class in io.milvus.response"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  52. <li><a href="../../../io/milvus/response/QueryResultsWrapper.RowRecord.html" title="class in io.milvus.response"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  53. </ul>
  54. <ul class="navList">
  55. <li><a href="../../../index.html?io/milvus/response/QueryResultsWrapper.html" target="_top">Frames</a></li>
  56. <li><a href="QueryResultsWrapper.html" target="_top">No&nbsp;Frames</a></li>
  57. </ul>
  58. <ul class="navList" id="allclasses_navbar_top">
  59. <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  60. </ul>
  61. <div>
  62. <script type="text/javascript"><!--
  63. allClassesLink = document.getElementById("allclasses_navbar_top");
  64. if(window==top) {
  65. allClassesLink.style.display = "block";
  66. }
  67. else {
  68. allClassesLink.style.display = "none";
  69. }
  70. //-->
  71. </script>
  72. </div>
  73. <div>
  74. <ul class="subNavList">
  75. <li>Summary:&nbsp;</li>
  76. <li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
  77. <li>Field&nbsp;|&nbsp;</li>
  78. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  79. <li><a href="#method.summary">Method</a></li>
  80. </ul>
  81. <ul class="subNavList">
  82. <li>Detail:&nbsp;</li>
  83. <li>Field&nbsp;|&nbsp;</li>
  84. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  85. <li><a href="#method.detail">Method</a></li>
  86. </ul>
  87. </div>
  88. <a name="skip.navbar.top">
  89. <!-- -->
  90. </a></div>
  91. <!-- ========= END OF TOP NAVBAR ========= -->
  92. <!-- ======== START OF CLASS DATA ======== -->
  93. <div class="header">
  94. <div class="subTitle">io.milvus.response</div>
  95. <h2 title="Class QueryResultsWrapper" class="title">Class QueryResultsWrapper</h2>
  96. </div>
  97. <div class="contentContainer">
  98. <ul class="inheritance">
  99. <li>java.lang.Object</li>
  100. <li>
  101. <ul class="inheritance">
  102. <li><a href="../../../io/milvus/response/basic/RowRecordWrapper.html" title="class in io.milvus.response.basic">io.milvus.response.basic.RowRecordWrapper</a></li>
  103. <li>
  104. <ul class="inheritance">
  105. <li>io.milvus.response.QueryResultsWrapper</li>
  106. </ul>
  107. </li>
  108. </ul>
  109. </li>
  110. </ul>
  111. <div class="description">
  112. <ul class="blockList">
  113. <li class="blockList">
  114. <hr>
  115. <br>
  116. <pre>public class <span class="typeNameLabel">QueryResultsWrapper</span>
  117. extends <a href="../../../io/milvus/response/basic/RowRecordWrapper.html" title="class in io.milvus.response.basic">RowRecordWrapper</a></pre>
  118. <div class="block">Utility class to wrap response of <code>query</code> interface.</div>
  119. </li>
  120. </ul>
  121. </div>
  122. <div class="summary">
  123. <ul class="blockList">
  124. <li class="blockList">
  125. <!-- ======== NESTED CLASS SUMMARY ======== -->
  126. <ul class="blockList">
  127. <li class="blockList"><a name="nested.class.summary">
  128. <!-- -->
  129. </a>
  130. <h3>Nested Class Summary</h3>
  131. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
  132. <caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
  133. <tr>
  134. <th class="colFirst" scope="col">Modifier and Type</th>
  135. <th class="colLast" scope="col">Class and Description</th>
  136. </tr>
  137. <tr class="altColor">
  138. <td class="colFirst"><code>static class&nbsp;</code></td>
  139. <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/QueryResultsWrapper.RowRecord.html" title="class in io.milvus.response">QueryResultsWrapper.RowRecord</a></span></code>
  140. <div class="block">Internal-use class to wrap response of <code>query</code> interface.</div>
  141. </td>
  142. </tr>
  143. </table>
  144. </li>
  145. </ul>
  146. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  147. <ul class="blockList">
  148. <li class="blockList"><a name="constructor.summary">
  149. <!-- -->
  150. </a>
  151. <h3>Constructor Summary</h3>
  152. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  153. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  154. <tr>
  155. <th class="colOne" scope="col">Constructor and Description</th>
  156. </tr>
  157. <tr class="altColor">
  158. <td class="colOne"><code><span class="memberNameLink"><a href="../../../io/milvus/response/QueryResultsWrapper.html#QueryResultsWrapper-io.milvus.grpc.QueryResults-">QueryResultsWrapper</a></span>(@NonNull io.milvus.grpc.QueryResults&nbsp;results)</code>&nbsp;</td>
  159. </tr>
  160. </table>
  161. </li>
  162. </ul>
  163. <!-- ========== METHOD SUMMARY =========== -->
  164. <ul class="blockList">
  165. <li class="blockList"><a name="method.summary">
  166. <!-- -->
  167. </a>
  168. <h3>Method Summary</h3>
  169. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  170. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  171. <tr>
  172. <th class="colFirst" scope="col">Modifier and Type</th>
  173. <th class="colLast" scope="col">Method and Description</th>
  174. </tr>
  175. <tr id="i0" class="altColor">
  176. <td class="colFirst"><code><a href="../../../io/milvus/response/FieldDataWrapper.html" title="class in io.milvus.response">FieldDataWrapper</a></code></td>
  177. <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/QueryResultsWrapper.html#getFieldWrapper-java.lang.String-">getFieldWrapper</a></span>(@NonNull java.lang.String&nbsp;fieldName)</code>
  178. <div class="block">Gets <a href="../../../io/milvus/response/FieldDataWrapper.html" title="class in io.milvus.response"><code>FieldDataWrapper</code></a> for a field.</div>
  179. </td>
  180. </tr>
  181. <tr id="i1" class="rowColor">
  182. <td class="colFirst"><code>long</code></td>
  183. <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/QueryResultsWrapper.html#getRowCount--">getRowCount</a></span>()</code>
  184. <div class="block">Gets the row count of the result.</div>
  185. </td>
  186. </tr>
  187. <tr id="i2" class="altColor">
  188. <td class="colFirst"><code>java.util.List&lt;<a href="../../../io/milvus/response/QueryResultsWrapper.RowRecord.html" title="class in io.milvus.response">QueryResultsWrapper.RowRecord</a>&gt;</code></td>
  189. <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/QueryResultsWrapper.html#getRowRecords--">getRowRecords</a></span>()</code>
  190. <div class="block">Gets row records list from query result.</div>
  191. </td>
  192. </tr>
  193. </table>
  194. <ul class="blockList">
  195. <li class="blockList"><a name="methods.inherited.from.class.io.milvus.response.basic.RowRecordWrapper">
  196. <!-- -->
  197. </a>
  198. <h3>Methods inherited from class&nbsp;io.milvus.response.basic.<a href="../../../io/milvus/response/basic/RowRecordWrapper.html" title="class in io.milvus.response.basic">RowRecordWrapper</a></h3>
  199. <code><a href="../../../io/milvus/response/basic/RowRecordWrapper.html#getDynamicWrapper--">getDynamicWrapper</a></code></li>
  200. </ul>
  201. <ul class="blockList">
  202. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  203. <!-- -->
  204. </a>
  205. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  206. <code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  207. </ul>
  208. </li>
  209. </ul>
  210. </li>
  211. </ul>
  212. </div>
  213. <div class="details">
  214. <ul class="blockList">
  215. <li class="blockList">
  216. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  217. <ul class="blockList">
  218. <li class="blockList"><a name="constructor.detail">
  219. <!-- -->
  220. </a>
  221. <h3>Constructor Detail</h3>
  222. <a name="QueryResultsWrapper-io.milvus.grpc.QueryResults-">
  223. <!-- -->
  224. </a>
  225. <ul class="blockListLast">
  226. <li class="blockList">
  227. <h4>QueryResultsWrapper</h4>
  228. <pre>public&nbsp;QueryResultsWrapper(@NonNull
  229. @NonNull io.milvus.grpc.QueryResults&nbsp;results)</pre>
  230. </li>
  231. </ul>
  232. </li>
  233. </ul>
  234. <!-- ============ METHOD DETAIL ========== -->
  235. <ul class="blockList">
  236. <li class="blockList"><a name="method.detail">
  237. <!-- -->
  238. </a>
  239. <h3>Method Detail</h3>
  240. <a name="getFieldWrapper-java.lang.String-">
  241. <!-- -->
  242. </a>
  243. <ul class="blockList">
  244. <li class="blockList">
  245. <h4>getFieldWrapper</h4>
  246. <pre>public&nbsp;<a href="../../../io/milvus/response/FieldDataWrapper.html" title="class in io.milvus.response">FieldDataWrapper</a>&nbsp;getFieldWrapper(@NonNull
  247. @NonNull java.lang.String&nbsp;fieldName)
  248. throws <a href="../../../io/milvus/exception/ParamException.html" title="class in io.milvus.exception">ParamException</a></pre>
  249. <div class="block">Gets <a href="../../../io/milvus/response/FieldDataWrapper.html" title="class in io.milvus.response"><code>FieldDataWrapper</code></a> for a field.
  250. Throws <a href="../../../io/milvus/exception/ParamException.html" title="class in io.milvus.exception"><code>ParamException</code></a> if the field doesn't exist.</div>
  251. <dl>
  252. <dt><span class="paramLabel">Parameters:</span></dt>
  253. <dd><code>fieldName</code> - field name to get output data</dd>
  254. <dt><span class="returnLabel">Returns:</span></dt>
  255. <dd><a href="../../../io/milvus/response/FieldDataWrapper.html" title="class in io.milvus.response"><code>FieldDataWrapper</code></a></dd>
  256. <dt><span class="throwsLabel">Throws:</span></dt>
  257. <dd><code><a href="../../../io/milvus/exception/ParamException.html" title="class in io.milvus.exception">ParamException</a></code></dd>
  258. </dl>
  259. </li>
  260. </ul>
  261. <a name="getRowRecords--">
  262. <!-- -->
  263. </a>
  264. <ul class="blockList">
  265. <li class="blockList">
  266. <h4>getRowRecords</h4>
  267. <pre>public&nbsp;java.util.List&lt;<a href="../../../io/milvus/response/QueryResultsWrapper.RowRecord.html" title="class in io.milvus.response">QueryResultsWrapper.RowRecord</a>&gt;&nbsp;getRowRecords()</pre>
  268. <div class="block">Gets row records list from query result.</div>
  269. <dl>
  270. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  271. <dd><code><a href="../../../io/milvus/response/basic/RowRecordWrapper.html#getRowRecords--">getRowRecords</a></code>&nbsp;in class&nbsp;<code><a href="../../../io/milvus/response/basic/RowRecordWrapper.html" title="class in io.milvus.response.basic">RowRecordWrapper</a></code></dd>
  272. <dt><span class="returnLabel">Returns:</span></dt>
  273. <dd>List of <code>QueryResultsWrapper.RowRecord</code> a row records list of the query result</dd>
  274. </dl>
  275. </li>
  276. </ul>
  277. <a name="getRowCount--">
  278. <!-- -->
  279. </a>
  280. <ul class="blockListLast">
  281. <li class="blockList">
  282. <h4>getRowCount</h4>
  283. <pre>public&nbsp;long&nbsp;getRowCount()</pre>
  284. <div class="block">Gets the row count of the result.</div>
  285. <dl>
  286. <dt><span class="returnLabel">Returns:</span></dt>
  287. <dd><code>long</code> row count of the result</dd>
  288. </dl>
  289. </li>
  290. </ul>
  291. </li>
  292. </ul>
  293. </li>
  294. </ul>
  295. </div>
  296. </div>
  297. <!-- ========= END OF CLASS DATA ========= -->
  298. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  299. <div class="bottomNav"><a name="navbar.bottom">
  300. <!-- -->
  301. </a>
  302. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  303. <a name="navbar.bottom.firstrow">
  304. <!-- -->
  305. </a>
  306. <ul class="navList" title="Navigation">
  307. <li><a href="../../../overview-summary.html">Overview</a></li>
  308. <li><a href="package-summary.html">Package</a></li>
  309. <li class="navBarCell1Rev">Class</li>
  310. <li><a href="package-tree.html">Tree</a></li>
  311. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
  312. <li><a href="../../../index-files/index-1.html">Index</a></li>
  313. <li><a href="../../../help-doc.html">Help</a></li>
  314. </ul>
  315. </div>
  316. <div class="subNav">
  317. <ul class="navList">
  318. <li><a href="../../../io/milvus/response/MutationResultWrapper.html" title="class in io.milvus.response"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  319. <li><a href="../../../io/milvus/response/QueryResultsWrapper.RowRecord.html" title="class in io.milvus.response"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  320. </ul>
  321. <ul class="navList">
  322. <li><a href="../../../index.html?io/milvus/response/QueryResultsWrapper.html" target="_top">Frames</a></li>
  323. <li><a href="QueryResultsWrapper.html" target="_top">No&nbsp;Frames</a></li>
  324. </ul>
  325. <ul class="navList" id="allclasses_navbar_bottom">
  326. <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  327. </ul>
  328. <div>
  329. <script type="text/javascript"><!--
  330. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  331. if(window==top) {
  332. allClassesLink.style.display = "block";
  333. }
  334. else {
  335. allClassesLink.style.display = "none";
  336. }
  337. //-->
  338. </script>
  339. </div>
  340. <div>
  341. <ul class="subNavList">
  342. <li>Summary:&nbsp;</li>
  343. <li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
  344. <li>Field&nbsp;|&nbsp;</li>
  345. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  346. <li><a href="#method.summary">Method</a></li>
  347. </ul>
  348. <ul class="subNavList">
  349. <li>Detail:&nbsp;</li>
  350. <li>Field&nbsp;|&nbsp;</li>
  351. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  352. <li><a href="#method.detail">Method</a></li>
  353. </ul>
  354. </div>
  355. <a name="skip.navbar.bottom">
  356. <!-- -->
  357. </a></div>
  358. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  359. </body>
  360. </html>