OIndexInternal (OrientDB 2.2.37 API)

All Superinterfaces:

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

All Known Implementing Classes:

OIndexAbstract, OIndexDictionary, OIndexFullText, OIndexMultiValues, OIndexNotUnique, OIndexOneValue, OIndexRecorder, OIndexUnique, OLuceneFullTextIndex, OLuceneIndexNotUnique
```
public interface OIndexInternal<T>
extends OIndex<T>
```
Interface to handle index.

Author:

Luca Garulli (l.garulli--at--orientechnologies.com)

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ALGORITHM`
`static String`	`CONFIG_AUTOMATIC`
`static String`	`CONFIG_KEYTYPE`
`static String`	`CONFIG_NAME`
`static String`	`CONFIG_TYPE`
`static String`	`INDEX_DEFINITION`
`static String`	`INDEX_DEFINITION_CLASS`
`static String`	`INDEX_VERSION`
`static String`	`METADATA`
`static String`	`VALUE_CONTAINER_ALGORITHM`

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

Method Summary

All Methods Instance Methods Abstract 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<T>`	`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.
`void`	`close()`
`void`	`commit()`
`Object`	`getCollatingValue(Object key)`
`String`	`getIndexNameByKey(Object key)` Returns the index name for a key.
`boolean`	`hasRangeQuerySupport()`
`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()`
`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.
`OIndex<T>`	`removeCluster(String iClusterName)` Remove given cluster from the list of clusters that should be automatically indexed.
`void`	`setRebuildingFlag()`
`void`	`setType(OType type)`
`ODocument`	`updateConfiguration()` Saves the index configuration to disk.

Methods inherited from interface com.orientechnologies.orient.core.index.OIndex
checkEntry, clear, contains, count, create, cursor, delete, descCursor, flush, get, getAlgorithm, getClusters, getConfiguration, getDatabaseName, getDefinition, getFirstKey, getIndexId, getInternal, getKeySize, getKeyTypes, getLastKey, getMetadata, getName, getRebuildVersion, getSize, getType, getVersion, isAutomatic, isRebuilding, isUnique, iterateEntries, iterateEntriesBetween, iterateEntriesMajor, iterateEntriesMinor, keyCursor, put, rebuild, rebuild, remove, remove, supportsOrderedIterations

Methods inherited from interface java.lang.Comparable
compareTo

- Field Detail
  - CONFIG_KEYTYPE
```
static final String CONFIG_KEYTYPE
```
    See Also:
    
    Constant Field Values
  - CONFIG_AUTOMATIC
```
static final String CONFIG_AUTOMATIC
```
    See Also:
    
    Constant Field Values
  - CONFIG_TYPE
```
static final String CONFIG_TYPE
```
    See Also:
    
    Constant Field Values
  - ALGORITHM
```
static final String ALGORITHM
```
    See Also:
    
    Constant Field Values
  - VALUE_CONTAINER_ALGORITHM
```
static final String VALUE_CONTAINER_ALGORITHM
```
    See Also:
    
    Constant Field Values
  - CONFIG_NAME
```
static final String CONFIG_NAME
```
    See Also:
    
    Constant Field Values
  - INDEX_DEFINITION
```
static final String INDEX_DEFINITION
```
    See Also:
    
    Constant Field Values
  - INDEX_DEFINITION_CLASS
```
static final String INDEX_DEFINITION_CLASS
```
    See Also:
    
    Constant Field Values
  - INDEX_VERSION
```
static final String INDEX_VERSION
```
    See Also:
    
    Constant Field Values
  - METADATA
```
static final String METADATA
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getCollatingValue
```
Object getCollatingValue(Object key)
```
  - loadFromConfiguration
```
boolean loadFromConfiguration(ODocument iConfig)
```
    Loads the index giving the configuration.
    
    Parameters:
    
    iConfig - ODocument instance containing the configuration
  - updateConfiguration
```
ODocument updateConfiguration()
```
    Saves the index configuration to disk.
    
    Returns:
    
    The configuration as ODocument instance
    
    See Also:
    
    OIndex.getConfiguration()
  - addCluster
```
OIndex<T> addCluster(String iClusterName)
```
    Add given cluster to the list of clusters that should be automatically indexed.
    
    Parameters:
    
    iClusterName - Cluster to add.
    
    Returns:
    
    Current index instance.
  - removeCluster
```
OIndex<T> removeCluster(String iClusterName)
```
    Remove given cluster from the list of clusters that should be automatically indexed.
    
    Parameters:
    
    iClusterName - Cluster to remove.
    
    Returns:
    
    Current index instance.
  - canBeUsedInEqualityOperators
```
boolean canBeUsedInEqualityOperators()
```
    Indicates whether given index can be used to calculate result of OQueryOperatorEquality operators.
    
    Returns:
    
    true if given index can be used to calculate result of OQueryOperatorEquality operators.
  - hasRangeQuerySupport
```
boolean hasRangeQuerySupport()
```
  - lockKeysForUpdate
```
void lockKeysForUpdate(Object... key)
```
    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.
    Parameters:
    
    key - Keys to lock.
  - lockKeysForUpdate
```
Lock[] lockKeysForUpdate(Collection<Object> keys)
```
    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.
    Parameters:
    
    keys - Keys to lock.
    
    Returns:
    
    the array of locks which should be unlocked when done.
  - releaseKeysForUpdate
```
void releaseKeysForUpdate(Object... key)
```
    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.
    Parameters:
    
    key - Keys to unlock.
  - loadMetadata
```
OIndexMetadata loadMetadata(ODocument iConfig)
```
  - setRebuildingFlag
```
void setRebuildingFlag()
```
  - close
```
void close()
```
  - preCommit
```
void preCommit()
```
  - addTxOperation
```
void addTxOperation(OTransactionIndexChanges changes)
```
  - commit
```
void commit()
```
  - postCommit
```
void postCommit()
```
  - setType
```
void setType(OType type)
```
  - getIndexNameByKey
```
String getIndexNameByKey(Object key)
```
    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.
    
    Parameters:
    
    key - the index key.
    
    Returns:
    
    The index name involved
  - acquireAtomicExclusiveLock
```
boolean acquireAtomicExclusiveLock(Object key)
```
    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.
    
    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.

Interface OIndexInternal<T>

Field Summary

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

Method Summary

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

Methods inherited from interface java.lang.Comparable

Field Detail

CONFIG_KEYTYPE

CONFIG_AUTOMATIC

CONFIG_TYPE

ALGORITHM

VALUE_CONTAINER_ALGORITHM

CONFIG_NAME

INDEX_DEFINITION

INDEX_DEFINITION_CLASS

INDEX_VERSION

METADATA

Method Detail

getCollatingValue

loadFromConfiguration

updateConfiguration

addCluster

removeCluster

canBeUsedInEqualityOperators

hasRangeQuerySupport

lockKeysForUpdate

lockKeysForUpdate

releaseKeysForUpdate

loadMetadata

setRebuildingFlag

close

preCommit

addTxOperation

commit

postCommit

setType

getIndexNameByKey

acquireAtomicExclusiveLock