OIndexRecorder (OrientDB 2.2.37 API)

java.lang.Object
- com.orientechnologies.orient.core.index.OIndexRecorder

All Implemented Interfaces:: OIndex<OIdentifiable>, OIndexInternal<OIdentifiable>, Comparable<OIndex<OIdentifiable>>

public class OIndexRecorder
extends Object
implements OIndex<OIdentifiable>, OIndexInternal<OIdentifiable>

Field Summary
- 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

OIndexRecorder(OIndexInternal<OIdentifiable> delegate)

Constructors
Constructor and Description
`OIndexRecorder(OIndexInternal<OIdentifiable> delegate)`

Method Summary

All Methods Instance Methods Concrete Methods
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.
`OIndex<OIdentifiable>`	`addCluster(String iClusterName)` Add given cluster to the list of clusters that should be automatically indexed.
`void`	`addTxOperation(OTransactionIndexChanges changes)`
`boolean`	`canBeUsedInEqualityOperators()` Indicates whether given index can be used to calculate result of `OQueryOperatorEquality` operators.
`ODocument`	`checkEntry(OIdentifiable iRecord, Object iKey)` For unique indexes it will throw exception if passed in key is contained in index.
`OIndex<OIdentifiable>`	`clear()` Clears the index removing all the entries in one shot.
`void`	`close()`
`void`	`commit()`
`int`	`compareTo(OIndex<OIdentifiable> o)`
`boolean`	`contains(Object iKey)` Tells if a key is contained in the index.
`long`	`count(Object iKey)` Counts the entries for the key.
`OIndex<OIdentifiable>`	`create(String name, OIndexDefinition indexDefinition, String clusterIndexName, Set<String> clustersToIndex, boolean rebuild, OProgressListener progressListener)` Creates the index.
`OIndexCursor`	`cursor()`
`OIndex<OIdentifiable>`	`delete()` Delete the index.
`OIndexCursor`	`descCursor()`
`void`	`flush()` Flushes in-memory changes to disk.
`OIdentifiable`	`get(Object iKey)` Gets the set of records associated with the passed key.
`List<Object>`	`getAffectedKeys()`
`String`	`getAlgorithm()` Returns the engine of the index as string.
`Set<String>`	`getClusters()` Returns Names of clusters that will be indexed.
`Object`	`getCollatingValue(Object key)`
`ODocument`	`getConfiguration()` Returns the index configuration.
`String`	`getDatabaseName()`
`OIndexDefinition`	`getDefinition()`
`Object`	`getFirstKey()`
`int`	`getIndexId()`
`String`	`getIndexNameByKey(Object key)` Returns the index name for a key.
`OIndexInternal<OIdentifiable>`	`getInternal()` Returns the internal index used.
`long`	`getKeySize()`
`OType[]`	`getKeyTypes()` Types of the keys that index can accept, if index contains composite key, list of types of elements from which this index consist will be returned, otherwise single element (key type obviously) will be returned.
`Object`	`getLastKey()`
`ODocument`	`getMetadata()`
`String`	`getName()` Returns the index name.
`long`	`getRebuildVersion()` Returns amount of times when index was rebuilt since storage was opened.
`long`	`getSize()`
`String`	`getType()` Returns the type of the index as string.
`int`	`getVersion()` Returns binary format version for this index.
`boolean`	`hasRangeQuerySupport()`
`boolean`	`isAutomatic()` Tells if the index is automatic.
`boolean`	`isRebuilding()`
`boolean`	`isUnique()`
`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.
`OIndexKeyCursor`	`keyCursor()`
`boolean`	`loadFromConfiguration(ODocument iConfig)` Loads the index giving the configuration.
`OIndexMetadata`	`loadMetadata(ODocument iConfig)`
`Lock[]`	`lockKeysForUpdate(Collection<Object> keys)` Applies exclusive lock on keys which prevents read/modification of this keys in following methods: `OIndex.put(Object, com.orientechnologies.orient.core.db.record.OIdentifiable)` `OIndex.checkEntry(com.orientechnologies.orient.core.db.record.OIdentifiable, Object)` `OIndex.remove(Object, com.orientechnologies.orient.core.db.record.OIdentifiable)` `OIndex.remove(Object)`
`void`	`lockKeysForUpdate(Object... key)` Applies exclusive lock on keys which prevents read/modification of this keys in following methods: `OIndex.put(Object, com.orientechnologies.orient.core.db.record.OIdentifiable)` `OIndex.checkEntry(com.orientechnologies.orient.core.db.record.OIdentifiable, Object)` `OIndex.remove(Object, com.orientechnologies.orient.core.db.record.OIdentifiable)` `OIndex.remove(Object)`
`void`	`postCommit()`
`void`	`preCommit()`
`OIndex<OIdentifiable>`	`put(Object iKey, OIdentifiable iValue)` Inserts a new entry in the index.
`long`	`rebuild()` Rebuilds an automatic index.
`long`	`rebuild(OProgressListener iProgressListener)` Populate the index with all the existent records.
`void`	`releaseKeysForUpdate(Object... key)` Release exclusive lock on keys which prevents read/modification of this keys in following methods: `OIndex.put(Object, com.orientechnologies.orient.core.db.record.OIdentifiable)` `OIndex.checkEntry(com.orientechnologies.orient.core.db.record.OIdentifiable, Object)` `OIndex.remove(Object, com.orientechnologies.orient.core.db.record.OIdentifiable)` `OIndex.remove(Object)` This is internal method and cannot be used by end users.
`boolean`	`remove(Object key)` Removes an entry by its key.
`boolean`	`remove(Object iKey, OIdentifiable iRID)` Removes an entry by its key and value.
`OIndex<OIdentifiable>`	`removeCluster(String iClusterName)` Remove given cluster from the list of clusters that should be automatically indexed.
`void`	`setRebuildingFlag()`
`void`	`setType(OType type)`
`boolean`	`supportsOrderedIterations()`
`String`	`toString()`
`ODocument`	`updateConfiguration()` Saves the index configuration to disk.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - OIndexRecorder
```
public OIndexRecorder(OIndexInternal<OIdentifiable> delegate)
```
- Method Detail
  - getAffectedKeys
```
public List<Object> getAffectedKeys()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - create
```
public OIndex<OIdentifiable> create(String name,
                                    OIndexDefinition indexDefinition,
                                    String clusterIndexName,
                                    Set<String> clustersToIndex,
                                    boolean rebuild,
                                    OProgressListener progressListener)
```
    Description copied from interface: OIndex
    
    Creates the index.
    
    Specified by:
    
    create in interface OIndex<OIdentifiable>
    
    clusterIndexName - Cluster name where to place the TreeMap
  - getDatabaseName
