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

Class OSBTreeIndexEngine

java.lang.Object

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

All Implemented Interfaces:

OBaseIndexEngine, OIndexEngine

public class OSBTreeIndexEngine
extends Object
implements OIndexEngine

Since:

8/30/13

Author:

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DATA_FILE_EXTENSION
static final String	NULL_BUCKET_FILE_EXTENSION
static final int	VERSION

Constructor Summary

Constructors

Constructor	Description
OSBTreeIndexEngine(int id, String name, OAbstractPaginatedStorage storage, int version)

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.
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()
Object	get(Object key)
int	getId()
String	getIndexNameByKey(Object key)
String	getName()
int	getUniqueIndexVersion(Object key)
boolean	hasRangeQuerySupport()
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, Object value)
boolean	remove(OAtomicOperation atomicOperation, Object key)
long	size(IndexEngineValuesTransformer transformer)
Stream<ORawPair<Object,ORID>>	stream(IndexEngineValuesTransformer valuesTransformer)
void	update(OAtomicOperation atomicOperation, Object key, OIndexKeyUpdater<Object> updater)
void	updateUniqueIndexVersion(Object key)
boolean	validatedPut(OAtomicOperation atomicOperation, Object key, ORID value, IndexEngineValidator<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

Field Details

VERSION

public static final int VERSION

See Also:

• Constant Field Values

DATA_FILE_EXTENSION

public static final String DATA_FILE_EXTENSION

See Also:

• Constant Field Values

NULL_BUCKET_FILE_EXTENSION

public static final String NULL_BUCKET_FILE_EXTENSION

See Also:

• Constant Field Values

Constructor Details

OSBTreeIndexEngine

public OSBTreeIndexEngine(int id,
 String name,
 OAbstractPaginatedStorage storage,
 int version)

Method Details

getId

public int getId()

Specified by:

getId in interface OBaseIndexEngine

init

public void init(OIndexMetadata metadata)

Specified by:

init in interface OBaseIndexEngine

getName

public String getName()

Specified by:

getName in interface OBaseIndexEngine

flush

public void flush()

Specified by:

flush in interface OBaseIndexEngine

create

public void create(OAtomicOperation atomicOperation,
 IndexEngineData data)
            throws IOException

Specified by:

create in interface OBaseIndexEngine

Throws:

IOException

delete

public void delete(OAtomicOperation atomicOperation)

Specified by:

delete in interface OBaseIndexEngine

load

public void load(IndexEngineData data)

Specified by:

load in interface OBaseIndexEngine

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

stream

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

Specified by:

stream in interface OBaseIndexEngine

descStream

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

Specified by:

descStream in interface OBaseIndexEngine

keyStream

public Stream<Object> keyStream()

Specified by:

keyStream in interface OBaseIndexEngine

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,
 IndexEngineValidator<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

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.

See Also:

• IndexEngineValidator.validate(Object, Object, Object)

iterateEntriesBetween

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

Specified by:

iterateEntriesBetween in interface OBaseIndexEngine

iterateEntriesMajor

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

Specified by:

iterateEntriesMajor in interface OBaseIndexEngine

iterateEntriesMinor

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

Specified by:

iterateEntriesMinor in interface OBaseIndexEngine

size

public long size(IndexEngineValuesTransformer transformer)

Specified by:

size in interface OBaseIndexEngine

hasRangeQuerySupport

public boolean hasRangeQuerySupport()

Specified by:

hasRangeQuerySupport 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.

getIndexNameByKey

public String getIndexNameByKey(Object key)

Specified by:

getIndexNameByKey in interface OBaseIndexEngine

updateUniqueIndexVersion

public void updateUniqueIndexVersion(Object key)

Specified by:

updateUniqueIndexVersion in interface OBaseIndexEngine

getUniqueIndexVersion

public int getUniqueIndexVersion(Object key)

Specified by:

getUniqueIndexVersion in interface OBaseIndexEngine

hasRidBagTreesSupport

public boolean hasRidBagTreesSupport()

Specified by:

hasRidBagTreesSupport in interface OBaseIndexEngine