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, OLuceneFullTextIndexEngine, OLuceneGeoSpatialIndexEngine, OLuceneIndexEngineAbstract, OLuceneLegacySpatialIndexEngine, OLuceneSpatialIndexEngineAbstract, OLuceneSpatialIndexEngineDelegator, ORemoteIndexEngine, OSBTreeIndexEngine

public interface OBaseIndexEngine

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	OBaseIndexEngine.Validator<K,V> Put operation validator.
static interface	OBaseIndexEngine.ValuesTransformer

Method Summary

Modifier and Type	Method and Description
boolean	acquireAtomicExclusiveLock(Object key) Acquires exclusive lock in the active atomic operation running on the current thread for this index engine.
void	clear(OAtomicOperation atomicOperation)
void	close()
void	create(OAtomicOperation atomicOperation, OBinarySerializer valueSerializer, boolean isAutomatic, OType[] keyTypes, boolean nullPointerSupport, OBinarySerializer keySerializer, int keySize, Map<String,String> engineProperties, OEncryption encryption)
void	delete(OAtomicOperation atomicOperation)
Stream<ORawPair<Object,ORID>>	descStream(OBaseIndexEngine.ValuesTransformer valuesTransformer)
void	flush()
int	getEngineAPIVersion()
int	getId()
String	getIndexNameByKey(Object key)
String	getName()
boolean	hasRangeQuerySupport()
void	init(String indexName, String indexType, OIndexDefinition indexDefinition, boolean isAutomatic, ODocument metadata)
Stream<ORawPair<Object,ORID>>	iterateEntriesBetween(Object rangeFrom, boolean fromInclusive, Object rangeTo, boolean toInclusive, boolean ascSortOrder, OBaseIndexEngine.ValuesTransformer transformer)
Stream<ORawPair<Object,ORID>>	iterateEntriesMajor(Object fromKey, boolean isInclusive, boolean ascSortOrder, OBaseIndexEngine.ValuesTransformer transformer)
Stream<ORawPair<Object,ORID>>	iterateEntriesMinor(Object toKey, boolean isInclusive, boolean ascSortOrder, OBaseIndexEngine.ValuesTransformer transformer)
Stream<Object>	keyStream()
long	size(OBaseIndexEngine.ValuesTransformer transformer)
Stream<ORawPair<Object,ORID>>	stream(OBaseIndexEngine.ValuesTransformer valuesTransformer)

Method Detail

getId

int getId()

init

void init(String indexName,
          String indexType,
          OIndexDefinition indexDefinition,
          boolean isAutomatic,
          ODocument metadata)

flush

void flush()

create

void create(OAtomicOperation atomicOperation,
            OBinarySerializer valueSerializer,
            boolean isAutomatic,
            OType[] keyTypes,
            boolean nullPointerSupport,
            OBinarySerializer keySerializer,
            int keySize,
            Map<String,String> engineProperties,
            OEncryption encryption)
     throws IOException

Throws:

IOException

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,
                                                    OBaseIndexEngine.ValuesTransformer transformer)

iterateEntriesMajor

Stream<ORawPair<Object,ORID>> iterateEntriesMajor(Object fromKey,
                                                  boolean isInclusive,
                                                  boolean ascSortOrder,
                                                  OBaseIndexEngine.ValuesTransformer transformer)

iterateEntriesMinor

Stream<ORawPair<Object,ORID>> iterateEntriesMinor(Object toKey,
                                                  boolean isInclusive,
                                                  boolean ascSortOrder,
                                                  OBaseIndexEngine.ValuesTransformer transformer)

stream

Stream<ORawPair<Object,ORID>> stream(OBaseIndexEngine.ValuesTransformer valuesTransformer)

descStream

Stream<ORawPair<Object,ORID>> descStream(OBaseIndexEngine.ValuesTransformer valuesTransformer)

keyStream

Stream<Object> keyStream()

size

long size(OBaseIndexEngine.ValuesTransformer 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)