com.orientechnologies.orient.core.index

Class OIndexFullText

java.lang.Object

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

com.orientechnologies.orient.core.index.OIndexMultiValues

com.orientechnologies.orient.core.index.OIndexFullText

All Implemented Interfaces:

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

public class OIndexFullText
extends OIndexMultiValues

Fast index for full-text searches.

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, 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
OIndexFullText(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.
OIndexInternal<?>	create(OIndexDefinition indexDefinition, String clusterIndexName, Set<String> clustersToIndex, boolean rebuild, OProgressListener progressListener, OBinarySerializer valueSerializer) Creates the index.
OIndexMultiValues	create(String name, OIndexDefinition indexDefinition, String clusterIndexName, Set<String> clustersToIndex, boolean rebuild, OProgressListener progressListener) Creates the index.
protected OIndexAbstract.IndexConfiguration	indexConfigurationInstance(ODocument document)
boolean	isNativeTxSupported()
OIndexFullText	put(Object key, OIdentifiable singleValue) Indexes a value and save the index.
boolean	remove(Object key, OIdentifiable value) Splits passed in key on several words and remove records with keys equals to any item of split result and values equals to passed in value.
boolean	supportsOrderedIterations()
ODocument	updateConfiguration() Saves the index configuration to disk.

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

count, cursor, descCursor, determineValueSerializer, doPut, doRemove, get, getKeySize, getSize, iterateEntries, iterateEntriesBetween, iterateEntriesMajor, iterateEntriesMinor

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

acquireAtomicExclusiveLock, acquireExclusiveLock, acquireSharedLock, addCluster, addTxOperation, clear, clearSnapshot, close, commit, commitSnapshot, compareTo, contains, 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

Methods inherited from class java.lang.Object

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

Constructor Detail

OIndexFullText

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

Method Detail

put

public OIndexFullText put(Object key,
                          OIdentifiable singleValue)

Indexes a value and save the index. Splits the value in single words and index each one. Save of the index is responsibility of the caller.

Specified by:

put in interface OIndex<Collection<ORID>>

Overrides:

put in class OIndexMultiValues

Parameters:

key - Entry's key

singleValue - Entry's value as OIdentifiable instance

Returns:

The index instance itself to allow in chain calls

isNativeTxSupported

public boolean isNativeTxSupported()

Specified by:

isNativeTxSupported in interface OIndexInternal<Collection<ORID>>

Overrides:

isNativeTxSupported in class OIndexMultiValues

remove

public boolean remove(Object key,
                      OIdentifiable value)

Splits passed in key on several words and remove records with keys equals to any item of split result and values equals to passed in value.

Specified by:

remove in interface OIndex<Collection<ORID>>

Overrides:

remove in class OIndexMultiValues

Parameters:

key - Key to remove.

value - Value to remove.

Returns:

true if at least one record is removed.

create

public OIndexInternal<?> create(OIndexDefinition indexDefinition,
                                String clusterIndexName,
                                Set<String> clustersToIndex,
                                boolean rebuild,
                                OProgressListener progressListener,
                                OBinarySerializer valueSerializer)

Description copied from class: OIndexAbstract

Creates the index.

Overrides:

create in class OIndexAbstract<Collection<ORID>>

clusterIndexName - Cluster name where to place the TreeMap

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.

Specified by:

create in interface OIndex<Collection<ORID>>

Overrides:

create in class OIndexMultiValues

clusterIndexName - Cluster name where to place the TreeMap

updateConfiguration

public ODocument updateConfiguration()

Description copied from interface: OIndexInternal

Saves the index configuration to disk.

Specified by:

updateConfiguration in interface OIndexInternal<Collection<ORID>>

Overrides:

updateConfiguration in class OIndexAbstract<Collection<ORID>>

Returns:

The configuration as ODocument instance

See Also:

OIndex.getConfiguration()

indexConfigurationInstance

protected OIndexAbstract.IndexConfiguration indexConfigurationInstance(ODocument document)

canBeUsedInEqualityOperators

public boolean canBeUsedInEqualityOperators()

Description copied from interface: OIndexInternal

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.

supportsOrderedIterations

public boolean supportsOrderedIterations()