Package com.apple.foundationdb.record.query.plan

Class PlannableIndexTypes

java.lang.Object

com.apple.foundationdb.record.query.plan.PlannableIndexTypes

@API(EXPERIMENTAL)
public class PlannableIndexTypes
extends Object

A wrapper class to identify groups of that behave the same way from the perspective of the planner. For example, index types should generally support implementing the same types of filters, sort, and aggregates. A PlannableIndexTypes object can be passed to a RecordQueryPlanner when it is initialized so that users of the Record Layer can define their own index types. This is a bit of a hack, and we should really fix it in the future. TODO: Define index "behaviors" with defined contracts, for use in planning and index maintenance (https://github.com/FoundationDB/fdb-record-layer/issues/16)

See Also:

IndexTypes

Field Summary

Fields

Modifier and Type	Field	Description
static PlannableIndexTypes	DEFAULT

Constructor Summary

Constructors

Constructor	Description
PlannableIndexTypes(Set<String> valueTypes, Set<String> rankTypes, Set<String> textTypes)

Method Summary

Modifier and Type	Method	Description
Set<String>	getRankTypes()
Set<String>	getTextTypes()
Set<String>	getValueTypes()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT

public static final PlannableIndexTypes DEFAULT

Constructor Detail

PlannableIndexTypes

public PlannableIndexTypes(@Nonnull
                           Set<String> valueTypes,
                           @Nonnull
                           Set<String> rankTypes,
                           @Nonnull
                           Set<String> textTypes)

Method Detail

getValueTypes

@Nonnull
public Set<String> getValueTypes()

getRankTypes

@Nonnull
public Set<String> getRankTypes()

getTextTypes

@Nonnull
public Set<String> getTextTypes()