com.orientechnologies.orient.core.index

Class OIndexTxAwareOneValue

java.lang.Object

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

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

com.orientechnologies.orient.core.index.OIndexTxAwareOneValue

All Implemented Interfaces:

OIndex<OIdentifiable>, Comparable<OIndex<OIdentifiable>>

Direct Known Subclasses:

OIndexTxAwareDictionary

public class OIndexTxAwareOneValue
extends OIndexTxAware<OIdentifiable>

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/interfaces inherited from class com.orientechnologies.orient.core.index.OIndexTxAware

OIndexTxAware.PartialSearchMode

Field Summary

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

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
OIndexTxAwareOneValue(ODatabaseDocumentInternal iDatabase, OIndex<OIdentifiable> iDelegate)

Method Summary

Modifier and Type	Method and Description
ODocument	checkEntry(OIdentifiable iRecord, Object iKey) For unique indexes it will throw exception if passed in key is contained in index.
boolean	contains(Object key) Tells if a key is contained in the index.
OIdentifiable	get(Object key) Gets the set of records associated with the passed key.
OIndexCursor	iterateEntries(Collection<?> keys, boolean ascSortOrder) Returns cursor which presents data associated with passed in keys.
OIndexCursor	iterateEntriesBetween(Object fromKey, boolean fromInclusive, Object toKey, boolean toInclusive, boolean ascOrder) Returns cursor which presents subset of index data between passed in keys.
OIndexCursor	iterateEntriesMajor(Object fromKey, boolean fromInclusive, boolean ascOrder) Returns cursor which presents subset of data which associated with key which is greater than passed in key.
OIndexCursor	iterateEntriesMinor(Object toKey, boolean toInclusive, boolean ascOrder) Returns cursor which presents subset of data which associated with key which is less than passed in key.

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

clear, enhanceCompositeKey, enhanceFromCompositeKeyBetweenAsc, enhanceFromCompositeKeyBetweenDesc, enhanceToCompositeKeyBetweenAsc, enhanceToCompositeKeyBetweenDesc, getCollatingValue, getFirstKey, getLastKey, getSize, put, putOnlyClientTrack, remove, remove, removeOnlyClientTrack

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

OIndexTxAwareOneValue

public OIndexTxAwareOneValue(ODatabaseDocumentInternal iDatabase,
                             OIndex<OIdentifiable> iDelegate)

Method Detail

checkEntry

public ODocument checkEntry(OIdentifiable iRecord,
                            Object iKey)

Description copied from interface: OIndex

For unique indexes it will throw exception if passed in key is contained in index.

Specified by:

checkEntry in interface OIndex<OIdentifiable>

Overrides:

checkEntry in class OIndexAbstractDelegate<OIdentifiable>

get

public OIdentifiable get(Object key)

Description copied from interface: OIndex

Gets the set of records associated with the passed key.

Specified by:

get in interface OIndex<OIdentifiable>

Overrides:

get in class OIndexAbstractDelegate<OIdentifiable>

Parameters:

key - The key to search

Returns:

The Record set if found, otherwise an empty Set

contains

public boolean contains(Object key)

Description copied from interface: OIndex

Tells if a key is contained in the index.

Specified by:

contains in interface OIndex<OIdentifiable>

Overrides:

contains in class OIndexAbstractDelegate<OIdentifiable>

Parameters:

key - The key to search

Returns:

True if the key is contained, otherwise false

iterateEntriesBetween

public OIndexCursor iterateEntriesBetween(Object fromKey,
                                          boolean fromInclusive,
                                          Object toKey,
                                          boolean toInclusive,
                                          boolean ascOrder)

Description copied from interface: OIndex

Returns cursor which presents subset of index data between passed in keys.

Specified by:

iterateEntriesBetween in interface OIndex<OIdentifiable>

Overrides:

iterateEntriesBetween in class OIndexAbstractDelegate<OIdentifiable>

Parameters:

fromKey - Lower border of index data.

fromInclusive - Indicates whether lower border should be inclusive or exclusive.

toKey - Upper border of index data.

toInclusive - Indicates whether upper border should be inclusive or exclusive.

ascOrder - Flag which determines whether data iterated by cursor should be in ascending or descending order.

Returns:

Cursor which presents subset of index data between passed in keys.

iterateEntriesMajor

public OIndexCursor iterateEntriesMajor(Object fromKey,
                                        boolean fromInclusive,
                                        boolean ascOrder)

Description copied from interface: OIndex

Returns cursor which presents subset of data which associated with key which is greater than passed in key.

Specified by:

iterateEntriesMajor in interface OIndex<OIdentifiable>

Overrides:

iterateEntriesMajor in class OIndexAbstractDelegate<OIdentifiable>

Parameters:

fromKey - Lower border of index data.

fromInclusive - Indicates whether lower border should be inclusive or exclusive.

ascOrder - Flag which determines whether data iterated by cursor should be in ascending or descending order.

Returns:

cursor which presents subset of data which associated with key which is greater than passed in key.

iterateEntriesMinor

public OIndexCursor iterateEntriesMinor(Object toKey,
                                        boolean toInclusive,
                                        boolean ascOrder)

Description copied from interface: OIndex

Returns cursor which presents subset of data which associated with key which is less than passed in key.

Specified by:

iterateEntriesMinor in interface OIndex<OIdentifiable>

Overrides:

iterateEntriesMinor in class OIndexAbstractDelegate<OIdentifiable>

Parameters:

toKey - Upper border of index data.

toInclusive - Indicates Indicates whether upper border should be inclusive or exclusive.

ascOrder - Flag which determines whether data iterated by cursor should be in ascending or descending order.

Returns:

cursor which presents subset of data which associated with key which is less than passed in key.

iterateEntries

public OIndexCursor iterateEntries(Collection<?> keys,
                                   boolean ascSortOrder)

Description copied from interface: OIndex

Returns cursor which presents data associated with passed in keys.

Specified by:

iterateEntries in interface OIndex<OIdentifiable>

Overrides:

iterateEntries in class OIndexAbstractDelegate<OIdentifiable>

Parameters:

keys - Keys data of which should be returned.

ascSortOrder - Flag which determines whether data iterated by cursor should be in ascending or descending order.

Returns:

cursor which presents data associated with passed in keys.