123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497 |
- <!DOCTYPE HTML>
- <!-- NewPage -->
- <html lang="en">
- <head>
- <!-- Generated by javadoc (11.0.15) on Fri Nov 18 17:27:00 CST 2022 -->
- <title>ParamUtils</title>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
- <meta name="dc.created" content="2022-11-18">
- <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
- <link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
- <script type="text/javascript" src="../../../script.js"></script>
- <script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script>
- <script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
- <!--[if IE]>
- <script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
- <![endif]-->
- <script type="text/javascript" src="../../../jquery/jquery-3.5.1.js"></script>
- <script type="text/javascript" src="../../../jquery/jquery-ui.js"></script>
- </head>
- <body>
- <script type="text/javascript"><!--
- try {
- if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="ParamUtils";
- }
- }
- catch(err) {
- }
- //-->
- var data = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9};
- var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
- var altColor = "altColor";
- var rowColor = "rowColor";
- var tableTab = "tableTab";
- var activeTableTab = "activeTableTab";
- var pathtoroot = "../../../";
- var useModuleDirectories = true;
- loadScripts(document, 'script');</script>
- <noscript>
- <div>JavaScript is disabled on your browser.</div>
- </noscript>
- <header role="banner">
- <nav role="navigation">
- <div class="fixedNav">
- <!-- ========= START OF TOP NAVBAR ======= -->
- <div class="topNav"><a id="navbar.top">
- <!-- -->
- </a>
- <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
- <a id="navbar.top.firstrow">
- <!-- -->
- </a>
- <ul class="navList" title="Navigation">
- <li><a href="../../../index.html">Overview</a></li>
- <li><a href="package-summary.html">Package</a></li>
- <li class="navBarCell1Rev">Class</li>
- <li><a href="package-tree.html">Tree</a></li>
- <li><a href="../../../deprecated-list.html">Deprecated</a></li>
- <li><a href="../../../index-files/index-1.html">Index</a></li>
- <li><a href="../../../help-doc.html">Help</a></li>
- </ul>
- </div>
- <div class="subNav">
- <ul class="navList" id="allclasses_navbar_top">
- <li><a href="../../../allclasses.html">All Classes</a></li>
- </ul>
- <ul class="navListSearch">
- <li><label for="search">SEARCH:</label>
- <input type="text" id="search" value="search" disabled="disabled">
- <input type="reset" id="reset" value="reset" disabled="disabled">
- </li>
- </ul>
- <div>
- <script type="text/javascript"><!--
- allClassesLink = document.getElementById("allclasses_navbar_top");
- if(window==top) {
- allClassesLink.style.display = "block";
- }
- else {
- allClassesLink.style.display = "none";
- }
- //-->
- </script>
- <noscript>
- <div>JavaScript is disabled on your browser.</div>
- </noscript>
- </div>
- <div>
- <ul class="subNavList">
- <li>Summary: </li>
- <li>Nested | </li>
- <li>Field | </li>
- <li><a href="#constructor.summary">Constr</a> | </li>
- <li><a href="#method.summary">Method</a></li>
- </ul>
- <ul class="subNavList">
- <li>Detail: </li>
- <li>Field | </li>
- <li><a href="#constructor.detail">Constr</a> | </li>
- <li><a href="#method.detail">Method</a></li>
- </ul>
- </div>
- <a id="skip.navbar.top">
- <!-- -->
- </a></div>
- <!-- ========= END OF TOP NAVBAR ========= -->
- </div>
- <div class="navPadding"> </div>
- <script type="text/javascript"><!--
- $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
- //-->
- </script>
- </nav>
- </header>
- <!-- ======== START OF CLASS DATA ======== -->
- <main role="main">
- <div class="header">
- <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">io.milvus.param</a></div>
- <h2 title="Class ParamUtils" class="title">Class ParamUtils</h2>
- </div>
- <div class="contentContainer">
- <ul class="inheritance">
- <li>java.lang.Object</li>
- <li>
- <ul class="inheritance">
- <li>io.milvus.param.ParamUtils</li>
- </ul>
- </li>
- </ul>
- <div class="description">
- <ul class="blockList">
- <li class="blockList">
- <hr>
- <pre>public class <span class="typeNameLabel">ParamUtils</span>
- extends java.lang.Object</pre>
- <div class="block">Utility functions for param classes</div>
- </li>
- </ul>
- </div>
- <div class="summary">
- <ul class="blockList">
- <li class="blockList">
- <!-- ======== CONSTRUCTOR SUMMARY ======== -->
- <section role="region">
- <ul class="blockList">
- <li class="blockList"><a id="constructor.summary">
- <!-- -->
- </a>
- <h3>Constructor Summary</h3>
- <table class="memberSummary">
- <caption><span>Constructors</span><span class="tabEnd"> </span></caption>
- <tr>
- <th class="colFirst" scope="col">Constructor</th>
- <th class="colLast" scope="col">Description</th>
- </tr>
- <tr class="altColor">
- <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">ParamUtils</a></span>()</code></th>
- <td class="colLast"> </td>
- </tr>
- </table>
- </li>
- </ul>
- </section>
- <!-- ========== METHOD SUMMARY =========== -->
- <section role="region">
- <ul class="blockList">
- <li class="blockList"><a id="method.summary">
- <!-- -->
- </a>
- <h3>Method Summary</h3>
- <table class="memberSummary">
- <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
- <tr>
- <th class="colFirst" scope="col">Modifier and Type</th>
- <th class="colSecond" scope="col">Method</th>
- <th class="colLast" scope="col">Description</th>
- </tr>
- <tr id="i0" class="altColor">
- <td class="colFirst"><code>static void</code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#CheckNullEmptyString(java.lang.String,java.lang.String)">CheckNullEmptyString</a></span>​(java.lang.String target,
- java.lang.String name)</code></th>
- <td class="colLast">
- <div class="block">Checks if a string is empty or null.</div>
- </td>
- </tr>
- <tr id="i1" class="rowColor">
- <td class="colFirst"><code>static <a href="collection/FieldType.html" title="class in io.milvus.param.collection">FieldType</a></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ConvertField(io.milvus.grpc.FieldSchema)">ConvertField</a></span>​(@NonNull io.milvus.grpc.FieldSchema field)</code></th>
- <td class="colLast">
- <div class="block">Convert a grpc field schema to client field schema</div>
- </td>
- </tr>
- <tr id="i2" class="altColor">
- <td class="colFirst"><code>static io.milvus.grpc.FieldSchema</code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ConvertField(io.milvus.param.collection.FieldType)">ConvertField</a></span>​(@NonNull <a href="collection/FieldType.html" title="class in io.milvus.param.collection">FieldType</a> field)</code></th>
- <td class="colLast">
- <div class="block">Convert a client field schema to grpc field schema</div>
- </td>
- </tr>
- <tr id="i3" class="rowColor">
- <td class="colFirst"><code>static io.milvus.grpc.InsertRequest</code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#convertInsertParam(io.milvus.param.dml.InsertParam,java.util.List)">convertInsertParam</a></span>​(@NonNull <a href="dml/InsertParam.html" title="class in io.milvus.param.dml">InsertParam</a> requestParam,
- @NonNull java.util.List<<a href="collection/FieldType.html" title="class in io.milvus.param.collection">FieldType</a>> fieldTypes)</code></th>
- <td class="colLast"> </td>
- </tr>
- <tr id="i4" class="altColor">
- <td class="colFirst"><code>static io.milvus.grpc.QueryRequest</code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#convertQueryParam(io.milvus.param.dml.QueryParam)">convertQueryParam</a></span>​(@NonNull <a href="dml/QueryParam.html" title="class in io.milvus.param.dml">QueryParam</a> requestParam)</code></th>
- <td class="colLast"> </td>
- </tr>
- <tr id="i5" class="rowColor">
- <td class="colFirst"><code>static io.milvus.grpc.SearchRequest</code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#convertSearchParam(io.milvus.param.dml.SearchParam)">convertSearchParam</a></span>​(@NonNull <a href="dml/SearchParam.html" title="class in io.milvus.param.dml">SearchParam</a> requestParam)</code></th>
- <td class="colLast"> </td>
- </tr>
- <tr id="i6" class="altColor">
- <td class="colFirst"><code>static java.util.HashMap<io.milvus.grpc.DataType,​java.lang.String></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTypeErrorMsg()">getTypeErrorMsg</a></span>()</code></th>
- <td class="colLast"> </td>
- </tr>
- <tr id="i7" class="rowColor">
- <td class="colFirst"><code>static boolean</code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#IsBinaryMetric(io.milvus.param.MetricType)">IsBinaryMetric</a></span>​(<a href="MetricType.html" title="enum in io.milvus.param">MetricType</a> metric)</code></th>
- <td class="colLast">
- <div class="block">Checks if a metric is for binary vector.</div>
- </td>
- </tr>
- <tr id="i8" class="altColor">
- <td class="colFirst"><code>static boolean</code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#IsFloatMetric(io.milvus.param.MetricType)">IsFloatMetric</a></span>​(<a href="MetricType.html" title="enum in io.milvus.param">MetricType</a> metric)</code></th>
- <td class="colLast">
- <div class="block">Checks if a metric is for float vector.</div>
- </td>
- </tr>
- <tr id="i9" class="rowColor">
- <td class="colFirst"><code>static boolean</code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#IsVectorIndex(io.milvus.param.IndexType)">IsVectorIndex</a></span>​(<a href="IndexType.html" title="enum in io.milvus.param">IndexType</a> idx)</code></th>
- <td class="colLast">
- <div class="block">Checks if an index type is for vector.</div>
- </td>
- </tr>
- </table>
- <ul class="blockList">
- <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
- <!-- -->
- </a>
- <h3>Methods inherited from class java.lang.Object</h3>
- <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
- </ul>
- </li>
- </ul>
- </section>
- </li>
- </ul>
- </div>
- <div class="details">
- <ul class="blockList">
- <li class="blockList">
- <!-- ========= CONSTRUCTOR DETAIL ======== -->
- <section role="region">
- <ul class="blockList">
- <li class="blockList"><a id="constructor.detail">
- <!-- -->
- </a>
- <h3>Constructor Detail</h3>
- <a id="<init>()">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>ParamUtils</h4>
- <pre>public ParamUtils()</pre>
- </li>
- </ul>
- </li>
- </ul>
- </section>
- <!-- ============ METHOD DETAIL ========== -->
- <section role="region">
- <ul class="blockList">
- <li class="blockList"><a id="method.detail">
- <!-- -->
- </a>
- <h3>Method Detail</h3>
- <a id="getTypeErrorMsg()">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getTypeErrorMsg</h4>
- <pre class="methodSignature">public static java.util.HashMap<io.milvus.grpc.DataType,​java.lang.String> getTypeErrorMsg()</pre>
- </li>
- </ul>
- <a id="CheckNullEmptyString(java.lang.String,java.lang.String)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>CheckNullEmptyString</h4>
- <pre class="methodSignature">public static void CheckNullEmptyString​(java.lang.String target,
- java.lang.String name)
- throws <a href="../exception/ParamException.html" title="class in io.milvus.exception">ParamException</a></pre>
- <div class="block">Checks if a string is empty or null.
- Throws <a href="../exception/ParamException.html" title="class in io.milvus.exception"><code>ParamException</code></a> if the string is empty of null.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>target</code> - target string</dd>
- <dd><code>name</code> - a name to describe this string</dd>
- <dt><span class="throwsLabel">Throws:</span></dt>
- <dd><code><a href="../exception/ParamException.html" title="class in io.milvus.exception">ParamException</a></code></dd>
- </dl>
- </li>
- </ul>
- <a id="IsFloatMetric(io.milvus.param.MetricType)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>IsFloatMetric</h4>
- <pre class="methodSignature">public static boolean IsFloatMetric​(<a href="MetricType.html" title="enum in io.milvus.param">MetricType</a> metric)</pre>
- <div class="block">Checks if a metric is for float vector.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>metric</code> - metric type</dd>
- </dl>
- </li>
- </ul>
- <a id="IsBinaryMetric(io.milvus.param.MetricType)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>IsBinaryMetric</h4>
- <pre class="methodSignature">public static boolean IsBinaryMetric​(<a href="MetricType.html" title="enum in io.milvus.param">MetricType</a> metric)</pre>
- <div class="block">Checks if a metric is for binary vector.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>metric</code> - metric type</dd>
- </dl>
- </li>
- </ul>
- <a id="IsVectorIndex(io.milvus.param.IndexType)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>IsVectorIndex</h4>
- <pre class="methodSignature">public static boolean IsVectorIndex​(<a href="IndexType.html" title="enum in io.milvus.param">IndexType</a> idx)</pre>
- <div class="block">Checks if an index type is for vector.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>idx</code> - index type</dd>
- </dl>
- </li>
- </ul>
- <a id="convertInsertParam(io.milvus.param.dml.InsertParam,java.util.List)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>convertInsertParam</h4>
- <pre class="methodSignature">public static io.milvus.grpc.InsertRequest convertInsertParam​(@NonNull
- @NonNull <a href="dml/InsertParam.html" title="class in io.milvus.param.dml">InsertParam</a> requestParam,
- @NonNull
- @NonNull java.util.List<<a href="collection/FieldType.html" title="class in io.milvus.param.collection">FieldType</a>> fieldTypes)</pre>
- </li>
- </ul>
- <a id="convertSearchParam(io.milvus.param.dml.SearchParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>convertSearchParam</h4>
- <pre class="methodSignature">public static io.milvus.grpc.SearchRequest convertSearchParam​(@NonNull
- @NonNull <a href="dml/SearchParam.html" title="class in io.milvus.param.dml">SearchParam</a> requestParam)
- throws <a href="../exception/ParamException.html" title="class in io.milvus.exception">ParamException</a></pre>
- <dl>
- <dt><span class="throwsLabel">Throws:</span></dt>
- <dd><code><a href="../exception/ParamException.html" title="class in io.milvus.exception">ParamException</a></code></dd>
- </dl>
- </li>
- </ul>
- <a id="convertQueryParam(io.milvus.param.dml.QueryParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>convertQueryParam</h4>
- <pre class="methodSignature">public static io.milvus.grpc.QueryRequest convertQueryParam​(@NonNull
- @NonNull <a href="dml/QueryParam.html" title="class in io.milvus.param.dml">QueryParam</a> requestParam)</pre>
- </li>
- </ul>
- <a id="ConvertField(io.milvus.grpc.FieldSchema)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>ConvertField</h4>
- <pre class="methodSignature">public static <a href="collection/FieldType.html" title="class in io.milvus.param.collection">FieldType</a> ConvertField​(@NonNull
- @NonNull io.milvus.grpc.FieldSchema field)</pre>
- <div class="block">Convert a grpc field schema to client field schema</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>field</code> - FieldSchema object</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><a href="collection/FieldType.html" title="class in io.milvus.param.collection"><code>FieldType</code></a> schema of the field</dd>
- </dl>
- </li>
- </ul>
- <a id="ConvertField(io.milvus.param.collection.FieldType)">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>ConvertField</h4>
- <pre class="methodSignature">public static io.milvus.grpc.FieldSchema ConvertField​(@NonNull
- @NonNull <a href="collection/FieldType.html" title="class in io.milvus.param.collection">FieldType</a> field)</pre>
- <div class="block">Convert a client field schema to grpc field schema</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>field</code> - <a href="collection/FieldType.html" title="class in io.milvus.param.collection"><code>FieldType</code></a> object</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>FieldSchema</code> schema of the field</dd>
- </dl>
- </li>
- </ul>
- </li>
- </ul>
- </section>
- </li>
- </ul>
- </div>
- </div>
- </main>
- <!-- ========= END OF CLASS DATA ========= -->
- <footer role="contentinfo">
- <nav role="navigation">
- <!-- ======= START OF BOTTOM NAVBAR ====== -->
- <div class="bottomNav"><a id="navbar.bottom">
- <!-- -->
- </a>
- <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
- <a id="navbar.bottom.firstrow">
- <!-- -->
- </a>
- <ul class="navList" title="Navigation">
- <li><a href="../../../index.html">Overview</a></li>
- <li><a href="package-summary.html">Package</a></li>
- <li class="navBarCell1Rev">Class</li>
- <li><a href="package-tree.html">Tree</a></li>
- <li><a href="../../../deprecated-list.html">Deprecated</a></li>
- <li><a href="../../../index-files/index-1.html">Index</a></li>
- <li><a href="../../../help-doc.html">Help</a></li>
- </ul>
- </div>
- <div class="subNav">
- <ul class="navList" id="allclasses_navbar_bottom">
- <li><a href="../../../allclasses.html">All Classes</a></li>
- </ul>
- <div>
- <script type="text/javascript"><!--
- allClassesLink = document.getElementById("allclasses_navbar_bottom");
- if(window==top) {
- allClassesLink.style.display = "block";
- }
- else {
- allClassesLink.style.display = "none";
- }
- //-->
- </script>
- <noscript>
- <div>JavaScript is disabled on your browser.</div>
- </noscript>
- </div>
- <div>
- <ul class="subNavList">
- <li>Summary: </li>
- <li>Nested | </li>
- <li>Field | </li>
- <li><a href="#constructor.summary">Constr</a> | </li>
- <li><a href="#method.summary">Method</a></li>
- </ul>
- <ul class="subNavList">
- <li>Detail: </li>
- <li>Field | </li>
- <li><a href="#constructor.detail">Constr</a> | </li>
- <li><a href="#method.detail">Method</a></li>
- </ul>
- </div>
- <a id="skip.navbar.bottom">
- <!-- -->
- </a></div>
- <!-- ======== END OF BOTTOM NAVBAR ======= -->
- </nav>
- </footer>
- </body>
- </html>
|