com.orientechnologies.orient.core.storage.index.engine

Class ORemoteIndexEngine

java.lang.Object

com.orientechnologies.orient.core.storage.index.engine.ORemoteIndexEngine

All Implemented Interfaces:

OBaseIndexEngine, OIndexEngine

public class ORemoteIndexEngine
extends Object
implements OIndexEngine

Since:

18.07.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 inherited from interface com.orientechnologies.orient.core.index.engine.OIndexEngine

VERSION

Constructor Summary

Constructors

Constructor and Description
ORemoteIndexEngine(int id, String name)

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()
Object	get(Object key)
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()
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)
long	size(OBaseIndexEngine.ValuesTransformer transformer)
Stream<ORawPair<Object,ORID>>	stream(OBaseIndexEngine.ValuesTransformer valuesTransformer)
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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getEngineAPIVersion

Constructor Detail

ORemoteIndexEngine

public ORemoteIndexEngine(int id,
                          String name)

Method Detail

getId

public int getId()

Specified by:

getId in interface OBaseIndexEngine

getName

public String getName()

Specified by:

getName in interface OBaseIndexEngine

getIndexNameByKey

public String getIndexNameByKey(Object key)

Specified by:

getIndexNameByKey in interface OBaseIndexEngine

init

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

Specified by:

init in interface OBaseIndexEngine

flush

public void flush()

Specified by:

flush in interface OBaseIndexEngine

create

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

Specified by:

create in interface OBaseIndexEngine

delete

public void delete(OAtomicOperation atomicOperation)

Specified by:

delete in interface OBaseIndexEngine

load

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

Specified by:

load in interface OIndexEngine

remove

public boolean remove(OAtomicOperation atomicOperation,
                      Object key)

Specified by:

remove in interface OIndexEngine

clear

public void clear(OAtomicOperation atomicOperation)

Specified by:

clear in interface OBaseIndexEngine

close

public void close()

Specified by:

close in interface OBaseIndexEngine

get

public Object get(Object key)

Specified by:

get in interface OIndexEngine

put

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

Specified by:

put in interface OIndexEngine

update

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

Specified by:

update in interface OIndexEngine

validatedPut

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

Description copied from interface: OIndexEngine

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

Specified by:

validatedPut in interface OIndexEngine

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.

See Also:

Validator#validate(Object, Object, Object)

iterateEntriesBetween

public Stream<ORawPair<Object,ORID>> iterateEntriesBetween(Object rangeFrom,
                                                           boolean fromInclusive,
                                                           Object rangeTo,
                                                           boolean toInclusive,
                                                           boolean ascSortOrder,
                                                           OBaseIndexEngine.ValuesTransformer transformer)

Specified by:

iterateEntriesBetween in interface OBaseIndexEngine

iterateEntriesMajor

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

Specified by:

iterateEntriesMajor in interface OBaseIndexEngine

iterateEntriesMinor

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

Specified by:

iterateEntriesMinor in interface OBaseIndexEngine

size

public long size(OBaseIndexEngine.ValuesTransformer transformer)

Specified by:

size in interface OBaseIndexEngine

hasRangeQuerySupport

public boolean hasRangeQuerySupport()

Specified by:

hasRangeQuerySupport in interface OBaseIndexEngine

stream

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

Specified by:

stream in interface OBaseIndexEngine

descStream

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

Specified by:

descStream in interface OBaseIndexEngine

keyStream

public Stream<Object> keyStream()

Specified by:

keyStream in interface OBaseIndexEngine

acquireAtomicExclusiveLock

public boolean acquireAtomicExclusiveLock(Object key)

Description copied from interface: OBaseIndexEngine

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.

Specified by:

acquireAtomicExclusiveLock in interface OBaseIndexEngine

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.