public final class Findex extends FindexBase
FindexBase.IndexRequest<SELF extends FindexBase.IndexRequest<SELF>>, FindexBase.SearchRequest<SELF extends FindexBase.SearchRequest<SELF>>| Constructor and Description |
|---|
Findex(byte[] key,
String label,
EntryTableDatabase entryTable,
ChainTableDatabase chainTable)
Instantiate Findex using a custom backend.
|
Findex(byte[] key,
String label,
int entryTableNumber,
EntryTableDatabase entryTable,
ChainTableDatabase chainTable)
Instantiate Findex using a custom backend.
|
Findex(String label,
String token,
String url)
Instantiate Findex using a REST backend.
|
Findex(String label,
String token,
String entryUrl,
String chainUrl)
Instantiate Findex using a REST backend.
|
| Modifier and Type | Method and Description |
|---|---|
KeywordSet |
add(Map<IndexedValue,Set<Keyword>> associations)
Add the given associations to the index.
|
void |
compact(byte[] newKey,
String newLabel)
Compact the index.
|
void |
compact(byte[] newKey,
String newLabel,
DataFilter dataFilter)
Compact the index.
|
void |
compact(byte[] newKey,
String newLabel,
double compactingRate)
Compact the index.
|
void |
compact(byte[] newKey,
String newLabel,
double compactingRate,
DataFilter dataFilter)
Compact the index.
|
KeywordSet |
deletion(Map<IndexedValue,Set<Keyword>> associations)
Remove the given associations from the index.
|
SearchResults |
search(Set<Keyword> keywords)
Search the index for the given keywords, without interruption.
|
SearchResults |
search(Set<Keyword> keywords,
Interrupt interrupt)
Search the index for the given keywords.
|
SearchResults |
search(String[] keywords)
Search the index for the given keywords, without interruption.
|
SearchResults |
search(String[] keywords,
Interrupt interrupt)
Search the index for the given keywords.
|
get_last_error, get_last_error, set_error, unwrappublic Findex(byte[] key,
String label,
int entryTableNumber,
EntryTableDatabase entryTable,
ChainTableDatabase chainTable)
throws CloudproofException
The implementation of both the Entry Table and the Chain Table passed as arguments is used in to manipulate the index.
key - Findex key used to encrypt the indexlabel - a public label used to allow compact operation without key rotationentryTableNumber - the number of Entry Table used as backendentryTable - Entry Table implementationchainTable - Chain Table implementationCloudproofException - if anything goes wrongpublic Findex(byte[] key,
String label,
EntryTableDatabase entryTable,
ChainTableDatabase chainTable)
throws CloudproofException
The implementation of both the Entry Table and the Chain Table passed as arguments is used in to manipulate the index.
key - Findex key used to encrypt the indexlabel - a public label used to allow compact operation without key rotationentryTable - Entry Table implementationchainTable - Chain Table implementationCloudproofException - if anything goes wrongpublic Findex(String label, String token, String entryUrl, String chainUrl) throws CloudproofException
All manipulation of indexes is delegated to a server implementing the Findex REST API.
label - a public label used to allow compact operation without key rotationtoken - token used for authentication to the Findex REST serverentryUrl - URL of the Findex Entry Table REST serverchainUrl - URL of the Findex Chain Table REST serverCloudproofException - if anything goes wrongpublic Findex(String label, String token, String url) throws CloudproofException
All manipulation of indexes is delegated to a server implementing the Findex REST API.
label - a public label used to allow compact operation without key rotationtoken - token used for authentication to the Findex REST serverurl - URL of the Findex REST serverCloudproofException - if anything goes wrongpublic KeywordSet add(Map<IndexedValue,Set<Keyword>> associations) throws CloudproofException
associations - Map of IndexedValue to Set of KeywordKeywordSet of new keywords added to the indexCloudproofException - if anything goes wrongpublic KeywordSet deletion(Map<IndexedValue,Set<Keyword>> associations) throws CloudproofException
associations - Map of IndexedValue to Set of KeywordKeywordSet of new keywords added to the indexCloudproofException - if anything goes wrongpublic SearchResults search(Set<Keyword> keywords, Interrupt interrupt) throws CloudproofException
keywords - a Set of Keyword to searchinterrupt - an implementation of the Interrupt interfaceSearchResultsCloudproofException - if anything goes wrongpublic SearchResults search(Set<Keyword> keywords) throws CloudproofException
keywords - a Set of Keyword to searchSearchResultsCloudproofException - if anything goes wrongpublic SearchResults search(String[] keywords) throws CloudproofException
keywords - an array of String representing the keywords to searchSearchResultsCloudproofException - if anything goes wrongpublic SearchResults search(String[] keywords, Interrupt interrupt) throws CloudproofException
keywords - an array of String representing the keywords to searchinterrupt - an implementation of the Interrupt interfaceSearchResultsCloudproofException - if anything goes wrongpublic void compact(byte[] newKey,
String newLabel,
double compactingRate,
DataFilter dataFilter)
throws CloudproofException
At least one of the Findex key or label needs to be changed during this operation.
newKey - key to use as replacement to the current Findex key.newLabel - label to use as replacement to the current Findex label.compactingRate - minimal portion of the index to compactdataFilter - implementation of the DataFilter interfaceCloudproofException - if anything goes wrongpublic void compact(byte[] newKey,
String newLabel,
double compactingRate)
throws CloudproofException
At least one of the Findex key or label needs to be changed during this operation.
No filter is applied on the list of locations collected during the compact operation.
newKey - key to use as replacement to the current Findex key.newLabel - label to use as replacement to the current Findex label.compactingRate - number of compact operation to run before going through the entire Chain Table (on
average).CloudproofException - if anything goes wrongpublic void compact(byte[] newKey,
String newLabel,
DataFilter dataFilter)
throws CloudproofException
At least one of the Findex key or label needs to be changed during this operation.
newKey - key to use as replacement to the current Findex key.newLabel - label to use as replacement to the current Findex label.dataFilter - implementation of the DataFilter interfaceCloudproofException - if anything goes wrongpublic void compact(byte[] newKey,
String newLabel)
throws CloudproofException
At least one of the Findex key or label needs to be changed during this operation.
newKey - key to use as replacement to the current Findex key.newLabel - label to use as replacement to the current Findex label.CloudproofException - if anything goes wrongCopyright © 2023. All rights reserved.