com.orientechnologies.orient.core.index

Class OIndexAbstractDelegate

java.lang.Object

com.orientechnologies.orient.core.index.OIndexAbstractDelegate

All Implemented Interfaces:

OIndex, OIndexInternal, Comparable<OIndex>

Direct Known Subclasses:

OIndexTxAware

public class OIndexAbstractDelegate
extends Object
implements OIndexInternal

Generic abstract wrapper for indexes. It delegates all the operations to the wrapped OIndex instance.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected OIndexInternal	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
OIndexAbstractDelegate(OIndexInternal internal)

Method Summary

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	addCluster(String clusterName) Add given cluster to the list of clusters that should be automatically indexed.
void	addTxOperation(OIndexAbstract.IndexTxSnapshot snapshots, OTransactionIndexChanges changes)
boolean	canBeUsedInEqualityOperators() Indicates whether given index can be used to calculate result of OQueryOperatorEquality operators.
protected void	checkForKeyType(Object iKey)
OIndex	clear() Deprecated.
void	close()
void	commit(OIndexAbstract.IndexTxSnapshot snapshots)
int	compareTo(OIndex o)
long	count(Object key) Deprecated.
OIndex	create(String name, OIndexDefinition indexDefinition, String clusterIndexName, Set<String> clustersToIndex, boolean rebuild, OProgressListener progressListener)
OIndexCursor	cursor() Deprecated.
OIndex	delete() Delete the index.
OIndexCursor	descCursor() Deprecated.
Stream<ORawPair<Object,ORID>>	descStream()
void	doPut(OAbstractPaginatedStorage storage, Object key, ORID rid)
boolean	doRemove(OAbstractPaginatedStorage storage, Object key)
boolean	doRemove(OAbstractPaginatedStorage storage, Object key, ORID rid)
boolean	equals(Object o)
void	flush() Deprecated.
Object	get(Object key) Deprecated.
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() Deprecated.
int	getIndexId()
String	getIndexNameByKey(Object key) Returns the index name for a key.
OIndexInternal	getInternal() Returns the internal index used.
long	getKeySize() Deprecated.
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() Deprecated.
ODocument	getMetadata()
String	getName() Returns the index name.
long	getRebuildVersion() Deprecated.
Stream<ORID>	getRids(Object key)
long	getSize() Deprecated.
String	getType() Returns the type of the index as string.
int	getVersion() Returns binary format version for this index.
int	hashCode()
boolean	hasRangeQuerySupport()
Iterable<OTransactionIndexChangesPerKey.OTransactionIndexEntry>	interpretTxKeyChanges(OTransactionIndexChangesPerKey changes)
boolean	isAutomatic() Tells if the index is automatic.
boolean	isNativeTxSupported()
boolean	isRebuilding() Deprecated.
boolean	isUnique()
OIndexCursor	iterateEntries(Collection<?> keys, boolean ascSortOrder) Deprecated.
OIndexCursor	iterateEntriesBetween(Object fromKey, boolean fromInclusive, Object toKey, boolean toInclusive, boolean ascOrder) Deprecated.
OIndexCursor	iterateEntriesMajor(Object fromKey, boolean fromInclusive, boolean ascOrder) Deprecated.
OIndexCursor	iterateEntriesMinor(Object toKey, boolean toInclusive, boolean ascOrder) Deprecated.
OIndexKeyCursor	keyCursor() Deprecated.
Stream<Object>	keyStream()
boolean	loadFromConfiguration(ODocument config) Loads the index giving the configuration.
OIndexMetadata	loadMetadata(ODocument config)
void	postCommit(OIndexAbstract.IndexTxSnapshot snapshots)
void	preCommit(OIndexAbstract.IndexTxSnapshot snapshots)
OIndex	put(Object key, OIdentifiable value) 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.
boolean	remove(Object key) Removes an entry by its key.
boolean	remove(Object key, OIdentifiable rid) Removes an entry by its key and value.
OIndex	removeCluster(String clusterName) Remove given cluster from the list of clusters that should be automatically indexed.
void	setType(OType type)
long	size()
Stream<ORawPair<Object,ORID>>	stream()
Stream<ORawPair<Object,ORID>>	streamEntries(Collection<?> keys, boolean ascSortOrder) Returns stream which presents data associated with passed in keys.
Stream<ORawPair<Object,ORID>>	streamEntriesBetween(Object fromKey, boolean fromInclusive, Object toKey, boolean toInclusive, boolean ascOrder) Returns stream which presents subset of index data between passed in keys.
Stream<ORawPair<Object,ORID>>	streamEntriesMajor(Object fromKey, boolean fromInclusive, boolean ascOrder) Returns stream which presents subset of data which associated with key which is greater than passed in key.
Stream<ORawPair<Object,ORID>>	streamEntriesMinor(Object toKey, boolean toInclusive, boolean ascOrder) Returns stream which presents subset of data which associated with key which is less than passed in key.
boolean	supportsOrderedIterations()
String	toString()
ODocument	updateConfiguration() Saves the index configuration to disk.

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

