com.orientechnologies.orient.core.index

Class OCompositeKey

java.lang.Object

com.orientechnologies.orient.core.index.OCompositeKey

All Implemented Interfaces:

ODocumentSerializable, Serializable, Comparable<OCompositeKey>

Direct Known Subclasses:

OLuceneCompositeKey

public class OCompositeKey
extends Object
implements Comparable<OCompositeKey>, Serializable, ODocumentSerializable

Container for the list of heterogeneous values that are going to be stored in in index as composite keys.

Author:

Andrey Lomakin (a.lomakin-at-orientdb.com), Artem Orobets

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.orientechnologies.orient.core.serialization.ODocumentSerializable

CLASS_NAME

Constructor Summary

Constructors

Constructor and Description
OCompositeKey()
OCompositeKey(List<?> keys)
OCompositeKey(Object... keys)

Method Summary

Modifier and Type	Method and Description
void	addKey(Object key) Add new key value to the list of already registered values.
int	compareTo(OCompositeKey otherKey) Performs partial comparison of two composite keys.
boolean	equals(Object o)
void	fromDocument(ODocument document)
List<Object>	getKeys()
int	hashCode()
void	reset() Clears the keys array for reuse of the object
ODocument	toDocument()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

OCompositeKey

public OCompositeKey(List<?> keys)

OCompositeKey

public OCompositeKey(Object... keys)

OCompositeKey

public OCompositeKey()

Method Detail

reset

public void reset()

Clears the keys array for reuse of the object

getKeys

public List<Object> getKeys()

addKey

public void addKey(Object key)

Add new key value to the list of already registered values.

If passed in value is OCompositeKey itself then its values will be copied in current index. But key itself will not be added.

Parameters:

key - Key to add.

compareTo

public int compareTo(OCompositeKey otherKey)

Performs partial comparison of two composite keys.

Two objects will be equal if the common subset of their keys is equal. For example if first object contains two keys and second contains four keys then only first two keys will be compared.

Specified by:

compareTo in interface Comparable<OCompositeKey>

Parameters:

otherKey - Key to compare.

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toDocument

public ODocument toDocument()

Specified by:

toDocument in interface ODocumentSerializable

fromDocument

public void fromDocument(ODocument document)

Specified by:

fromDocument in interface ODocumentSerializable