Interface OBaseIndexEngine
- All Known Subinterfaces:
OCellBTreeIndexEngine,OIndexEngine,OLuceneIndexEngine,OMultiValueIndexEngine,OSingleValueIndexEngine,OV1IndexEngine
- All Known Implementing Classes:
OAutoShardingIndexEngine,OCellBTreeMultiValueIndexEngine,OCellBTreeSingleValueIndexEngine,OHashTableIndexEngine,OLuceneCrossClassIndexEngine,OLuceneFullTextIndexEngine,OLuceneGeoSpatialIndexEngine,OLuceneIndexEngineAbstract,OLuceneLegacySpatialIndexEngine,OLuceneSpatialIndexEngineAbstract,OLuceneSpatialIndexEngineDelegator,ORemoteIndexEngine,OSBTreeIndexEngine
public interface OBaseIndexEngine
-
Method Summary
Modifier and TypeMethodDescriptionbooleanAcquires exclusive lock in the active atomic operation running on the current thread for this index engine.default voidapplyTxChanges(OAtomicOperation atomicOperation, OStorageTransactionIndexChanges changes) voidclear(OAtomicOperation atomicOperation) voidclose()voidcreate(OAtomicOperation atomicOperation, IndexEngineData data) voiddelete(OAtomicOperation atomicOperation) descStream(IndexEngineValuesTransformer valuesTransformer) voidflush()intintgetId()getIndexNameByKey(Object key) getName()intbooleandefault booleanvoidinit(OIndexMetadata metadata) iterateEntriesBetween(Object rangeFrom, boolean fromInclusive, Object rangeTo, boolean toInclusive, boolean ascSortOrder, IndexEngineValuesTransformer transformer) iterateEntriesMajor(Object fromKey, boolean isInclusive, boolean ascSortOrder, IndexEngineValuesTransformer transformer) iterateEntriesMinor(Object toKey, boolean isInclusive, boolean ascSortOrder, IndexEngineValuesTransformer transformer) voidload(IndexEngineData data) voidput(OAtomicOperation atomicOperation, Object key, ORID value) booleanremove(OAtomicOperation atomicOperation, Object key) booleanremove(OAtomicOperation atomicOperation, Object key, ORID value) longsize(IndexEngineValuesTransformer transformer) stream(IndexEngineValuesTransformer valuesTransformer) voidbooleanvalidatedPut(OAtomicOperation atomicOperation, Object key, ORID value, IndexEngineValidator<Object, ORID> validator)
-
Method Details
-
getId
int getId() -
init
-
flush
void flush() -
create
- Throws:
IOException
-
load
-
delete
- Throws:
IOException
-
clear
- Throws:
IOException
-
close
void close() -
iterateEntriesBetween
-
iterateEntriesMajor
-
iterateEntriesMinor
-
stream
-
descStream
-
keyStream
-
size
-
hasRangeQuerySupport
boolean hasRangeQuerySupport() -
getEngineAPIVersion
int getEngineAPIVersion() -
getName
String getName() -
acquireAtomicExclusiveLock
Acquires exclusive lock in the active atomic operation running on the current thread for this index engine.If this index engine supports a more narrow locking, for example key-based sharding, it may use the provided
keyto infer a more narrow lock scope, but that is not a requirement.- Parameters:
key- the index key to lock.- Returns:
trueif this index was locked entirely,falseif this index locking is sensitive to the providedkeyand only some subset of this index was locked.
-
getIndexNameByKey
-
updateUniqueIndexVersion
-
getUniqueIndexVersion
-
hasRidBagTreesSupport
default boolean hasRidBagTreesSupport() -
put
-
remove
-
remove
-
validatedPut
boolean validatedPut(OAtomicOperation atomicOperation, Object key, ORID value, IndexEngineValidator<Object, ORID> validator) -
applyTxChanges
default void applyTxChanges(OAtomicOperation atomicOperation, OStorageTransactionIndexChanges changes)
-