Interface ISpaceCompoundIndexSegment

All Superinterfaces:

Externalizable, ISwapExternalizable, Serializable, SmartExternalizable

All Known Implementing Classes:

AbstractCompoundIndexSegment, PathCompoundIndexSegment, PropertyCompoundIndexSegment

public interface ISpaceCompoundIndexSegment
extends SmartExternalizable, ISwapExternalizable

Encapsulates information about an index segment of a compound index.

Since:

9.5

Author:

Yechiel Fefer

Method Summary

Modifier and Type	Method	Description
String	getName()
int	getSegmentPosition()
Object	getSegmentValue(ServerEntry entry)
Object	getSegmentValueForTemplate(ServerEntry entry)
boolean	isPropertySegment()

Methods inherited from interface Externalizable

readExternal, writeExternal

Methods inherited from interface ISwapExternalizable

readFromSwap, writeToSwap

Methods inherited from interface SmartExternalizable

enabledSmartExternalizableWithReference

Method Details

getSegmentValue

Object getSegmentValue(ServerEntry entry)

Returns:

the value that will be used for this segment using a given entry

getSegmentValueForTemplate

Object getSegmentValueForTemplate(ServerEntry entry)

Returns:

the value that will be used for this segment using a given template

getSegmentPosition

int getSegmentPosition()

Returns:

the positio0n of this segment in the compound index

getName

String getName()

Returns:

the path name of this segment

isPropertySegment

boolean isPropertySegment()

Returns:

true if its a property segment