Package com.orientechnologies.orient.core.index

Class OPropertyRidBagIndexDefinition

java.lang.Object

com.orientechnologies.orient.core.index.OAbstractIndexDefinition

com.orientechnologies.orient.core.index.OPropertyIndexDefinition

com.orientechnologies.orient.core.index.OPropertyRidBagIndexDefinition

All Implemented Interfaces:

OIndexCallback, OIndexDefinition, OIndexDefinitionMultiValue

public class OPropertyRidBagIndexDefinition
extends OPropertyIndexDefinition
implements OIndexDefinitionMultiValue

Index definition for index which is bound to field with type OType.LINKBAG .

Since:

1/30/14

Author:

Andrey Lomakin (a.lomakin-at-orientdb.com)

Field Summary

Fields inherited from class com.orientechnologies.orient.core.index.OPropertyIndexDefinition

className, field, keyType

Fields inherited from class com.orientechnologies.orient.core.index.OAbstractIndexDefinition

collate, document

Constructor Summary

Constructors

Constructor	Description
OPropertyRidBagIndexDefinition()
OPropertyRidBagIndexDefinition(String className, String field)

Method Summary

Modifier and Type	Method	Description
Object	createSingleValue(Object... param)	Converts passed in value in the key of single index entry.
Object	createValue(Object... params)	Calculates key value by passed in parameters.
Object	createValue(List<?> params)	Calculates key value by passed in parameters.
Object	getDocumentValueToIndex(ODocument iDocument)
void	processChangeEvent(OMultiValueChangeEvent<?,?> changeEvent, Map<Object,Integer> keysToAdd, Map<Object,Integer> keysToRemove)	Process event that contains operation on collection and extract values that should be added removed from index to reflect collection changes in the given index.
String	toCreateIndexDDL(String indexName, String indexType, String engine)

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

createIndexDDLWithFieldType, createIndexDDLWithoutFieldType, equals, fromStream, getClassName, getFields, getFieldsToIndex, getParamCount, getTypes, hashCode, isAutomatic, processAdd, processRemoval, serializeFromStream, serializeToStream, toStream, toString

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

getCollate, isNullValuesIgnored, setCollate, setCollate, setNullValuesIgnored

Methods inherited from class java.lang.Object

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

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

equals, fromStream, getClassName, getCollate, getFields, getFieldsToIndex, getParamCount, getTypes, hashCode, isAutomatic, isNullValuesIgnored, setCollate, setNullValuesIgnored, toStream, toString

Constructor Details

OPropertyRidBagIndexDefinition

public OPropertyRidBagIndexDefinition()

OPropertyRidBagIndexDefinition

public OPropertyRidBagIndexDefinition(String className,
 String field)

Method Details

createSingleValue

public Object createSingleValue(Object... param)

Description copied from interface: OIndexDefinitionMultiValue

Converts passed in value in the key of single index entry.

Specified by:

createSingleValue in interface OIndexDefinitionMultiValue

Parameters:

param - Value to convert.

Returns:

Index key.

processChangeEvent

public void processChangeEvent(OMultiValueChangeEvent<?,?> changeEvent,
 Map<Object,Integer> keysToAdd,
 Map<Object,Integer> keysToRemove)

Description copied from interface: OIndexDefinitionMultiValue

Process event that contains operation on collection and extract values that should be added removed from index to reflect collection changes in the given index.

Specified by:

processChangeEvent in interface OIndexDefinitionMultiValue

Parameters:

changeEvent - Event that describes operation that was performed on collection.

keysToAdd - Values that should be added to related index.

keysToRemove - Values that should be removed to related index.

getDocumentValueToIndex

public Object getDocumentValueToIndex(ODocument iDocument)

Specified by:

getDocumentValueToIndex in interface OIndexCallback

Overrides:

getDocumentValueToIndex in class OPropertyIndexDefinition

createValue

public Object createValue(List<?> params)

Description copied from interface: OIndexDefinition

Calculates key value by passed in parameters.

If it is impossible to calculate key value by given parameters null will be returned.

Specified by:

createValue in interface OIndexDefinition

Overrides:

createValue in class OPropertyIndexDefinition

Parameters:

params - Parameters from which index key will be calculated.

Returns:

Key value or null if calculation is impossible.

createValue

public Object createValue(Object... params)

Description copied from class: OPropertyIndexDefinition

Calculates key value by passed in parameters.

If it is impossible to calculate key value by given parameters null will be returned.

Specified by:

createValue in interface OIndexDefinition

Overrides:

createValue in class OPropertyIndexDefinition

Parameters:

params - Parameters from which index key will be calculated.

Returns:

Key value or null if calculation is impossible.

toCreateIndexDDL

public String toCreateIndexDDL(String indexName,
 String indexType,
 String engine)

Description copied from class: OPropertyIndexDefinition

Specified by:

toCreateIndexDDL in interface OIndexDefinition

Overrides:

toCreateIndexDDL in class OPropertyIndexDefinition