com.orientechnologies.orient.core.index

Class OIndexUnique

java.lang.Object

com.orientechnologies.orient.core.index.OIndexAbstract

com.orientechnologies.orient.core.index.OIndexOneValue

com.orientechnologies.orient.core.index.OIndexUnique

All Implemented Interfaces:

OIndex, OIndexInternal, Comparable<OIndex>

public class OIndexUnique
extends OIndexOneValue

Index implementation that allows only one value for a key.

Author:

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

Nested Class Summary

Nested classes/interfaces inherited from class com.orientechnologies.orient.core.index.OIndexAbstract

OIndexAbstract.IndexConfiguration, OIndexAbstract.IndexTxSnapshot

Field Summary

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

apiVersion, binaryFormatVersion, clustersToIndex, CONFIG_MAP_RID, configuration, indexId, metadata, storage, type, valueContainerAlgorithm

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
OIndexUnique(String name, String typeId, String algorithm, int version, OAbstractPaginatedStorage storage, String valueContainerAlgorithm, ODocument metadata, int binaryFormatVersion)

Method Summary

Modifier and Type	Method and Description
boolean	canBeUsedInEqualityOperators() Indicates whether given index can be used to calculate result of OQueryOperatorEquality operators.
void	doPut(OAbstractPaginatedStorage storage, Object key, ORID rid)
Iterable<OTransactionIndexChangesPerKey.OTransactionIndexEntry>	interpretTxKeyChanges(OTransactionIndexChangesPerKey changes) Interprets transaction index changes for a certain key.
boolean	isNativeTxSupported()
OIndexOneValue	put(Object key, OIdentifiable value) Inserts a new entry in the index.
boolean	supportsOrderedIterations()

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

create, descStream, determineValueSerializer, get, getRids, isUnique, size, stream, streamEntries, streamEntriesBetween, streamEntriesMajor, streamEntriesMinor

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

acquireAtomicExclusiveLock, acquireExclusiveLock, acquireSharedLock, addCluster, addTxOperation, clear, clearSnapshot, close, commit, commitSnapshot, compareTo, count, create, cursor, delete, descCursor, doDelete, doReloadIndexEngine, doRemove, doRemove, equals, flush, getAlgorithm, getClusters, getCollatingValue, getConfiguration, getDatabase, getDatabaseName, getDefinition, getFirstKey, getIndexId, getIndexNameByKey, getInternal, getKeySize, getKeyTypes, getLastKey, getMetadata, getName, getRebuildVersion, getSize, getType, getVersion, hashCode, hasRangeQuerySupport, isAutomatic, isRebuilding, iterateEntries, iterateEntriesBetween, iterateEntriesMajor, iterateEntriesMinor, keyCursor, keyStream, loadFromConfiguration, loadMetadata, loadMetadataInternal, manualIndexesWarning, onIndexEngineChange, postCommit, preCommit, putInSnapshot, rebuild, rebuild, releaseExclusiveLock, releaseSharedLock, remove, remove, removeCluster, removeFromSnapshot, setType, 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

Constructor Detail

OIndexUnique

public OIndexUnique(String name,
                    String typeId,
                    String algorithm,
                    int version,
                    OAbstractPaginatedStorage storage,
                    String valueContainerAlgorithm,
                    ODocument metadata,
                    int binaryFormatVersion)

Method Detail

put

public OIndexOneValue put(Object key,
                          OIdentifiable value)

Description copied from interface: OIndex

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

Parameters:

key - Entry's key

value - Entry's value as OIdentifiable instance

Returns:

The index instance itself to allow in chain calls

isNativeTxSupported

public boolean isNativeTxSupported()

doPut

public void doPut(OAbstractPaginatedStorage storage,
                  Object key,
                  ORID rid)
           throws OInvalidIndexEngineIdException

Throws:

OInvalidIndexEngineIdException

canBeUsedInEqualityOperators

public boolean canBeUsedInEqualityOperators()

Description copied from interface: OIndexInternal

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.

supportsOrderedIterations

public boolean supportsOrderedIterations()

interpretTxKeyChanges

public Iterable<OTransactionIndexChangesPerKey.OTransactionIndexEntry> interpretTxKeyChanges(OTransactionIndexChangesPerKey changes)

Description copied from class: OIndexAbstract

Interprets transaction index changes for a certain key. Override it to customize index behaviour on interpreting index changes. This may be viewed as an optimization, but in some cases this is a requirement. For example, if you put multiple values under the same key during the transaction for single-valued/unique index, but remove all of them except one before commit, there is no point in throwing ORecordDuplicatedException while applying index changes.

Specified by:

interpretTxKeyChanges in interface OIndexInternal

Overrides:

interpretTxKeyChanges in class OIndexAbstract

Parameters:

changes - the changes to interpret.

Returns:

the interpreted index key changes.