delegate

protected OIndexInternal delegate

Constructor Detail

OIndexAbstractDelegate

public OIndexAbstractDelegate(OIndexInternal internal)

Method Detail

getInternal

public OIndexInternal getInternal()

Description copied from interface: OIndex

Returns the internal index used.

Specified by:

getInternal in interface OIndex

create

public OIndex create(String name,
                     OIndexDefinition indexDefinition,
                     String clusterIndexName,
                     Set<String> clustersToIndex,
                     boolean rebuild,
                     OProgressListener progressListener)

Specified by:

create in interface OIndex

get

@Deprecated
public Object get(Object key)

Deprecated.

Description copied from interface: OIndex

Gets the set of records associated with the passed key.

Specified by:

get in interface OIndex

Parameters:

key - The key to search

Returns:

The Record set if found, otherwise an empty Set

getRids

public Stream<ORID> getRids(Object key)

Specified by:

getRids in interface OIndexInternal

put

public OIndex 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

Parameters:

key - Entry's key

value - Entry's value as OIdentifiable instance

Returns:

The index instance itself to allow in chain calls

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

Returns:

Returns binary format version for this index if possible, otherwise -1.

remove

public boolean remove(Object key)

Description copied from interface: OIndex

Removes an entry by its key.

Specified by:

remove in interface OIndex

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

Parameters:

key - The entry's key to remove

Returns:

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

clear

@Deprecated
public OIndex clear()

Deprecated.

Clears the index removing all the entries in one shot.

Specified by:

clear in interface OIndex

Returns:

The index instance itself to allow in chain calls

checkForKeyType

protected void checkForKeyType(Object iKey)

getSize

@Deprecated
public long getSize()

Deprecated.

Specified by:

getSize in interface OIndex

Returns:

number of entries in the index.

count

@Deprecated
public long count(Object key)

Deprecated.

Description copied from interface: OIndex

Counts the entries for the key.

Specified by:

count in interface OIndex

getKeySize

@Deprecated
public long getKeySize()

Deprecated.

Specified by:

getKeySize in interface OIndex

Returns:

Number of keys in index

flush

@Deprecated
public void flush()

Deprecated.

Description copied from interface: OIndex

Flushes in-memory changes to disk.

Specified by:

flush in interface OIndex

getRebuildVersion

@Deprecated
public long getRebuildVersion()

Deprecated.

Specified by:

getRebuildVersion in interface OIndex

isRebuilding

@Deprecated
public boolean isRebuilding()

Deprecated.

Specified by:

isRebuilding in interface OIndex

Returns:

Indicates whether index is rebuilding at the moment.

See Also:

OIndex.getRebuildVersion()

getFirstKey

@Deprecated
public Object getFirstKey()

