com.orientechnologies.orient.core.index

Class OIndexTxAware<T>

java.lang.Object

com.orientechnologies.orient.core.index.OIndexAbstractDelegate

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

All Implemented Interfaces:

OIndex, OIndexInternal, Comparable<OIndex>

Direct Known Subclasses:

OIndexTxAwareMultiValue, OIndexTxAwareOneValue

public abstract class OIndexTxAware<T>
extends OIndexAbstractDelegate

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 (l.garulli--(at)--orientdb.com)

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

ALGORITHM, CONFIG_AUTOMATIC, CONFIG_KEYTYPE, CONFIG_NAME, CONFIG_TYPE, INDEX_DEFINITION, INDEX_DEFINITION_CLASS, INDEX_VERSION, METADATA, VALUE_CONTAINER_ALGORITHM

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

MERGE_KEYS

Constructor Summary

Constructors

Constructor and Description
OIndexTxAware(ODatabaseDocumentInternal database, OIndexInternal delegate)

Method Summary

Modifier and Type	Method and Description
OIndexTxAware<T>	clear() Clears the index removing all the entries in one shot.
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)
OIndexTxAware<T>	put(Object key, OIdentifiable value) Inserts a new entry in the index.
boolean	remove(Object key) Removes an entry by its key.
boolean	remove(Object key, OIdentifiable rid) Removes an entry by its key and value.
long	size()

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

acquireAtomicExclusiveLock, addCluster, addTxOperation, canBeUsedInEqualityOperators, checkForKeyType, close, commit, compareTo, count, create, cursor, delete, descCursor, descStream, doPut, doRemove, doRemove, equals, flush, get, getAlgorithm, getClusters, getCollatingValue, getConfiguration, getDatabaseName, getDefinition, getFirstKey, getIndexId, getIndexNameByKey, getInternal, getKeySize, getKeyTypes, getLastKey, getMetadata, getName, getRebuildVersion, getRids, getSize, getType, getVersion, hashCode, hasRangeQuerySupport, interpretTxKeyChanges, isAutomatic, isNativeTxSupported, isRebuilding, isUnique, iterateEntries, iterateEntriesBetween, iterateEntriesMajor, iterateEntriesMinor, keyCursor, keyStream, loadFromConfiguration, loadMetadata, postCommit, preCommit, rebuild, rebuild, removeCluster, setType, stream, streamEntries, streamEntriesBetween, streamEntriesMajor, streamEntriesMinor, supportsOrderedIterations, toString, updateConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.orientechnologies.orient.core.index.OIndexInternal

isLabelSecurityDefined, isReadRestrictedBySecurityPolicy, securityFilterOnRead, securityFilterOnRead

Field Detail

database

protected ODatabaseDocumentInternal database

Constructor Detail

OIndexTxAware

public OIndexTxAware(ODatabaseDocumentInternal database,
                     OIndexInternal delegate)

Method Detail

size

public long size()

Specified by:

size in interface OIndexInternal

Overrides:

size in class OIndexAbstractDelegate

Returns:

number of entries in the index.

put

public OIndexTxAware<T> put(Object key,
                            OIdentifiable value)

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

Overrides:

put in class OIndexAbstractDelegate

Parameters:

key - Entry's key

value - Entry's value as OIdentifiable instance

Returns:

The index instance itself to allow in chain calls

remove

public boolean remove(Object key)

Description copied from interface: OIndex

Removes an entry by its key.

Specified by:

remove in interface OIndex

Overrides:

remove in class OIndexAbstractDelegate

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 key,
                      OIdentifiable rid)

Description copied from interface: OIndex

Removes an entry by its key and value.

Specified by:

remove in interface OIndex

Overrides:

remove in class OIndexAbstractDelegate

Parameters:

key - The entry's key to remove

Returns:

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

clear

public OIndexTxAware<T> clear()

Description copied from class: OIndexAbstractDelegate

Clears the index removing all the entries in one shot.

Specified by:

clear in interface OIndex

Overrides:

clear in class OIndexAbstractDelegate

Returns:

The index instance itself to allow in chain calls

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)