Package com.kuzudb

Class KuzuMap

java.lang.Object

com.kuzudb.KuzuMap

All Implemented Interfaces:

AutoCloseable

public class KuzuMap
extends Object
implements AutoCloseable

Constructor Summary

Constructors

Constructor	Description
KuzuMap(Value value)	Construct a map from a value
KuzuMap(Value[] keys, Value[] values)	Construct a map literal from a given set of keys/values.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this object, relinquishing the underlying value
Value	getKey(long index)	Get the key at the given index.
long	getNumFields()
Value	getValue()
Value	getValue(long index)	Get the value at the given index.

Methods inherited from class java.lang.Object

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

Constructor Details

KuzuMap

public KuzuMap(Value value)

Construct a map from a value

Parameters:

value - the value to construct the map from

KuzuMap

public KuzuMap(Value[] keys,
 Value[] values)
        throws ObjectRefDestroyedException

Construct a map literal from a given set of keys/values. The length of the key/value arrays must be the same.

Parameters:

keys - : The keys in the map

values - : The values in the map

Throws:

ObjectRefDestroyedException

Method Details

getValue

public Value getValue()

Returns:

Gets the underlying Value for the map

getNumFields

public long getNumFields()
                  throws ObjectRefDestroyedException

Returns:

The number of fields in the map.

Throws:

ObjectRefDestroyedException - If the map has been destroyed.

getKey

public Value getKey(long index)
             throws ObjectRefDestroyedException

Get the key at the given index.

Parameters:

index - : The index of the key.

Returns:

The key.

Throws:

ObjectRefDestroyedException - If the map has been destroyed.

getValue

public Value getValue(long index)
               throws ObjectRefDestroyedException

Get the value at the given index.

Parameters:

index - : The index of the value.

Returns:

The value.

Throws:

ObjectRefDestroyedException - If the map value has been destroyed.

close

public void close()
           throws ObjectRefDestroyedException

Closes this object, relinquishing the underlying value

Specified by:

close in interface AutoCloseable

Throws:

ObjectRefDestroyedException