com.orientechnologies.orient.core.index

Class OIndexOneValue

java.lang.Object

com.orientechnologies.orient.core.index.OIndexAbstract

com.orientechnologies.orient.core.index.OIndexOneValue

All Implemented Interfaces:

OIndex, OIndexInternal, Comparable<OIndex>

Direct Known Subclasses:

OIndexDictionary, OIndexUnique

public abstract class OIndexOneValue
extends OIndexAbstract

Abstract Index implementation that allows only one value for a key.

Author:

Luca Garulli

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

Method Summary

Modifier and Type	Method and Description
OIndexOneValue	create(String name, OIndexDefinition indexDefinition, String clusterIndexName, Set<String> clustersToIndex, boolean rebuild, OProgressListener progressListener)
Stream<ORawPair<Object,ORID>>	descStream()
protected OBinarySerializer	determineValueSerializer()
Object	get(Object key) Deprecated.
Stream<ORID>	getRids(Object key)
boolean	isUnique()
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.

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, 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, interpretTxKeyChanges, 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

canBeUsedInEqualityOperators, doPut, isLabelSecurityDefined, isNativeTxSupported, isReadRestrictedBySecurityPolicy, securityFilterOnRead, securityFilterOnRead

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

put, supportsOrderedIterations

Constructor Detail

OIndexOneValue

public OIndexOneValue(String name,
                      String type,
                      String algorithm,
                      int version,
                      OAbstractPaginatedStorage storage,
                      String valueContainerAlgorithm,
                      ODocument metadata,
                      int binaryFormatVersion)

Method Detail

get

@Deprecated
public Object get(Object key)

Deprecated.

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

getRids

public Stream<ORID> getRids(Object key)

create

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

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.

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.

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.

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.

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.

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.

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.

size

public long size()

Returns:

number of entries in the index.

stream

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

descStream

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

isUnique

public boolean isUnique()

Specified by:

isUnique in interface OIndex

Overrides:

isUnique in class OIndexAbstract

determineValueSerializer

protected OBinarySerializer determineValueSerializer()

Specified by:

determineValueSerializer in class OIndexAbstract