Package com.kuzudb

Class KuzuStruct

java.lang.Object

com.kuzudb.KuzuStruct

All Implemented Interfaces:

AutoCloseable

public class KuzuStruct
extends Object
implements AutoCloseable

Constructor Summary

Constructors

Constructor	Description
KuzuStruct(Value value)	Construct a struct from a value
KuzuStruct(String[] fieldNames, Value[] fieldValues)	Construct a struct literal from a given set of fields.
KuzuStruct(Map<String,Value> fields)	Construct a struct literal from a given set of fields represented as a Java map.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this object, relinquishing the underlying value
String	getFieldNameByIndex(long index)	Get the name of the field at the given index
long	getIndexByFieldName(String fieldName)	Get the index of the field with the given name
long	getNumFields()
Value	getValue()
Value	getValueByFieldName(String fieldName)	Get the value of the field with the given name
Value	getValueByIndex(long index)	Get the value of the field at the given index
Map<String,Value>	toMap()	Gets the elements the struct as a Java map.

Methods inherited from class java.lang.Object

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

Constructor Details

KuzuStruct

public KuzuStruct(Value value)

Construct a struct from a value

Parameters:

value - the value to construct the struct from

KuzuStruct

public KuzuStruct(Map<String,Value> fields)
           throws ObjectRefDestroyedException

Construct a struct literal from a given set of fields represented as a Java map.

Parameters:

fields - : The fields of the struct, with the keys representing the field names and the values representing the field values.

Throws:

ObjectRefDestroyedException

KuzuStruct

public KuzuStruct(String[] fieldNames,
 Value[] fieldValues)
           throws ObjectRefDestroyedException

Construct a struct literal from a given set of fields. The length of the fieldName/fieldValue arrays must be the same.

Parameters:

fieldNames - : The name of the struct fields

fieldValues - : The values of the struct fields

Throws:

ObjectRefDestroyedException

Method Details

getValue

public Value getValue()

Returns:

Gets the underlying Value for the struct

getNumFields

public long getNumFields()
                  throws ObjectRefDestroyedException

Returns:

The number of fields in the struct.

Throws:

ObjectRefDestroyedException - If the struct has been destroyed.

getIndexByFieldName

public long getIndexByFieldName(String fieldName)
                         throws ObjectRefDestroyedException

Get the index of the field with the given name

Parameters:

fieldName - : The name of the field.

Returns:

The index of the field with the given name, or -1 if it doesn't exist

Throws:

ObjectRefDestroyedException - If the struct has been destroyed.

getFieldNameByIndex

public String getFieldNameByIndex(long index)
                           throws ObjectRefDestroyedException

Get the name of the field at the given index

Parameters:

index - : The index of the field.

Returns:

The name of the field at the given index

Throws:

ObjectRefDestroyedException - If the struct has been destroyed.

getValueByFieldName

public Value getValueByFieldName(String fieldName)
                          throws ObjectRefDestroyedException

Get the value of the field with the given name

Parameters:

fieldName - : The name of the field.

Returns:

The value of the field with the given name value.

Throws:

ObjectRefDestroyedException - If the struct has been destroyed.

getValueByIndex

public Value getValueByIndex(long index)
                      throws ObjectRefDestroyedException

Get the value of the field at the given index

Parameters:

index - : The index of the field.

Returns:

The value of the field at the given index value.

Throws:

ObjectRefDestroyedException - If the struct has been destroyed.

toMap

public Map<String,Value> toMap()
                        throws ObjectRefDestroyedException

Gets the elements the struct as a Java map. This will be truncated if the number of fields doesn't fit in a 32-bit integer.

Returns:

the struct as a Java map

Throws:

ObjectRefDestroyedException

close

public void close()
           throws ObjectRefDestroyedException

Closes this object, relinquishing the underlying value

Specified by:

close in interface AutoCloseable

Throws:

ObjectRefDestroyedException