com.apple.foundationdb.record.query

Interface IndexQueryabilityFilter

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@API(value=EXPERIMENTAL)
 @FunctionalInterface
public interface IndexQueryabilityFilter

A filter used to determine whether an index should be considered when planning queries.

Field Summary

Fields

Modifier and Type	Field and Description
static IndexQueryabilityFilter	DEFAULT The default index queryability filter which uses all indexes except those with the IndexOptions.ALLOWED_FOR_QUERY_OPTION set to false.

Method Summary

Modifier and Type	Method and Description
boolean	isQueryable(Index index) Return whether the given index should be considered by the query planner.

Field Detail

DEFAULT

static final IndexQueryabilityFilter DEFAULT

The default index queryability filter which uses all indexes except those with the IndexOptions.ALLOWED_FOR_QUERY_OPTION set to false.

Method Detail

isQueryable

boolean isQueryable(@Nonnull
                    Index index)

Return whether the given index should be considered by the query planner. Note that the planner is not required to use an index for which isQueryable() is true.

Parameters:

index - an index

Returns:

whether the given index should be considered by the planner