Deprecated.

Specified by:

getFirstKey in interface OIndex

getLastKey

@Deprecated
public Object getLastKey()

Deprecated.

Specified by:

getLastKey in interface OIndex

cursor

@Deprecated
public OIndexCursor cursor()

Deprecated.

Specified by:

cursor in interface OIndex

descCursor

@Deprecated
public OIndexCursor descCursor()

Deprecated.

Specified by:

descCursor in interface OIndex

keyCursor

@Deprecated
public OIndexKeyCursor keyCursor()

Deprecated.

Specified by:

keyCursor in interface OIndex

iterateEntries

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

Deprecated.

Description copied from interface: OIndex

Returns cursor which presents data associated with passed in keys.

Specified by:

iterateEntries in interface OIndex

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.

iterateEntriesBetween

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

Deprecated.

Description copied from interface: OIndex

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

Specified by:

iterateEntriesBetween in interface OIndex

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

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

Deprecated.

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

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

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

Deprecated.

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

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.

delete

public OIndex delete()

Description copied from interface: OIndex

Delete the index.

Specified by:

delete in interface OIndex

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

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

getAlgorithm

public String getAlgorithm()

Description copied from interface: OIndex

Returns the engine of the index as string.

Specified by:

getAlgorithm in interface OIndex

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

Returns:

True if the index is automatic, otherwise false

isUnique

public boolean isUnique()

Specified by:

isUnique in interface OIndex

getConfiguration

public ODocument getConfiguration()

Description copied from interface: OIndex

Returns the index configuration.

Specified by:

getConfiguration in interface OIndex

Returns:

An ODocument object containing all the index properties

getMetadata

public ODocument getMetadata()

Specified by:

getMetadata in interface OIndex

rebuild

public long rebuild()

Description copied from interface: OIndex

Rebuilds an automatic index.

Specified by:

rebuild in interface OIndex

Returns:

The number of entries rebuilt

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

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

getDefinition

public OIndexDefinition getDefinition()

Specified by:

getDefinition in interface OIndex

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getClusters

public Set<String> getClusters()

Description copied from interface: OIndex

Returns Names of clusters that will be indexed.

Specified by:

getClusters in interface OIndex

Returns:

Names of clusters that will be indexed.

toString

public String toString()

Overrides:

toString in class Object

getDatabaseName

public String getDatabaseName()

Specified by:

getDatabaseName in interface OIndex

supportsOrderedIterations

public boolean supportsOrderedIterations()

Specified by:

supportsOrderedIterations in interface OIndex

getIndexId

public int getIndexId()

Specified by:

getIndexId in interface OIndex

compareTo

public int compareTo(OIndex o)

Specified by:

compareTo in interface Comparable<OIndex>

getCollatingValue

public Object getCollatingValue(Object key)

Specified by:

getCollatingValue in interface OIndexInternal

loadFromConfiguration

public boolean loadFromConfiguration(ODocument config)

Description copied from interface: OIndexInternal

Loads the index giving the configuration.

Specified by:

loadFromConfiguration in interface OIndexInternal

Parameters:

config - 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

Returns:

The configuration as ODocument instance

See Also:

OIndex.getConfiguration()

addCluster

public OIndex addCluster(String clusterName)

Description copied from interface: OIndexInternal

Add given cluster to the list of clusters that should be automatically indexed.

Specified by:

addCluster in interface OIndexInternal

Parameters:

clusterName - Cluster to add.

Returns:

Current index instance.

removeCluster

public OIndex removeCluster(String clusterName)

Description copied from interface: OIndexInternal

Remove given cluster from the list of clusters that should be automatically indexed.

Specified by:

removeCluster in interface OIndexInternal

Parameters:

clusterName - 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

Returns:

true if given index can be used to calculate result of OQueryOperatorEquality operators.

hasRangeQuerySupport

public boolean hasRangeQuerySupport()

