com.orientechnologies.lucene.index

Class OLuceneIndexNotUnique

java.lang.Object

com.orientechnologies.orient.core.index.OIndexAbstract<Set<OIdentifiable>>

com.orientechnologies.lucene.index.OLuceneIndexNotUnique

All Implemented Interfaces:

OLuceneIndex, OIndex<Set<OIdentifiable>>, OIndexInternal<Set<OIdentifiable>>, Comparable<OIndex<Set<OIdentifiable>>>

Direct Known Subclasses:

OLuceneFullTextIndex, OLuceneSpatialIndex

public class OLuceneIndexNotUnique
extends OIndexAbstract<Set<OIdentifiable>>
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, 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

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) Creates the index.
OIndexCursor	cursor()
protected Object	decodeKey(Object key)
OIndexCursor	descCursor()
protected OBinarySerializer	determineValueSerializer()
void	doPut(OAbstractPaginatedStorage storage, Object key, ORID rid)
protected Object	encodeKey(Object key)
Set<OIdentifiable>	get(Object key) Gets the set of records associated with the passed key.
Object	getCollatingValue(Object key)
long	getKeySize()
long	getSize()
Iterable<OTransactionIndexChangesPerKey.OTransactionIndexEntry>	interpretTxKeyChanges(OTransactionIndexChangesPerKey changes) Interprets transaction index changes for a certain key.
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.
protected void	onIndexEngineChange(int indexId)
OLuceneIndexNotUnique	put(Object key, OIdentifiable singleValue) 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 value) Removes an entry by its key and value.
OIndexAbstract<Set<OIdentifiable>>	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()
boolean	supportsOrderedIterations()

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

acquireAtomicExclusiveLock, acquireExclusiveLock, acquireSharedLock, addCluster, addTxOperation, clear, close, commit, compareTo, contains, count, create, delete, doReloadIndexEngine, doRemove, doRemove, equals, flush, getAlgorithm, getClusters, getConfiguration, getDatabase, getDatabaseName, getDefinition, getFirstKey, getIndexId, getIndexNameByKey, getInternal, getKeyTypes, getLastKey, getMetadata, getName, getRebuildVersion, getType, getVersion, hashCode, hasRangeQuerySupport, isAutomatic, isRebuilding, isUnique, keyCursor, loadFromConfiguration, loadMetadata, loadMetadataInternal, postCommit, rebuild, releaseExclusiveLock, releaseSharedLock, setRebuildingFlag, setType, toString, updateConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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<Set<OIdentifiable>>

Overrides:

rebuild in class OIndexAbstract<Set<OIdentifiable>>

See Also:

OIndex.getRebuildVersion()

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<Set<OIdentifiable>>

Overrides:

remove in class OIndexAbstract<Set<OIdentifiable>>

Parameters:

key - The entry's key to remove

Returns:

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

isNativeTxSupported

public boolean isNativeTxSupported()

Specified by:

isNativeTxSupported in interface OIndexInternal<Set<OIdentifiable>>

doPut

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

Specified by:

doPut in interface OIndexInternal<Set<OIdentifiable>>

Throws:

OInvalidIndexEngineIdException

remove

public boolean remove(Object key)

Description copied from interface: OIndex

Removes an entry by its key.

Specified by:

remove in interface OIndex<Set<OIdentifiable>>

Overrides:

remove in class OIndexAbstract<Set<OIdentifiable>>

Parameters:

key - The entry's key to remove

Returns:

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

removeCluster

public OIndexAbstract<Set<OIdentifiable>> 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<Set<OIdentifiable>>

Overrides:

removeCluster in class OIndexAbstract<Set<OIdentifiable>>

Parameters:

iClusterName - Cluster to remove.

Returns:

Current index instance.

determineValueSerializer

protected OBinarySerializer determineValueSerializer()

Specified by:

determineValueSerializer in class OIndexAbstract<Set<OIdentifiable>>

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<Set<OIdentifiable>>

Overrides:

interpretTxKeyChanges in class OIndexAbstract<Set<OIdentifiable>>

Parameters:

changes - the changes to interpret.

Returns:

the interpreted index key changes.

getCollatingValue

public Object getCollatingValue(Object key)

Specified by:

getCollatingValue in interface OIndexInternal<Set<OIdentifiable>>

Overrides:

getCollatingValue in class OIndexAbstract<Set<OIdentifiable>>

commitSnapshot

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

Overrides:

commitSnapshot in class OIndexAbstract<Set<OIdentifiable>>

decodeKey

protected Object decodeKey(Object key)

putInSnapshot

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

Overrides:

putInSnapshot in class OIndexAbstract<Set<OIdentifiable>>

removeFromSnapshot

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

Overrides:

removeFromSnapshot in class OIndexAbstract<Set<OIdentifiable>>

clearSnapshot

protected void clearSnapshot(OIndexAbstract.IndexTxSnapshot indexTxSnapshot)

Overrides:

clearSnapshot in class OIndexAbstract<Set<OIdentifiable>>

onIndexEngineChange

protected void onIndexEngineChange(int indexId)

Overrides:

onIndexEngineChange in class OIndexAbstract<Set<OIdentifiable>>

encodeKey

protected Object encodeKey(Object key)

create

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

Description copied from interface: OIndex

Creates the index.

Specified by:

create in interface OIndex<Set<OIdentifiable>>

clusterIndexName - Cluster name where to place the TreeMap

get

public Set<OIdentifiable> get(Object key)

Description copied from interface: OIndex

Gets the set of records associated with the passed key.

Specified by:

get in interface OIndex<Set<OIdentifiable>>

Parameters:

key - The key to search

Returns:

The Record set if found, otherwise an empty Set

put

public OLuceneIndexNotUnique put(Object key,
                                 OIdentifiable singleValue)

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<Set<OIdentifiable>>

Parameters:

key - Entry's key

singleValue - Entry's value as OIdentifiable instance

Returns:

The index instance itself to allow in chain calls

getSize

public long getSize()

Specified by:

getSize in interface OIndex<Set<OIdentifiable>>

Returns:

number of entries in the index.

getKeySize

public long getKeySize()

Specified by:

getKeySize in interface OIndex<Set<OIdentifiable>>

Returns:

Number of keys in index

iterateEntries

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

Description copied from interface: OIndex

Returns cursor which presents data associated with passed in keys.

Specified by:

iterateEntries in interface OIndex<Set<OIdentifiable>>

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

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.

Specified by:

iterateEntriesBetween in interface OIndex<Set<OIdentifiable>>

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.

Specified by:

iterateEntriesMajor in interface OIndex<Set<OIdentifiable>>

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.

Specified by:

iterateEntriesMinor in interface OIndex<Set<OIdentifiable>>

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.

cursor

public OIndexCursor cursor()

Specified by:

cursor in interface OIndex<Set<OIdentifiable>>

descCursor

public OIndexCursor descCursor()

Specified by:

descCursor in interface OIndex<Set<OIdentifiable>>

supportsOrderedIterations

public boolean supportsOrderedIterations()

Specified by:

supportsOrderedIterations in interface OIndex<Set<OIdentifiable>>

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<Set<OIdentifiable>>

Returns:

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