com.orientechnologies.lucene.index

Class OLuceneIndexNotUnique

java.lang.Object

com.orientechnologies.orient.core.index.OIndexAbstract

com.orientechnologies.lucene.index.OLuceneIndexNotUnique

All Implemented Interfaces:

OLuceneIndex, OIndex, OIndexInternal, Comparable<OIndex>

Direct Known Subclasses:

OLuceneFullTextIndex, OLuceneSpatialIndex

public class OLuceneIndexNotUnique
extends OIndexAbstract
implements OLuceneIndex

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
OLuceneIndexNotUnique(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.
protected void	clearSnapshot(OIndexAbstract.IndexTxSnapshot indexTxSnapshot)
protected void	commitSnapshot(Map<Object,Object> snapshot)
OLuceneIndexNotUnique	create(String name, OIndexDefinition indexDefinition, String clusterIndexName, Set<String> clustersToIndex, boolean rebuild, OProgressListener progressListener)
protected Object	decodeKey(Object key)
OLuceneIndexNotUnique	delete() Delete the index.
Stream<ORawPair<Object,ORID>>	descStream()
protected OBinarySerializer	determineValueSerializer()
void	doPut(OAbstractPaginatedStorage storage, Object key, ORID rid)
protected Object	encodeKey(Object key)
Collection<OIdentifiable>	get(Object key) Deprecated.
Object	getCollatingValue(Object key)
Stream<ORID>	getRids(Object key)
Iterable<OTransactionIndexChangesPerKey.OTransactionIndexEntry>	interpretTxKeyChanges(OTransactionIndexChangesPerKey changes) Interprets transaction index changes for a certain key.
boolean	isNativeTxSupported()
protected void	onIndexEngineChange(int indexId)
OLuceneIndexNotUnique	put(Object key, OIdentifiable value) Inserts a new entry in the index.
protected void	putInSnapshot(Object key, OIdentifiable value, Map<Object,Object> snapshot)
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.
OIndexAbstract	removeCluster(String iClusterName) Remove given cluster from the list of clusters that should be automatically indexed.
protected void	removeFromSnapshot(Object key, OIdentifiable value, Map<Object,Object> snapshot)
org.apache.lucene.search.IndexSearcher	searcher()
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()

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

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

OLuceneIndexNotUnique

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

Method Detail

rebuild

public long rebuild(OProgressListener iProgressListener)

Description copied from class: OIndexAbstract

Populate the index with all the existent records.

Specified by:

rebuild in interface OIndex

Overrides:

rebuild in class OIndexAbstract

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

Overrides:

remove in class OIndexAbstract

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)

Description copied from interface: OIndex

Removes an entry by its key.

Specified by:

remove in interface OIndex

Overrides:

remove in class OIndexAbstract

Parameters:

key - The entry's key to remove

Returns:

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

removeCluster

public OIndexAbstract removeCluster(String iClusterName)

Description copied from interface: OIndexInternal

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

Specified by:

removeCluster in interface OIndexInternal

Overrides:

removeCluster in class OIndexAbstract

Parameters:

iClusterName - Cluster to remove.

Returns:

Current index instance.

determineValueSerializer

protected OBinarySerializer determineValueSerializer()

Specified by:

determineValueSerializer in class OIndexAbstract

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.

doPut

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

Specified by:

doPut in interface OIndexInternal

getCollatingValue

public Object getCollatingValue(Object key)

Specified by:

getCollatingValue in interface OIndexInternal

Overrides:

getCollatingValue in class OIndexAbstract

commitSnapshot

protected void commitSnapshot(Map<Object,Object> snapshot)

Overrides:

commitSnapshot in class OIndexAbstract

delete

public OLuceneIndexNotUnique delete()

Description copied from interface: OIndex

Delete the index.

Specified by:

delete in interface OIndex

Overrides:

delete in class OIndexAbstract

Returns:

The index instance itself to allow in chain calls

decodeKey

protected Object decodeKey(Object key)

putInSnapshot

protected void putInSnapshot(Object key,
                             OIdentifiable value,
                             Map<Object,Object> snapshot)

Overrides:

putInSnapshot in class OIndexAbstract

removeFromSnapshot

protected void removeFromSnapshot(Object key,
                                  OIdentifiable value,
                                  Map<Object,Object> snapshot)

Overrides:

removeFromSnapshot in class OIndexAbstract

clearSnapshot

protected void clearSnapshot(OIndexAbstract.IndexTxSnapshot indexTxSnapshot)

Overrides:

clearSnapshot in class OIndexAbstract

onIndexEngineChange

protected void onIndexEngineChange(int indexId)

Overrides:

onIndexEngineChange in class OIndexAbstract

encodeKey

protected Object encodeKey(Object key)

create

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

Specified by:

create in interface OIndex

get

@Deprecated
public Collection<OIdentifiable> 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 OLuceneIndexNotUnique 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

size

public long size()

Specified by:

size in interface OIndexInternal

Returns:

number of entries in the index.

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.

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.

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

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

supportsOrderedIterations

public boolean supportsOrderedIterations()

Specified by:

supportsOrderedIterations in interface OIndex

searcher

public org.apache.lucene.search.IndexSearcher searcher()

Specified by:

searcher in interface OLuceneIndex

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.