com.cosmian.jna.findex

Interface EntryTableDatabase

public interface EntryTableDatabase

Method Summary

Modifier and Type	Method and Description
void	delete(List<Uid32> uids) Delete the lines with the given UIDs.
default FindexNativeWrapper.DeleteCallback	deleteCallback() Return the appropriate upsert callback (with input/output serialization).
default FindexNativeWrapper.DumpTokensCallback	dumpTokenCallback()
List<Tuple<Uid32,EntryTableValue>>	fetch(List<Uid32> uids) Fetch the Entry Table lines for the list of given Uid32.
Set<Uid32>	fetchAllUids() Fetch all the Entry Table Uids.
default FindexNativeWrapper.FetchCallback	fetchCallback() Return the appropriate fetch callback (with input/output serialization).
void	insert(Map<Uid32,EntryTableValue> uidsAndValues) Insert the given lines in the Chain Table.
default FindexNativeWrapper.InsertCallback	insertCallback() Return the appropriate insert callback (with input/output serialization).
Map<Uid32,EntryTableValue>	upsert(Map<Uid32,EntryTableValues> uidsAndValues) Upsert the given lines into the Entry Table.
default FindexNativeWrapper.UpsertCallback	upsertCallback() Return the appropriate upsert callback (with input/output serialization).

Method Detail

fetchAllUids

Set<Uid32> fetchAllUids()
                 throws CloudproofException

Fetch all the Entry Table Uids.

Implementation of this method is only required for the compact operation.

Returns:

the Set of all Uid32

Throws:

CloudproofException - if anything goes wrong

fetch

List<Tuple<Uid32,EntryTableValue>> fetch(List<Uid32> uids)
                                  throws CloudproofException

Fetch the Entry Table lines for the list of given Uid32. If a line does not exist, there should be not entry in the returned map.

Implementation of this method is always required.

Parameters:

uids - the unique Uid32s used as line id

Returns:

a List of Tuple of Uid32 and EntryTableValue

Throws:

CloudproofException - if anything goes wrong

upsert

Map<Uid32,EntryTableValue> upsert(Map<Uid32,EntryTableValues> uidsAndValues)
                           throws CloudproofException

Upsert the given lines into the Entry Table.

The EntryTableValues structure contains both the new value to be upserted and the previous value known at the time of fetch. To avoid concurrency issues, the new value of an existing Uid32 must not be updated if the current value in the database does not match the previous value of the structure. In such a case, the Uid32 and the current database value must be returned as part of the returned Map. *

Implementation of this method is only required to update or compact the index

See the Redis and Sqlite implementations for implementation examples

Parameters:

uidsAndValues - a Map of Uid32 to EntryTableValues

Returns:

a map of the Uid32 that could not be updated and the current database value for the entry.

Throws:

CloudproofException - if anything goes wrong

insert

void insert(Map<Uid32,EntryTableValue> uidsAndValues)
     throws CloudproofException

Insert the given lines in the Chain Table.

Implementation of this method is only required to perform additions, deletions or compact operations on the index.

Parameters:

uidsAndValues - a Map of Uid32 to EntryTableValue

Throws:

CloudproofException - if anything goes wrong

delete

void delete(List<Uid32> uids)
     throws CloudproofException

Delete the lines with the given UIDs.

Parameters:

uids - a List of Uid32

Throws:

CloudproofException - if anything goes wrong

fetchCallback

default FindexNativeWrapper.FetchCallback fetchCallback()

Return the appropriate fetch callback (with input/output serialization).

upsertCallback

default FindexNativeWrapper.UpsertCallback upsertCallback()

Return the appropriate upsert callback (with input/output serialization).

insertCallback

default FindexNativeWrapper.InsertCallback insertCallback()

Return the appropriate insert callback (with input/output serialization).

deleteCallback

default FindexNativeWrapper.DeleteCallback deleteCallback()

Return the appropriate upsert callback (with input/output serialization).

dumpTokenCallback

default FindexNativeWrapper.DumpTokensCallback dumpTokenCallback()