Package org.apache.polaris.persistence.nosql.api.index

Interface ModifiableIndex<V>

All Superinterfaces:

Index<V>, Iterable<Map.Entry<IndexKey,V>>

All Known Subinterfaces:

UpdatableIndex<V>

public interface ModifiableIndex<V>
extends Index<V>

Represents an Index that can be modified using put and remove functions.

Method Summary

Modifier and Type	Method	Description
boolean	put(IndexKey key, V value)	Adds the given key element or updates the ObjRef if the IndexKey already existed.
boolean	remove(IndexKey key)	Removes the index element for the given key.

Methods inherited from interface org.apache.polaris.persistence.nosql.api.index.Index

contains, get, iterator, iterator, prefetchIfNecessary, reverseIterator, reverseIterator

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Details

put

boolean put(@Nonnull
 IndexKey key,
 @Nonnull
 V value)

Adds the given key element or updates the ObjRef if the IndexKey already existed.

Returns:

true if the IndexKey didn't exist or false if the key was already present and the operation only updated the ObjRef.

remove

boolean remove(@Nonnull
 IndexKey key)

Removes the index element for the given key.

Returns:

true if the IndexKey did exist and was removed, false otherwise.