com.orientechnologies.orient.core.index.engine

Interface OIndexEngine

All Superinterfaces:

OBaseIndexEngine

All Known Subinterfaces:

OLuceneIndexEngine

All Known Implementing Classes:

OAutoShardingIndexEngine, OHashTableIndexEngine, OLuceneFullTextIndexEngine, OLuceneGeoSpatialIndexEngine, OLuceneIndexEngineAbstract, OLuceneLegacySpatialIndexEngine, OLuceneSpatialIndexEngineAbstract, OLuceneSpatialIndexEngineDelegator, ORemoteIndexEngine, OSBTreeIndexEngine

public interface OIndexEngine
extends OBaseIndexEngine

Since:

6/29/13

Author:

Andrey Lomakin (a.lomakin-at-orientdb.com)

Nested Class Summary

Nested classes/interfaces inherited from interface com.orientechnologies.orient.core.index.engine.OBaseIndexEngine

OBaseIndexEngine.Validator<K,V>, OBaseIndexEngine.ValuesTransformer

Field Summary

Fields

Modifier and Type	Field and Description
static int	VERSION

Method Summary

Modifier and Type	Method and Description
Object	get(Object key)
default int	getEngineAPIVersion()
void	load(String indexName, OBinarySerializer valueSerializer, boolean isAutomatic, OBinarySerializer keySerializer, OType[] keyTypes, boolean nullPointerSupport, int keySize, Map<String,String> engineProperties, OEncryption encryption)
void	put(OAtomicOperation atomicOperation, Object key, Object value)
boolean	remove(OAtomicOperation atomicOperation, Object key)
void	update(OAtomicOperation atomicOperation, Object key, OIndexKeyUpdater<Object> updater)
boolean	validatedPut(OAtomicOperation atomicOperation, Object key, ORID value, OBaseIndexEngine.Validator<Object,ORID> validator) Puts the given value under the given key into this index engine.

Methods inherited from interface com.orientechnologies.orient.core.index.engine.OBaseIndexEngine

acquireAtomicExclusiveLock, clear, close, create, delete, descStream, flush, getId, getIndexNameByKey, getName, hasRangeQuerySupport, init, iterateEntriesBetween, iterateEntriesMajor, iterateEntriesMinor, keyStream, size, stream

Field Detail

VERSION

static final int VERSION

See Also:

Constant Field Values

Method Detail

get

Object get(Object key)

put

void put(OAtomicOperation atomicOperation,
         Object key,
         Object value)
  throws IOException

Throws:

IOException

update

void update(OAtomicOperation atomicOperation,
            Object key,
            OIndexKeyUpdater<Object> updater)
     throws IOException

Throws:

IOException

remove

boolean remove(OAtomicOperation atomicOperation,
               Object key)
        throws IOException

Throws:

IOException

validatedPut

boolean validatedPut(OAtomicOperation atomicOperation,
                     Object key,
                     ORID value,
                     OBaseIndexEngine.Validator<Object,ORID> validator)
              throws IOException

Puts the given value under the given key into this index engine. Validates the operation using the provided validator.

Parameters:

atomicOperation -

key - the key to put the value under.

value - the value to put.

validator - the operation validator.

Returns:

true if the validator allowed the put, false otherwise.

Throws:

IOException

See Also:

Validator#validate(Object, Object, Object)

getEngineAPIVersion

default int getEngineAPIVersion()

Specified by:

getEngineAPIVersion in interface OBaseIndexEngine

load

void load(String indexName,
          OBinarySerializer valueSerializer,
          boolean isAutomatic,
          OBinarySerializer keySerializer,
          OType[] keyTypes,
          boolean nullPointerSupport,
          int keySize,
          Map<String,String> engineProperties,
          OEncryption encryption)