Specified by:

hasRangeQuerySupport in interface OIndexInternal

loadMetadata

public OIndexMetadata loadMetadata(ODocument config)

Specified by:

loadMetadata in interface OIndexInternal

close

public void close()

Specified by:

close in interface OIndexInternal

preCommit

public void preCommit(OIndexAbstract.IndexTxSnapshot snapshots)

Specified by:

preCommit in interface OIndexInternal

addTxOperation

public void addTxOperation(OIndexAbstract.IndexTxSnapshot snapshots,
                           OTransactionIndexChanges changes)

Specified by:

addTxOperation in interface OIndexInternal

commit

public void commit(OIndexAbstract.IndexTxSnapshot snapshots)

Specified by:

commit in interface OIndexInternal

postCommit

public void postCommit(OIndexAbstract.IndexTxSnapshot snapshots)

Specified by:

postCommit in interface OIndexInternal

setType

public void setType(OType type)

Specified by:

setType in interface OIndexInternal

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

Parameters:

key - the index key.

Returns:

The index name involved

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

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.

size

public long size()

Specified by:

size in interface OIndexInternal

Returns:

number of entries in the index.

stream

public Stream<ORawPair<Object,ORID>> stream()

Specified by:

stream in interface OIndexInternal

descStream

public Stream<ORawPair<Object,ORID>> descStream()

Specified by:

descStream in interface OIndexInternal

keyStream

public Stream<Object> keyStream()

Specified by:

keyStream in interface OIndexInternal

streamEntriesBetween

public Stream<ORawPair<Object,ORID>> streamEntriesBetween(Object fromKey,
                                                          boolean fromInclusive,
                                                          Object toKey,
                                                          boolean toInclusive,
                                                          boolean ascOrder)

Description copied from interface: OIndexInternal

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

Specified by:

streamEntriesBetween in interface OIndexInternal

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 stream should be in ascending or descending order.

Returns:

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

streamEntries

public Stream<ORawPair<Object,ORID>> streamEntries(Collection<?> keys,
                                                   boolean ascSortOrder)

Description copied from interface: OIndexInternal

Returns stream which presents data associated with passed in keys.

Specified by:

streamEntries in interface OIndexInternal

Parameters:

keys - Keys data of which should be returned.

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

Returns:

stream which presents data associated with passed in keys.

streamEntriesMajor

public Stream<ORawPair<Object,ORID>> streamEntriesMajor(Object fromKey,
                                                        boolean fromInclusive,
                                                        boolean ascOrder)

Description copied from interface: OIndexInternal

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

Specified by:

streamEntriesMajor in interface OIndexInternal

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 stream should be in ascending or descending order.

Returns:

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

streamEntriesMinor

public Stream<ORawPair<Object,ORID>> streamEntriesMinor(Object toKey,
                                                        boolean toInclusive,
                                                        boolean ascOrder)

Description copied from interface: OIndexInternal

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

Specified by:

streamEntriesMinor in interface OIndexInternal

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 stream should be in ascending or descending order.

Returns:

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

isNativeTxSupported

public boolean isNativeTxSupported()

Specified by:

isNativeTxSupported in interface OIndexInternal

interpretTxKeyChanges

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

Specified by:

interpretTxKeyChanges in interface OIndexInternal

doPut

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

Specified by:

doPut in interface OIndexInternal

Throws:

OInvalidIndexEngineIdException

doRemove

public boolean doRemove(OAbstractPaginatedStorage storage,
                        Object key,
                        ORID rid)
                 throws OInvalidIndexEngineIdException

Specified by:

doRemove in interface OIndexInternal

Throws:

OInvalidIndexEngineIdException

doRemove

public boolean doRemove(OAbstractPaginatedStorage storage,
                        Object key)
                 throws OInvalidIndexEngineIdException

Specified by:

doRemove in interface OIndexInternal

Throws:

OInvalidIndexEngineIdException