com.orientechnologies.orient.core.index

Class OPropertyIndexDefinition

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

All Implemented Interfaces:

OIndexCallback, OIndexDefinition, Serializable

Direct Known Subclasses:

OAbstractIndexDefinitionMultiValue

public class OPropertyIndexDefinition
extends OAbstractIndexDefinition

Index implementation bound to one schema class property.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	className
protected String	field
protected OType	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
OPropertyIndexDefinition() Constructor used for index unmarshalling.
OPropertyIndexDefinition(String iClassName, String iField, OType iType)

Method Summary

Modifier and Type	Method and Description
protected StringBuilder	createIndexDDLWithFieldType(String indexName, String indexType, String engine)
protected StringBuilder	createIndexDDLWithoutFieldType(String indexName, String indexType, String engine)
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)
protected void	fromStream()
String	getClassName()
Object	getDocumentValueToIndex(ODocument iDocument)
List<String>	getFields()
List<String>	getFieldsToIndex()
int	getParamCount() Returns amount of parameters that are used to calculate key value.
OType[]	getTypes() Return types of values from which index key consist.
int	hashCode()
boolean	isAutomatic()
protected void	serializeFromStream()
protected void	serializeToStream()
String	toCreateIndexDDL(String indexName, String indexType, String engine)
ODocument	toStream() Serializes internal index state to document.
String	toString()

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, 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

Field Detail

className

protected String className

field

protected String field

keyType

protected OType keyType

Constructor Detail

OPropertyIndexDefinition

public OPropertyIndexDefinition(String iClassName,
                                String iField,
                                OType iType)

OPropertyIndexDefinition

public OPropertyIndexDefinition()

Constructor used for index unmarshalling.

Method Detail

getClassName

public String getClassName()

Returns:

Name of the class which this index belongs to.

getFields

public List<String> getFields()

Returns:

Names of fields which given index is used to calculate key value. Order of fields is important.

getFieldsToIndex

public List<String> getFieldsToIndex()

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.

getDocumentValueToIndex

public Object getDocumentValueToIndex(ODocument iDocument)

equals

public boolean equals(Object o)

Description copied from interface: OIndexDefinition

Specified by:

equals in interface OIndexDefinition

Overrides:

equals in class OAbstractIndexDefinition

hashCode

public int hashCode()

Description copied from interface: OIndexDefinition

Specified by:

hashCode in interface OIndexDefinition

Overrides:

hashCode in class OAbstractIndexDefinition

toString

public String toString()

Description copied from interface: OIndexDefinition

Specified by:

toString in interface OIndexDefinition

Overrides:

toString in class ODocumentWrapper

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.

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)

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

Parameters:

params - Parameters from which index key will be calculated.

Returns:

Key value or null if calculation is impossible.

getParamCount

public int getParamCount()

Description copied from interface: OIndexDefinition

Returns amount of parameters that are used to calculate key value. It does not mean that all parameters should be supplied. It only means that if you provide more parameters they will be ignored and will not participate in index key calculation.

Returns:

Amount of that are used to calculate key value. Call result should be equals to getTypes().length.

getTypes

public OType[] getTypes()

Description copied from interface: OIndexDefinition

Return types of values from which index key consist. In case of index that is built on single document property value single array that contains property type will be returned. In case of composite indexes result will contain several key types.

Returns:

Types of values from which index key consist.

fromStream

protected final void fromStream()

Specified by:

fromStream in class ODocumentWrapperNoClass

toStream

public final ODocument toStream()

Description copied from interface: OIndexDefinition

Serializes internal index state to document.

Specified by:

toStream in interface OIndexDefinition

Overrides:

toStream in class ODocumentWrapper

Returns:

Document that contains internal index state.

serializeToStream

protected void serializeToStream()

Overrides:

serializeToStream in class OAbstractIndexDefinition

serializeFromStream

protected void serializeFromStream()

Overrides:

serializeFromStream in class OAbstractIndexDefinition

toCreateIndexDDL

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

Parameters:

indexName -

indexType -

createIndexDDLWithFieldType

protected StringBuilder createIndexDDLWithFieldType(String indexName,
                                                    String indexType,
                                                    String engine)

createIndexDDLWithoutFieldType

protected StringBuilder createIndexDDLWithoutFieldType(String indexName,
                                                       String indexType,
                                                       String engine)

isAutomatic

public boolean isAutomatic()