com.orientechnologies.orient.core.index

Class OIndexMultiValues

java.lang.Object

com.orientechnologies.orient.core.index.OIndexAbstract<Collection<ORID>>

com.orientechnologies.orient.core.index.OIndexMultiValues

All Implemented Interfaces:

OIndex<Collection<ORID>>, OIndexInternal<Collection<ORID>>, Comparable<OIndex<Collection<ORID>>>

Direct Known Subclasses:

OIndexFullText, OIndexNotUnique

public abstract class OIndexMultiValues
extends OIndexAbstract<Collection<ORID>>

Abstract index implementation that supports multi-values for the same 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, indexId, metadata, storage, 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

Method Summary

Modifier and Type	Method and Description
long	count(Object key) Counts the entries for the key.
OIndexMultiValues	create(String name, OIndexDefinition indexDefinition, String clusterIndexName, Set<String> clustersToIndex, boolean rebuild, OProgressListener progressListener) Creates the index.
OIndexCursor	cursor()
OIndexCursor	descCursor()
protected OBinarySerializer	determineValueSerializer()
void	doPut(OAbstractPaginatedStorage storage, Object key, ORID rid)
boolean	doRemove(OAbstractPaginatedStorage storage, Object key, ORID rid)
Collection<ORID>	get(Object key) Gets the set of records associated with the passed key.
long	getKeySize()
long	getSize()
boolean	isNativeTxSupported()
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.
OIndexMultiValues	put(Object key, OIdentifiable singleValue) Inserts a new entry in the index.
boolean	remove(Object key, OIdentifiable value) Removes an entry by its key and value.

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

acquireAtomicExclusiveLock, acquireExclusiveLock, acquireSharedLock, addCluster, addTxOperation, clear, clearSnapshot, close, commit, commitSnapshot, compareTo, contains, create, delete, doReloadIndexEngine, doRemove, equals, flush, getAlgorithm, getClusters, getCollatingValue, getConfiguration, getDatabase, getDatabaseName, getDefinition, getFirstKey, getIndexId, getIndexNameByKey, getInternal, getKeyTypes, getLastKey, getMetadata, getName, getRebuildVersion, getType, getVersion, hashCode, hasRangeQuerySupport, interpretTxKeyChanges, isAutomatic, isRebuilding, isUnique, keyCursor, loadFromConfiguration, loadMetadata, loadMetadataInternal, onIndexEngineChange, postCommit, putInSnapshot, rebuild, rebuild, releaseExclusiveLock, releaseSharedLock, remove, removeCluster, removeFromSnapshot, setRebuildingFlag, 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

canBeUsedInEqualityOperators

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

supportsOrderedIterations

Method Detail

get

public Collection<ORID> get(Object key)

Description copied from interface: OIndex

Gets the set of records associated with the passed key.

Parameters:

key - The key to search

Returns:

The Record set if found, otherwise an empty Set

count

public long count(Object key)

Description copied from interface: OIndex

Counts the entries for the key.

Specified by:

count in interface OIndex<Collection<ORID>>

Overrides:

count in class OIndexAbstract<Collection<ORID>>

put

public OIndexMultiValues put(Object key,
                             OIdentifiable singleValue)

Description copied from interface: OIndex

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

Parameters:

key - Entry's key

singleValue - Entry's value as OIdentifiable instance

Returns:

The index instance itself to allow in chain calls

doPut

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

Throws:

OInvalidIndexEngineIdException

isNativeTxSupported

public boolean isNativeTxSupported()

remove

public boolean remove(Object key,
                      OIdentifiable value)

Description copied from interface: OIndex

Removes an entry by its key and value.

Specified by:

remove in interface OIndex<Collection<ORID>>

Overrides:

remove in class OIndexAbstract<Collection<ORID>>

Parameters:

key - The entry's key to remove

Returns:

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

doRemove

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

Specified by:

doRemove in interface OIndexInternal<Collection<ORID>>

Overrides:

doRemove in class OIndexAbstract<Collection<ORID>>

Throws:

OInvalidIndexEngineIdException

create

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

Description copied from interface: OIndex

Creates the index.

clusterIndexName - Cluster name where to place the TreeMap

determineValueSerializer

protected OBinarySerializer determineValueSerializer()

Specified by:

determineValueSerializer in class OIndexAbstract<Collection<ORID>>

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.

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.

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.

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.

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.

getSize

public long getSize()

Returns:

number of entries in the index.

getKeySize

public long getKeySize()

Returns:

Number of keys in index

cursor

public OIndexCursor cursor()

descCursor

public OIndexCursor descCursor()