com.orientechnologies.orient.core.index

Interface OIndexInternal

All Superinterfaces:

Comparable<OIndex>, OIndex

All Known Implementing Classes:

OChainedIndexProxy, OIndexAbstract, OIndexAbstractDelegate, OIndexDictionary, OIndexFullText, OIndexMultiValues, OIndexNotUnique, OIndexOneValue, OIndexTxAware, OIndexTxAwareDictionary, OIndexTxAwareMultiValue, OIndexTxAwareOneValue, OIndexUnique, OLuceneFullTextIndex, OLuceneIndexNotUnique, OLuceneSpatialIndex

public interface OIndexInternal
extends OIndex

Interface to handle index.

Author:

Luca Garulli (l.garulli--(at)--orientdb.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

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 iClusterName) 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.
void	close()
void	commit(OIndexAbstract.IndexTxSnapshot snapshots)
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)
Object	getCollatingValue(Object key)
String	getIndexNameByKey(Object key) Returns the index name for a key.
Stream<ORID>	getRids(Object key)
boolean	hasRangeQuerySupport()
Iterable<OTransactionIndexChangesPerKey.OTransactionIndexEntry>	interpretTxKeyChanges(OTransactionIndexChangesPerKey changes)
static boolean	isLabelSecurityDefined(ODatabaseDocumentInternal database, OSecurityInternal security, String indexClass, String propertyName)
boolean	isNativeTxSupported()
static boolean	isReadRestrictedBySecurityPolicy(String indexClass, ODatabaseDocumentInternal db, OSecurityInternal security)
Stream<Object>	keyStream()
boolean	loadFromConfiguration(ODocument iConfig) Loads the index giving the configuration.
OIndexMetadata	loadMetadata(ODocument iConfig)
void	postCommit(OIndexAbstract.IndexTxSnapshot snapshots)
void	preCommit(OIndexAbstract.IndexTxSnapshot snapshots)
OIndex	removeCluster(String iClusterName) Remove given cluster from the list of clusters that should be automatically indexed.
static Collection	securityFilterOnRead(OIndex idx, Collection<OIdentifiable> items)
static OIdentifiable	securityFilterOnRead(OIndex idx, OIdentifiable item)
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.
ODocument	updateConfiguration() Saves the index configuration to disk.

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

clear, 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 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 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()

loadMetadata

OIndexMetadata loadMetadata(ODocument iConfig)

close

void close()

preCommit

void preCommit(OIndexAbstract.IndexTxSnapshot snapshots)

addTxOperation

void addTxOperation(OIndexAbstract.IndexTxSnapshot snapshots,
                    OTransactionIndexChanges changes)

commit

void commit(OIndexAbstract.IndexTxSnapshot snapshots)

postCommit

void postCommit(OIndexAbstract.IndexTxSnapshot snapshots)

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.

size

long size()

Returns:

number of entries in the index.

getRids

Stream<ORID> getRids(Object key)

stream

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

descStream

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

keyStream

Stream<Object> keyStream()

streamEntriesBetween

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.

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

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

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.

streamEntriesMajor

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.

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

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.

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.

securityFilterOnRead

static OIdentifiable securityFilterOnRead(OIndex idx,
                                          OIdentifiable item)

isLabelSecurityDefined

static boolean isLabelSecurityDefined(ODatabaseDocumentInternal database,
                                      OSecurityInternal security,
                                      String indexClass,
                                      String propertyName)

isReadRestrictedBySecurityPolicy

static boolean isReadRestrictedBySecurityPolicy(String indexClass,
                                                ODatabaseDocumentInternal db,
                                                OSecurityInternal security)

securityFilterOnRead

static Collection securityFilterOnRead(OIndex idx,
                                       Collection<OIdentifiable> items)

isNativeTxSupported

boolean isNativeTxSupported()

interpretTxKeyChanges

Iterable<OTransactionIndexChangesPerKey.OTransactionIndexEntry> interpretTxKeyChanges(OTransactionIndexChangesPerKey changes)

doPut

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

Throws:

OInvalidIndexEngineIdException

doRemove

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

Throws:

OInvalidIndexEngineIdException

doRemove

boolean doRemove(OAbstractPaginatedStorage storage,
                 Object key)
          throws OInvalidIndexEngineIdException

Throws:

OInvalidIndexEngineIdException