com.orientechnologies.orient.core.index

Class OIndexTxAware<T>

java.lang.Object

com.orientechnologies.orient.core.index.OIndexAbstractDelegate<T>

com.orientechnologies.orient.core.index.OIndexTxAware<T>

All Implemented Interfaces:

OIndex<T>, Comparable<OIndex<T>>

Direct Known Subclasses:

OIndexTxAwareMultiValue, OIndexTxAwareOneValue

public abstract class OIndexTxAware<T>
extends OIndexAbstractDelegate<T>

Transactional wrapper for indexes. Stores changes locally to the transaction until tx.commit(). All the other operations are delegated to the wrapped OIndex instance.

Author:

Luca Garulli

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OIndexTxAware.PartialSearchMode Indicates search behavior in case of OCompositeKey keys that have less amount of internal keys are used, whether lowest or highest partially matched key should be used.

Field Summary

Fields

Modifier and Type	Field and Description
protected ODatabaseDocumentInternal	database

Fields inherited from class com.orientechnologies.orient.core.index.OIndexAbstractDelegate

delegate

Fields inherited from interface com.orientechnologies.orient.core.index.OIndex

MERGE_KEYS

Constructor Summary

Constructors

Constructor and Description
OIndexTxAware(ODatabaseDocumentInternal iDatabase, OIndex<T> iDelegate)

Method Summary

Modifier and Type	Method and Description
OIndexTxAware<T>	clear() Clears the index removing all the entries in one shot.
protected Object	enhanceCompositeKey(Object key, OIndexTxAware.PartialSearchMode partialSearchMode)
protected Object	enhanceFromCompositeKeyBetweenAsc(Object keyFrom, boolean fromInclusive)
protected Object	enhanceFromCompositeKeyBetweenDesc(Object keyFrom, boolean fromInclusive)
protected Object	enhanceToCompositeKeyBetweenAsc(Object keyTo, boolean toInclusive)
protected Object	enhanceToCompositeKeyBetweenDesc(Object keyTo, boolean toInclusive)
protected Object	getCollatingValue(Object key)
Object	getFirstKey()
Object	getLastKey()
long	getSize()
OIndexTxAware<T>	put(Object iKey, OIdentifiable iValue) Inserts a new entry in the index.
OIndexTxAware<T>	putOnlyClientTrack(Object iKey, OIdentifiable iValue)
boolean	remove(Object key) Removes an entry by its key.
boolean	remove(Object iKey, OIdentifiable iRID) Removes an entry by its key and value.
boolean	removeOnlyClientTrack(Object iKey, OIdentifiable iRID)

Methods inherited from class com.orientechnologies.orient.core.index.OIndexAbstractDelegate

checkEntry, checkForKeyType, compareTo, contains, count, create, cursor, delete, descCursor, equals, flush, get, getAlgorithm, getClusters, getConfiguration, getDatabaseName, getDefinition, getIndexId, getInternal, getKeySize, getKeyTypes, getMetadata, getName, getRebuildVersion, getType, getVersion, hashCode, isAutomatic, isRebuilding, isUnique, iterateEntries, iterateEntriesBetween, iterateEntriesMajor, iterateEntriesMinor, keyCursor, rebuild, rebuild, supportsOrderedIterations, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

database

protected ODatabaseDocumentInternal database

Constructor Detail

OIndexTxAware

public OIndexTxAware(ODatabaseDocumentInternal iDatabase,
                     OIndex<T> iDelegate)

Method Detail

getSize

public long getSize()

Specified by:

getSize in interface OIndex<T>

Overrides:

getSize in class OIndexAbstractDelegate<T>

Returns:

number of entries in the index.

put

public OIndexTxAware<T> put(Object iKey,
                            OIdentifiable iValue)

Description copied from interface: OIndex

Inserts a new entry in the index. The behaviour depends by the index implementation.

Specified by:

put in interface OIndex<T>

Overrides:

put in class OIndexAbstractDelegate<T>

Parameters:

iKey - Entry's key

iValue - Entry's value as OIdentifiable instance

Returns:

The index instance itself to allow in chain calls

putOnlyClientTrack

public OIndexTxAware<T> putOnlyClientTrack(Object iKey,
                                           OIdentifiable iValue)

remove

public boolean remove(Object key)

Description copied from interface: OIndex

Removes an entry by its key.

Specified by:

remove in interface OIndex<T>

Overrides:

remove in class OIndexAbstractDelegate<T>

Parameters:

key - The entry's key to remove

Returns:

True if the entry has been found and removed, otherwise false

remove

public boolean remove(Object iKey,
                      OIdentifiable iRID)

Description copied from interface: OIndex

Removes an entry by its key and value.

Specified by:

remove in interface OIndex<T>

Overrides:

remove in class OIndexAbstractDelegate<T>

Parameters:

iKey - The entry's key to remove

Returns:

True if the entry has been found and removed, otherwise false

removeOnlyClientTrack

public boolean removeOnlyClientTrack(Object iKey,
                                     OIdentifiable iRID)

clear

public OIndexTxAware<T> clear()

Description copied from interface: OIndex

Clears the index removing all the entries in one shot.

Specified by:

clear in interface OIndex<T>

Overrides:

clear in class OIndexAbstractDelegate<T>

Returns:

The index instance itself to allow in chain calls

getFirstKey

public Object getFirstKey()

Specified by:

getFirstKey in interface OIndex<T>

Overrides:

getFirstKey in class OIndexAbstractDelegate<T>

getLastKey

public Object getLastKey()

Specified by:

getLastKey in interface OIndex<T>

Overrides:

getLastKey in class OIndexAbstractDelegate<T>

enhanceCompositeKey

protected Object enhanceCompositeKey(Object key,
                                     OIndexTxAware.PartialSearchMode partialSearchMode)

enhanceToCompositeKeyBetweenAsc

protected Object enhanceToCompositeKeyBetweenAsc(Object keyTo,
                                                 boolean toInclusive)

enhanceFromCompositeKeyBetweenAsc

protected Object enhanceFromCompositeKeyBetweenAsc(Object keyFrom,
                                                   boolean fromInclusive)

enhanceToCompositeKeyBetweenDesc

protected Object enhanceToCompositeKeyBetweenDesc(Object keyTo,
                                                  boolean toInclusive)

enhanceFromCompositeKeyBetweenDesc

protected Object enhanceFromCompositeKeyBetweenDesc(Object keyFrom,
                                                    boolean fromInclusive)

getCollatingValue

protected Object getCollatingValue(Object key)