```
public String getDatabaseName()
```
    Specified by:
    
    getDatabaseName in interface OIndex<OIdentifiable>
  - getKeyTypes
```
public OType[] getKeyTypes()
```
    Description copied from interface: OIndex
    
    Types of the keys that index can accept, if index contains composite key, list of types of elements from which this index consist will be returned, otherwise single element (key type obviously) will be returned.
    
    Specified by:
    
    getKeyTypes in interface OIndex<OIdentifiable>
  - get
```
public OIdentifiable get(Object iKey)
```
    Description copied from interface: OIndex
    
    Gets the set of records associated with the passed key.
    
    Specified by:
    
    get in interface OIndex<OIdentifiable>
    
    Parameters:
    
    iKey - The key to search
    
    Returns:
    
    The Record set if found, otherwise an empty Set
  - contains
```
public boolean contains(Object iKey)
```
    Description copied from interface: OIndex
    
    Tells if a key is contained in the index.
    
    Specified by:
    
    contains in interface OIndex<OIdentifiable>
    
    Parameters:
    
    iKey - The key to search
    
    Returns:
    
    True if the key is contained, otherwise false
  - put
```
public OIndex<OIdentifiable> 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<OIdentifiable>
    
    Parameters:
    
    iKey - Entry's key
    
    iValue - 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<OIdentifiable>
    
    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<OIdentifiable>
    
    Parameters:
    
    iKey - The entry's key to remove
    
    Returns:
    
    True if the entry has been found and removed, otherwise false
  - clear
```
public OIndex<OIdentifiable> clear()
```
    Description copied from interface: OIndex
    
    Clears the index removing all the entries in one shot.
    
    Specified by:
    
    clear in interface OIndex<OIdentifiable>
    
    Returns:
    
    The index instance itself to allow in chain calls
  - getSize
```
public long getSize()
```
    Specified by:
    
    getSize in interface OIndex<OIdentifiable>
    
    Returns:
    
    number of entries in the index.
  - count
```
public long count(Object iKey)
```
    Description copied from interface: OIndex
    
    Counts the entries for the key.
    
    Specified by:
    
    count in interface OIndex<OIdentifiable>
  - getKeySize
```
public long getKeySize()
```
    Specified by:
    
    getKeySize in interface OIndex<OIdentifiable>
    
    Returns:
    
    Number of keys in index
  - 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>
  - getVersion
```
public int getVersion()
```
    Description copied from interface: OIndex
    
    Returns binary format version for this index. Index format changes during system development but old formats are supported for binary compatibility. This method may be used to detect version of binary format which is used by current index and upgrade index to new one.
    
    Specified by:
    
    getVersion in interface OIndex<OIdentifiable>
    
    Returns:
    
    Returns binary format version for this index if possible, otherwise -1.
  - getRebuildVersion
```
public long getRebuildVersion()
```
    Description copied from interface: OIndex
    Returns amount of times when index was rebuilt since storage was opened.
    It is used to support so called "live index rebuild" feature.
    Value of this version is increased every time when index is going to be rebuild. So if two sequential calls of this method return different numbers it means that index at least started to rebuild itself.
    If you use indexes to increase speed of fetching data from database you should follow following workflow:
    1. Read index rebuild version.
    2. Check index rebuild flag OIndex.isRebuilding(), if it is true, do not use index and fetch data directly from database clusters.
    3. Fetch data from index.
    4. Read index rebuild version again, if it is not equal to version which was read at first time, go to step 2. It is VERY important do not reorder steps 1 and 2. Such recording may lead to situation when index is rebuilding but we miss this state.
    This approach works well ONLY if you do not use methods which return OIndexCursor instance. In case of you work with cursors index rebuild may cause data inconsistency issues in both:
    1. Code which calls index methods to create cursor (can be avoided using steps are listed above)
    2. During iteration over the cursor itself
    To detect last data inconsistency issue please use cursor wrapper OIndexChangesWrapper which throws OIndexIsRebuildingException in case of index rebuild.
    Both of these approaches are used in implementation of support of "live index rebuild" for SELECT SQL queries.
    1. In case of index which we are going to use to speed up SELECT query is rebuilding we skip this index.
    2. If index is rebuilding at the moment when we iterate over the cursor we catch OIndexIsRebuildingException exception and retry whole query again.
    Specified by:
    
    getRebuildVersion in interface OIndex<OIdentifiable>
    
    Returns:
    
    amount of times when index was rebuilt since the start of the storage.
    
    See Also:
    
    OCommandExecutorSQLSelect.searchForIndexes(com.orientechnologies.orient.core.metadata.schema.OClass), OCommandExecutorSQLSelect.getIndexCursors(com.orientechnologies.orient.core.metadata.schema.OClass), OCommandExecutorSQLSelect.getOptimizedSortCursor(com.orientechnologies.orient.core.metadata.schema.OClass), OAbstractPaginatedStorage.command(com.orientechnologies.orient.core.command.OCommandRequestText), OIndexChangesWrapper, OIndexIsRebuildingException, ORetryQueryException
  - flush
```
public void flush()
```
    Description copied from interface: OIndex
    
    Flushes in-memory changes to disk.
    
    Specified by:
    
    flush in interface OIndex<OIdentifiable>
  - delete
```
public OIndex<OIdentifiable> delete()
```
    Description copied from interface: OIndex
    
    Delete the index.
    
    Specified by:
    
    delete in interface OIndex<OIdentifiable>
    
    Returns:
    
    The index instance itself to allow in chain calls
  - getName
```
public String getName()
```
    Description copied from interface: OIndex
    
    Returns the index name.
    
    Specified by:
    
    getName in interface OIndex<OIdentifiable>
    
    Returns:
    
    The name of the index
  - getType
```
public String getType()
```
    Description copied from interface: OIndex
    
    Returns the type of the index as string.
    
    Specified by:
    
    getType in interface OIndex<OIdentifiable>
  - isAutomatic
```
public boolean isAutomatic()
```
    Description copied from interface: OIndex
    
    Tells if the index is automatic. Automatic means it's maintained automatically by OrientDB. This is the case of indexes created against schema properties. Automatic indexes can always been rebuilt.
    
    Specified by:
    
    isAutomatic in interface OIndex<OIdentifiable>
    
    Returns:
    
    True if the index is automatic, otherwise false
  - rebuild
```
public long rebuild()
```
    Description copied from interface: OIndex
    
    Rebuilds an automatic index.
    
    Specified by:
    
    rebuild in interface OIndex<OIdentifiable>
    
    Returns:
    
    The number of entries rebuilt
    
    See Also:
    
    OIndex.getRebuildVersion()
  - rebuild
```
public long rebuild(OProgressListener iProgressListener)
```
    Description copied from interface: OIndex
    
    Populate the index with all the existent records.
    
    Specified by:
    
    rebuild in interface OIndex<OIdentifiable>
    
    See Also:
    
    OIndex.getRebuildVersion()
  - getConfiguration
```
public ODocument getConfiguration()
```
    Description copied from interface: OIndex
    
    Returns the index configuration.
    
    Specified by:
    
    getConfiguration in interface OIndex<OIdentifiable>
    
    Returns:
    
    An ODocument object containing all the index properties
  - getInternal
```
public OIndexInternal<OIdentifiable> getInternal()
```
    Description copied from interface: OIndex
    
    Returns the internal index used.
    
    Specified by:
    
    getInternal in interface OIndex<OIdentifiable>
  - 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>
    
    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.
  - getDefinition
```
public OIndexDefinition getDefinition()
```
    Specified by:
    
    getDefinition in interface OIndex<OIdentifiable>
  - getClusters
```
public Set<String> getClusters()
```
    Description copied from interface: OIndex
    
    Returns Names of clusters that will be indexed.
    
    Specified by:
    
    getClusters in interface OIndex<OIdentifiable>
    
    Returns:
    
    Names of clusters that will be indexed.
  - 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>
    
    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>
    
    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>
    
    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.
  - cursor
```
public OIndexCursor cursor()
```
    Specified by:
    
    cursor in interface OIndex<OIdentifiable>
  - descCursor
```
public OIndexCursor descCursor()
```
    Specified by:
    
    descCursor in interface OIndex<OIdentifiable>
  - keyCursor
```
public OIndexKeyCursor keyCursor()
```
    Specified by:
    
    keyCursor in interface OIndex<OIdentifiable>
  - getMetadata
```
public ODocument getMetadata()
```
    Specified by:
    
    getMetadata in interface OIndex<OIdentifiable>
  - supportsOrderedIterations
```
public boolean supportsOrderedIterations()
```
    Specified by:
    
    supportsOrderedIterations in interface OIndex<OIdentifiable>
  - isRebuilding
```
public boolean isRebuilding()
```
    Specified by:
    
    isRebuilding in interface OIndex<OIdentifiable>
    
    Returns:
    
    Indicates whether index is rebuilding at the moment.
    
    See Also:
    
    OIndex.getRebuildVersion()
  - getFirstKey
```
public Object getFirstKey()
```
    Specified by:
    
    getFirstKey in interface OIndex<OIdentifiable>
  - getLastKey
```
public Object getLastKey()
```
    Specified by:
    
    getLastKey in interface OIndex<OIdentifiable>
  - getIndexId
```
public int getIndexId()
```
    Specified by:
    
    getIndexId in interface OIndex<OIdentifiable>
  - isUnique
```
public boolean isUnique()
```
    Specified by:
    
    isUnique in interface OIndex<OIdentifiable>
  - compareTo
```
public int compareTo(OIndex<OIdentifiable> o)
```
    Specified by:
    
    compareTo in interface Comparable<OIndex<OIdentifiable>>
  - getCollatingValue
```
public Object getCollatingValue(Object key)
```
    Specified by:
    
    getCollatingValue in interface OIndexInternal<OIdentifiable>
  - loadFromConfiguration
```
public boolean loadFromConfiguration(ODocument iConfig)
```
    Description copied from interface: OIndexInternal
    
    Loads the index giving the configuration.
    
    Specified by:
    
    loadFromConfiguration in interface OIndexInternal<OIdentifiable>
    
    Parameters:
    
    iConfig - ODocument instance containing the configuration
  - updateConfiguration
```
public ODocument updateConfiguration()
```
    Description copied from interface: OIndexInternal
    
    Saves the index configuration to disk.
    
    Specified by:
    
    updateConfiguration in interface OIndexInternal<OIdentifiable>
    
    Returns:
    
    The configuration as ODocument instance
    
    See Also:
    
    OIndex.getConfiguration()
  - addCluster
```
public OIndex<OIdentifiable> addCluster(String iClusterName)
```
    Description copied from interface: OIndexInternal
    
    Add given cluster to the list of clusters that should be automatically indexed.
    
    Specified by:
    
    addCluster in interface OIndexInternal<OIdentifiable>
    
    Parameters:
    
    iClusterName - Cluster to add.
    
    Returns:
    
    Current index instance.
  - removeCluster
```
public OIndex<OIdentifiable> removeCluster(String iClusterName)
```
    Description copied from interface: OIndexInternal
    
    Remove given cluster from the list of clusters that should be automatically indexed.
    
    Specified by:
    
    removeCluster in interface OIndexInternal<OIdentifiable>
    
    Parameters:
    
    iClusterName - Cluster to remove.
    
    Returns:
    
    Current index instance.
  - canBeUsedInEqualityOperators
```
public boolean canBeUsedInEqualityOperators()
```
    Description copied from interface: OIndexInternal
    
    Indicates whether given index can be used to calculate result of OQueryOperatorEquality operators.
    
    Specified by:
    
    canBeUsedInEqualityOperators in interface OIndexInternal<OIdentifiable>
    
    Returns:
    
    true if given index can be used to calculate result of OQueryOperatorEquality operators.
  - hasRangeQuerySupport
```
public boolean hasRangeQuerySupport()
```
    Specified by:
    
    hasRangeQuerySupport in interface OIndexInternal<OIdentifiable>
  - lockKeysForUpdate
```
public void lockKeysForUpdate(Object... key)
```
    Description copied from interface: OIndexInternal
    Applies exclusive lock on keys which prevents read/modification of this keys in following methods:
    If you want to lock several keys in single thread, you should pass all those keys in single method call. Several calls of this method in single thread are not allowed because it may lead to deadlocks.
    This is internal method and cannot be used by end users.
    Specified by:
    
    lockKeysForUpdate in interface OIndexInternal<OIdentifiable>
    
    Parameters:
    
    key - Keys to lock.
  - lockKeysForUpdate
```
public Lock[] lockKeysForUpdate(Collection<Object> keys)
```
    Description copied from interface: OIndexInternal
    Applies exclusive lock on keys which prevents read/modification of this keys in following methods:
    If you want to lock several keys in single thread, you should pass all those keys in single method call. Several calls of this method in single thread are not allowed because it may lead to deadlocks.
    This is internal method and cannot be used by end users.
    Specified by:
    
    lockKeysForUpdate in interface OIndexInternal<OIdentifiable>
    
    Parameters:
    
    keys - Keys to lock.
    
    Returns:
    
    the array of locks which should be unlocked when done.
  - releaseKeysForUpdate
```
public void releaseKeysForUpdate(Object... key)
```
    Description copied from interface: OIndexInternal
    Release exclusive lock on keys which prevents read/modification of this keys in following methods:
    This is internal method and cannot be used by end users.
    Specified by:
    
    releaseKeysForUpdate in interface OIndexInternal<OIdentifiable>
    
    Parameters:
    
    key - Keys to unlock.
  - setType
```
public void setType(OType type)
```
    Specified by:
    
    setType in interface OIndexInternal<OIdentifiable>
  - loadMetadata
```
public OIndexMetadata loadMetadata(ODocument iConfig)
```
    Specified by:
    
    loadMetadata in interface OIndexInternal<OIdentifiable>
  - setRebuildingFlag
```
public void setRebuildingFlag()
```
    Specified by:
    
    setRebuildingFlag in interface OIndexInternal<OIdentifiable>
  - close
```
public void close()
```
    Specified by:
    
    close in interface OIndexInternal<OIdentifiable>
  - getAlgorithm
```
public String getAlgorithm()
```
    Description copied from interface: OIndex
    
    Returns the engine of the index as string.
    
    Specified by:
    
    getAlgorithm in interface OIndex<OIdentifiable>
  - preCommit
```
public void preCommit()
```
    Specified by:
    
    preCommit in interface OIndexInternal<OIdentifiable>
  - addTxOperation
```
public void addTxOperation(OTransactionIndexChanges changes)
```
    Specified by:
    
    addTxOperation in interface OIndexInternal<OIdentifiable>
  - commit
```
public void commit()
```
    Specified by:
    
    commit in interface OIndexInternal<OIdentifiable>
  - postCommit
```
public void postCommit()
```
    Specified by:
    
    postCommit in interface OIndexInternal<OIdentifiable>
  - acquireAtomicExclusiveLock
```
public boolean acquireAtomicExclusiveLock(Object key)
```
    Description copied from interface: OIndexInternal
    
    Acquires exclusive lock in the active atomic operation running on the current thread for this index.
    If this index 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 OIndexInternal<OIdentifiable>
    
    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)
```
    Description copied from interface: OIndexInternal
    
    Returns the index name for a key. The name is always the current index name, but in cases where the index supports key-based sharding.
    
    Specified by:
    
    getIndexNameByKey in interface OIndexInternal<OIdentifiable>
    
    Parameters:
    
    key - the index key.
    
    Returns:
    
    The index name involved

Class OIndexRecorder

Field Summary

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

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OIndexRecorder

Method Detail

getAffectedKeys

toString

create

getDatabaseName

getKeyTypes

get

contains

put

remove

remove

clear

getSize

count

getKeySize

checkEntry

getVersion

getRebuildVersion

flush

delete

getName

getType

isAutomatic

rebuild

rebuild

getConfiguration

getInternal

iterateEntries

getDefinition

getClusters

iterateEntriesBetween

iterateEntriesMajor

iterateEntriesMinor

cursor

descCursor

keyCursor

getMetadata

supportsOrderedIterations

isRebuilding

getFirstKey

getLastKey

getIndexId

isUnique

compareTo

getCollatingValue

loadFromConfiguration

updateConfiguration

addCluster

removeCluster

canBeUsedInEqualityOperators

hasRangeQuerySupport

lockKeysForUpdate

lockKeysForUpdate

releaseKeysForUpdate

setType

loadMetadata

setRebuildingFlag

close

getAlgorithm

preCommit

addTxOperation

commit

postCommit

acquireAtomicExclusiveLock

getIndexNameByKey