com.orientechnologies.orient.core.index

Class OPropertyMapIndexDefinition

java.lang.Object

com.orientechnologies.orient.core.type.ODocumentWrapper

com.orientechnologies.orient.core.type.ODocumentWrapperNoClass

com.orientechnologies.orient.core.index.OAbstractIndexDefinition

com.orientechnologies.orient.core.index.OPropertyIndexDefinition

com.orientechnologies.orient.core.index.OAbstractIndexDefinitionMultiValue

com.orientechnologies.orient.core.index.OPropertyMapIndexDefinition

All Implemented Interfaces:

OIndexCallback, OIndexDefinition, OIndexDefinitionMultiValue, Serializable

public class OPropertyMapIndexDefinition
extends OAbstractIndexDefinitionMultiValue

Index implementation bound to one schema class property that presents {@link com.orientechnologies.orient.core.metadata.schema.OType#EMBEDDEDMAP or

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OPropertyMapIndexDefinition.INDEX_BY Indicates whether Map will be indexed using its keys or values.

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

Fields inherited from class com.orientechnologies.orient.core.type.ODocumentWrapper

document

Constructor Summary

Constructors

Constructor and Description
OPropertyMapIndexDefinition()
OPropertyMapIndexDefinition(String iClassName, String iField, OType iType, OPropertyMapIndexDefinition.INDEX_BY indexBy)

Method Summary

Modifier and Type	Method and Description
Object	createSingleValue(Object... param) Converts passed in value in the key of single index entry.
Object	createValue(List<?> params) Calculates key value by passed in parameters.
Object	createValue(Object... params) Calculates key value by passed in parameters.
boolean	equals(Object o)
Object	getDocumentValueToIndex(ODocument iDocument)
List<String>	getFieldsToIndex()
OPropertyMapIndexDefinition.INDEX_BY	getIndexBy()
int	hashCode()
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.
protected void	serializeFromStream()
protected void	serializeToStream()
String	toCreateIndexDDL(String indexName, String indexType, String engine)
String	toString()

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

isAutomatic, processAdd, processRemoval

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

createIndexDDLWithFieldType, createIndexDDLWithoutFieldType, fromStream, getClassName, getFields, getParamCount, getTypes, toStream

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

getCollate, isNullValuesIgnored, setCollate, setCollate, setNullValuesIgnored

Methods inherited from class com.orientechnologies.orient.core.type.ODocumentWrapperNoClass

fromStream, load, reload, reload, save, save

Methods inherited from class com.orientechnologies.orient.core.type.ODocumentWrapper

getDocument, load, reload

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

fromStream, getClassName, getCollate, getFields, getParamCount, getTypes, isNullValuesIgnored, setCollate, setNullValuesIgnored, toStream

Constructor Detail

OPropertyMapIndexDefinition

public OPropertyMapIndexDefinition()

OPropertyMapIndexDefinition

public OPropertyMapIndexDefinition(String iClassName,
                                   String iField,
                                   OType iType,
                                   OPropertyMapIndexDefinition.INDEX_BY indexBy)

Method Detail

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.

getIndexBy

public OPropertyMapIndexDefinition.INDEX_BY getIndexBy()

serializeToStream

protected void serializeToStream()

Overrides:

serializeToStream in class OPropertyIndexDefinition

serializeFromStream

protected void serializeFromStream()

Overrides:

serializeFromStream in class OPropertyIndexDefinition

equals

public boolean equals(Object o)

Description copied from interface: OIndexDefinition

Specified by:

equals in interface OIndexDefinition

Overrides:

equals in class OPropertyIndexDefinition

createSingleValue

public Object createSingleValue(Object... param)

Description copied from interface: OIndexDefinitionMultiValue

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

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.

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.

getFieldsToIndex

public List<String> getFieldsToIndex()

Specified by:

getFieldsToIndex in interface OIndexDefinition

Overrides:

getFieldsToIndex in class OPropertyIndexDefinition

Returns:

Names of fields and their index modifiers (like "by value" for fields that hold Map values) which given index is used to calculate key value. Order of fields is important.

hashCode

public int hashCode()

Description copied from interface: OIndexDefinition

Specified by:

hashCode in interface OIndexDefinition

Overrides:

hashCode in class OPropertyIndexDefinition

toString

public String toString()

Description copied from interface: OIndexDefinition

Specified by:

toString in interface OIndexDefinition

Overrides:

toString in class OPropertyIndexDefinition

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