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

Class TextScanPlanner

java.lang.Object

com.apple.foundationdb.record.query.plan.planning.TextScanPlanner

@API(INTERNAL)
public class TextScanPlanner
extends Object

A utility class for choosing a TextScan object to satisfy a text query.

Method Summary

Modifier and Type	Method	Description
static List<KeyExpression>	getOtherFields(KeyExpression indexExpression)
static TextScan	getScanForQuery(Index index, QueryComponent filter, boolean hasSort, FilterSatisfiedMask filterMask)	Get a scan that matches a filter in the list of filters provided.
static KeyExpression	getTokenizedField(KeyExpression indexExpression)

Methods inherited from class java.lang.Object

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

Method Detail

getScanForQuery

@Nullable
public static TextScan getScanForQuery(@Nonnull
                                       Index index,
                                       @Nonnull
                                       QueryComponent filter,
                                       boolean hasSort,
                                       @Nonnull
                                       FilterSatisfiedMask filterMask)

Get a scan that matches a filter in the list of filters provided. It looks to satisfy the grouping key of the index, and then it looks for a text filter within the list of filters and checks to see if the given index is compatible with the filter. If it is, it will construct a scan that satisfies that filter using the index.

Parameters:

index - the text index to check

filter - a filter that the query must satisfy

hasSort - whether the query has a sort associated with it

filterMask - a mask over the filter containing state about which filters have been satisfied

Returns:

a text scan or null if none is found

getTokenizedField

@Nonnull
public static KeyExpression getTokenizedField(@Nonnull
                                              KeyExpression indexExpression)

getOtherFields

@Nonnull
public static List<KeyExpression> getOtherFields(@Nonnull
                                                 KeyExpression indexExpression)