Package io.milvus.response

Class FieldDataWrapper

java.lang.Object

io.milvus.response.FieldDataWrapper

public class FieldDataWrapper
extends Object

Utility class to wrap response of query/search interface.

Constructor Summary

Constructors

Constructor	Description
FieldDataWrapper(@NonNull FieldData fieldData)

Method Summary

Modifier and Type	Method	Description
Object	get(int index, String paramName)	Gets a field's value by field name.
Boolean	getAsBool(int index, String paramName)
Double	getAsDouble(int index, String paramName)
Integer	getAsInt(int index, String paramName)
String	getAsString(int index, String paramName)
int	getDim()	Gets the dimension value of a vector field.
List<?>	getFieldData()	Returns the field data according to its type: FloatVector field returns List of List Float, BinaryVector/Float16Vector/BFloat16Vector fields return List of ByteBuffer SparseFloatVector field returns List of SortedMap[Long, Float] Int64 field returns List of Long Int32/Int16/Int8 fields return List of Integer Bool field returns List of Boolean Float field returns List of Float Double field returns List of Double Varchar field returns List of String Array field returns List of List JSON field returns List of String; etc.
long	getRowCount()	Gets the row count of a field.
boolean	isDynamicField()
boolean	isJsonField()
boolean	isVectorField()
static com.google.gson.JsonElement	ParseJSONObject(Object object)
Object	valueByIdx(int index)
static Object	ValueOfJSONElement(com.google.gson.JsonElement element)

Methods inherited from class java.lang.Object

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

Constructor Details

FieldDataWrapper

public FieldDataWrapper(@NonNull
 @NonNull FieldData fieldData)

Method Details

isVectorField

public boolean isVectorField()

isJsonField

public boolean isJsonField()

isDynamicField

public boolean isDynamicField()

getDim

public int getDim()
           throws IllegalResponseException

Gets the dimension value of a vector field. Throw IllegalResponseException if the field is not a vector filed.

Returns:

int dimension of the vector field

Throws:

IllegalResponseException

getRowCount

public long getRowCount()
                 throws IllegalResponseException

Gets the row count of a field. * Throws IllegalResponseException if the field type is illegal.

Returns:

long row count of the field

Throws:

IllegalResponseException

getFieldData

public List<?> getFieldData()
                     throws IllegalResponseException

Returns the field data according to its type: FloatVector field returns List of List Float, BinaryVector/Float16Vector/BFloat16Vector fields return List of ByteBuffer SparseFloatVector field returns List of SortedMap[Long, Float] Int64 field returns List of Long Int32/Int16/Int8 fields return List of Integer Bool field returns List of Boolean Float field returns List of Float Double field returns List of Double Varchar field returns List of String Array field returns List of List JSON field returns List of String; etc. Throws IllegalResponseException if the field type is illegal.

Returns:

List

Throws:

IllegalResponseException

getAsInt

public Integer getAsInt(int index,
 String paramName)
                 throws IllegalResponseException

Throws:

IllegalResponseException

getAsString

public String getAsString(int index,
 String paramName)
                   throws IllegalResponseException

Throws:

IllegalResponseException

getAsBool

public Boolean getAsBool(int index,
 String paramName)
                  throws IllegalResponseException

Throws:

IllegalResponseException

getAsDouble

public Double getAsDouble(int index,
 String paramName)
                   throws IllegalResponseException

Throws:

IllegalResponseException

get

public Object get(int index,
 String paramName)
           throws IllegalResponseException

Gets a field's value by field name.

Parameters:

index - which row

paramName - which field

Returns:

returns Long for integer value, returns Double for decimal value, returns String for string value, returns JsonElement for JSON object and Array.

Throws:

IllegalResponseException

valueByIdx

public Object valueByIdx(int index)
                  throws ParamException

Throws:

ParamException

ParseJSONObject

public static com.google.gson.JsonElement ParseJSONObject(Object object)

ValueOfJSONElement

public static Object ValueOfJSONElement(com.google.gson.JsonElement element)