Package com.orientechnologies.orient.core.index.engine

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 Type	Method	Description
boolean	acquireAtomicExclusiveLock(Object key)	Acquires exclusive lock in the active atomic operation running on the current thread for this index engine.
default void	applyTxChanges(OAtomicOperation atomicOperation, OStorageTransactionIndexChanges changes)
void	clear(OAtomicOperation atomicOperation)
void	close()
void	create(OAtomicOperation atomicOperation, IndexEngineData data)
void	delete(OAtomicOperation atomicOperation)
Stream<ORawPair<Object,ORID>>	descStream(IndexEngineValuesTransformer valuesTransformer)
void	flush()
int	getEngineAPIVersion()
int	getId()
String	getIndexNameByKey(Object key)
String	getName()
int	getUniqueIndexVersion(Object key)
boolean	hasRangeQuerySupport()
default boolean	hasRidBagTreesSupport()
void	init(OIndexMetadata metadata)
Stream<ORawPair<Object,ORID>>	iterateEntriesBetween(Object rangeFrom, boolean fromInclusive, Object rangeTo, boolean toInclusive, boolean ascSortOrder, IndexEngineValuesTransformer transformer)
Stream<ORawPair<Object,ORID>>	iterateEntriesMajor(Object fromKey, boolean isInclusive, boolean ascSortOrder, IndexEngineValuesTransformer transformer)
Stream<ORawPair<Object,ORID>>	iterateEntriesMinor(Object toKey, boolean isInclusive, boolean ascSortOrder, IndexEngineValuesTransformer transformer)
Stream<Object>	keyStream()
void	load(IndexEngineData data)
void	put(OAtomicOperation atomicOperation, Object key, ORID value)
boolean	remove(OAtomicOperation atomicOperation, Object key)
boolean	remove(OAtomicOperation atomicOperation, Object key, ORID value)
long	size(IndexEngineValuesTransformer transformer)
Stream<ORawPair<Object,ORID>>	stream(IndexEngineValuesTransformer valuesTransformer)
void	updateUniqueIndexVersion(Object key)
boolean	validatedPut(OAtomicOperation atomicOperation, Object key, ORID value, IndexEngineValidator<Object,ORID> validator)

Method Details

getId

int getId()

init

void init(OIndexMetadata metadata)

flush

void flush()

create

void create(OAtomicOperation atomicOperation,
 IndexEngineData data)
     throws IOException

Throws:

IOException

load

void load(IndexEngineData data)

delete

void delete(OAtomicOperation atomicOperation)
     throws IOException

Throws:

IOException

clear

void clear(OAtomicOperation atomicOperation)
    throws IOException

Throws:

IOException

close

void close()

iterateEntriesBetween

Stream<ORawPair<Object,ORID>> iterateEntriesBetween(Object rangeFrom,
 boolean fromInclusive,
 Object rangeTo,
 boolean toInclusive,
 boolean ascSortOrder,
 IndexEngineValuesTransformer transformer)

iterateEntriesMajor

Stream<ORawPair<Object,ORID>> iterateEntriesMajor(Object fromKey,
 boolean isInclusive,
 boolean ascSortOrder,
 IndexEngineValuesTransformer transformer)

iterateEntriesMinor

Stream<ORawPair<Object,ORID>> iterateEntriesMinor(Object toKey,
 boolean isInclusive,
 boolean ascSortOrder,
 IndexEngineValuesTransformer transformer)

stream

Stream<ORawPair<Object,ORID>> stream(IndexEngineValuesTransformer valuesTransformer)

descStream

Stream<ORawPair<Object,ORID>> descStream(IndexEngineValuesTransformer valuesTransformer)

keyStream

Stream<Object> keyStream()

size

long size(IndexEngineValuesTransformer transformer)

hasRangeQuerySupport

boolean hasRangeQuerySupport()

getEngineAPIVersion

int getEngineAPIVersion()

getName

String getName()

acquireAtomicExclusiveLock

boolean acquireAtomicExclusiveLock(Object key)

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 key to infer a more narrow lock scope, but that is not a requirement.

Parameters:

key - the index key to lock.

Returns:

true if this index was locked entirely, false if this index locking is sensitive to the provided key and only some subset of this index was locked.

getIndexNameByKey

String getIndexNameByKey(Object key)

updateUniqueIndexVersion

void updateUniqueIndexVersion(Object key)

getUniqueIndexVersion

int getUniqueIndexVersion(Object key)

hasRidBagTreesSupport

default boolean hasRidBagTreesSupport()

put

void put(OAtomicOperation atomicOperation,
 Object key,
 ORID value)

remove

boolean remove(OAtomicOperation atomicOperation,
 Object key)

remove

boolean remove(OAtomicOperation atomicOperation,
 Object key,
 ORID value)

validatedPut

boolean validatedPut(OAtomicOperation atomicOperation,
 Object key,
 ORID value,
 IndexEngineValidator<Object,ORID> validator)

applyTxChanges

default void applyTxChanges(OAtomicOperation atomicOperation,
 OStorageTransactionIndexChanges changes)