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()
boolean	contains(Object key)
void	create(OAtomicOperation atomicOperation, OBinarySerializer valueSerializer, boolean isAutomatic, OType[] keyTypes, boolean nullPointerSupport, OBinarySerializer keySerializer, int keySize, Set<String> clustersToIndex, Map<String,String> engineProperties, ODocument metadata, OEncryption encryption)
OIndexCursor	cursor(OBaseIndexEngine.ValuesTransformer valuesTransformer)
void	delete(OAtomicOperation atomicOperation)
void	deleteWithoutLoad(OAtomicOperation atomicOperation, String indexName)
OIndexCursor	descCursor(OBaseIndexEngine.ValuesTransformer valuesTransformer)
void	flush()
Object	get(Object key)
int	getEngineAPIVersion()
Object	getFirstKey()
String	getIndexNameByKey(Object key)
Object	getLastKey()
String	getName()
int	getVersion()
boolean	hasRangeQuerySupport()
void	init(String indexName, String indexType, OIndexDefinition indexDefinition, boolean isAutomatic, ODocument metadata)
OIndexCursor	iterateEntriesBetween(Object rangeFrom, boolean fromInclusive, Object rangeTo, boolean toInclusive, boolean ascSortOrder, OBaseIndexEngine.ValuesTransformer transformer)
OIndexCursor	iterateEntriesMajor(Object fromKey, boolean isInclusive, boolean ascSortOrder, OBaseIndexEngine.ValuesTransformer transformer)
OIndexCursor	iterateEntriesMinor(Object toKey, boolean isInclusive, boolean ascSortOrder, OBaseIndexEngine.ValuesTransformer transformer)
OIndexKeyCursor	keyCursor()
boolean	remove(OAtomicOperation atomicOperation, Object key)
long	size(OBaseIndexEngine.ValuesTransformer transformer)

Method Detail

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,
            Set<String> clustersToIndex,
            Map<String,String> engineProperties,
            ODocument metadata,
            OEncryption encryption)
     throws IOException

Throws:

IOException

delete

void delete(OAtomicOperation atomicOperation)
     throws IOException

Throws:

IOException

deleteWithoutLoad

void deleteWithoutLoad(OAtomicOperation atomicOperation,
                       String indexName)
                throws IOException

Throws:

IOException

contains

boolean contains(Object key)

clear

void clear(OAtomicOperation atomicOperation)
    throws IOException

Throws:

IOException

close

void close()

get

Object get(Object key)

remove

boolean remove(OAtomicOperation atomicOperation,
               Object key)
        throws IOException

Throws:

IOException

getFirstKey

Object getFirstKey()

getLastKey

Object getLastKey()

iterateEntriesBetween

OIndexCursor iterateEntriesBetween(Object rangeFrom,
                                   boolean fromInclusive,
                                   Object rangeTo,
                                   boolean toInclusive,
                                   boolean ascSortOrder,
                                   OBaseIndexEngine.ValuesTransformer transformer)

iterateEntriesMajor

OIndexCursor iterateEntriesMajor(Object fromKey,
                                 boolean isInclusive,
                                 boolean ascSortOrder,
                                 OBaseIndexEngine.ValuesTransformer transformer)

iterateEntriesMinor

OIndexCursor iterateEntriesMinor(Object toKey,
                                 boolean isInclusive,
                                 boolean ascSortOrder,
                                 OBaseIndexEngine.ValuesTransformer transformer)

cursor

OIndexCursor cursor(OBaseIndexEngine.ValuesTransformer valuesTransformer)

descCursor

OIndexCursor descCursor(OBaseIndexEngine.ValuesTransformer valuesTransformer)

keyCursor

OIndexKeyCursor keyCursor()

size

long size(OBaseIndexEngine.ValuesTransformer transformer)

hasRangeQuerySupport

boolean hasRangeQuerySupport()

getVersion

int getVersion()

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)