Package io.milvus.param

Class ParamUtils

java.lang.Object

io.milvus.param.ParamUtils

public class ParamUtils
extends Object

Utility functions for param classes

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ParamUtils.InsertDataInfo

Constructor Summary

Constructors

Constructor	Description
ParamUtils()

Method Summary

Modifier and Type	Method	Description
static List<KeyValuePair>	AssembleKvPair(Map<String,String> sourceMap)
static void	CheckNullEmptyString(String target, String name)	Checks if a string is empty or null.
static void	CheckNullString(String target, String name)	Checks if a string is null.
static FieldType	ConvertField(@NonNull FieldSchema field)	Convert a grpc field schema to client field schema
static FieldSchema	ConvertField(@NonNull FieldType field)	Convert a client field schema to grpc field schema
static InsertRequest	convertInsertParam(@NonNull InsertParam requestParam, DescCollResponseWrapper wrapper)
static QueryRequest	convertQueryParam(@NonNull QueryParam requestParam)
static SearchRequest	convertSearchParam(@NonNull SearchParam requestParam)
static HashMap<DataType,String>	getTypeErrorMsg()
static boolean	IsBinaryMetric(MetricType metric)	Checks if a metric is for binary vector.
static boolean	IsFloatMetric(MetricType metric)	Checks if a metric is for float vector.
static boolean	IsVectorIndex(IndexType idx)	Checks if an index type is for vector field.
static boolean	VerifyIndexType(IndexType indexType, DataType dataType)	Checks if an index type is matched with data type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ParamUtils

public ParamUtils()

Method Detail

getTypeErrorMsg

public static HashMap<DataType,String> getTypeErrorMsg()

CheckNullEmptyString

public static void CheckNullEmptyString(String target,
                                        String name)
                                 throws ParamException

Checks if a string is empty or null. Throws ParamException if the string is empty of null.

Parameters:

target - target string

name - a name to describe this string

Throws:

ParamException

CheckNullString

public static void CheckNullString(String target,
                                   String name)
                            throws ParamException

Checks if a string is null. Throws ParamException if the string is null.

Parameters:

target - target string

name - a name to describe this string

Throws:

ParamException

IsFloatMetric

public static boolean IsFloatMetric(MetricType metric)

Checks if a metric is for float vector.

Parameters:

metric - metric type

IsBinaryMetric

public static boolean IsBinaryMetric(MetricType metric)

Checks if a metric is for binary vector.

Parameters:

metric - metric type

IsVectorIndex

public static boolean IsVectorIndex(IndexType idx)

Checks if an index type is for vector field.

Parameters:

idx - index type

VerifyIndexType

public static boolean VerifyIndexType(IndexType indexType,
                                      DataType dataType)

Checks if an index type is matched with data type.

Parameters:

indexType - index type

dataType - data type

convertInsertParam

public static InsertRequest convertInsertParam(@NonNull
                                               @NonNull InsertParam requestParam,
                                               DescCollResponseWrapper wrapper)

convertSearchParam

public static SearchRequest convertSearchParam(@NonNull
                                               @NonNull SearchParam requestParam)
                                        throws ParamException

Throws:

ParamException

convertQueryParam

public static QueryRequest convertQueryParam(@NonNull
                                             @NonNull QueryParam requestParam)

ConvertField

public static FieldType ConvertField(@NonNull
                                     @NonNull FieldSchema field)

Convert a grpc field schema to client field schema

Parameters:

field - FieldSchema object

Returns:

FieldType schema of the field

ConvertField

public static FieldSchema ConvertField(@NonNull
                                       @NonNull FieldType field)

Convert a client field schema to grpc field schema

Parameters:

field - FieldType object

Returns:

FieldSchema schema of the field

AssembleKvPair

public static List<KeyValuePair> AssembleKvPair(Map<String,String> sourceMap)