Package com.apple.foundationdb.record.query

Class RecordQuery.Builder

java.lang.Object

com.apple.foundationdb.record.query.RecordQuery.Builder

Enclosing class:

RecordQuery

public static class RecordQuery.Builder
extends Object

A builder for RecordQuery.

 RecordQuery.newBuilder()
                 .setRecordType("MyRecord")
                 .setFilter(Query.and(
                         Query.field("str_value").equalsValue("xyz"),
                         Query.field("num_value").equalsValue(123)))
                 .setSort(field("rec_no"))
                 .build()
 

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()
protected	Builder(RecordQuery query)

Method Summary

Modifier and Type	Method	Description
RecordQuery	build()
Collection<String>	getAllowedIndexes()
QueryComponent	getFilter()
Collection<String>	getRecordTypes()
List<KeyExpression>	getRequiredResults()
KeyExpression	getSort()
boolean	isSortReverse()
RecordQuery.Builder	setAllowedIndex(String allowedIndex)
RecordQuery.Builder	setAllowedIndexes(Collection<String> allowedIndexes)	Define the indexes that the planner can consider when planning the query.
RecordQuery.Builder	setFilter(QueryComponent filter)
RecordQuery.Builder	setIndexQueryabilityFilter(IndexQueryabilityFilter queryabilityFilter)	Set a function that defines whether each index should be used by the query planner.
RecordQuery.Builder	setRecordType(String recordType)
RecordQuery.Builder	setRecordTypes(Collection<String> recordTypes)
RecordQuery.Builder	setRemoveDuplicates(boolean removeDuplicates)
RecordQuery.Builder	setRequiredResults(List<KeyExpression> requiredResults)
RecordQuery.Builder	setSort(KeyExpression sort)
RecordQuery.Builder	setSort(KeyExpression sort, boolean sortReverse)

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

protected Builder()

Builder

protected Builder(RecordQuery query)

Method Detail

build

public RecordQuery build()

getRecordTypes

@Nonnull
public Collection<String> getRecordTypes()

setRecordTypes

public RecordQuery.Builder setRecordTypes(@Nonnull
                                          Collection<String> recordTypes)

setRecordType

public RecordQuery.Builder setRecordType(@Nonnull
                                         String recordType)

getAllowedIndexes

@Nullable
public Collection<String> getAllowedIndexes()

setAllowedIndexes

public RecordQuery.Builder setAllowedIndexes(@Nullable
                                             Collection<String> allowedIndexes)

Define the indexes that the planner can consider when planning the query. If set, the allowed indexes override the index queryability filter.

Parameters:

allowedIndexes - a collection of index names

Returns:

this builder

setAllowedIndex

public RecordQuery.Builder setAllowedIndex(@Nullable
                                           String allowedIndex)

setIndexQueryabilityFilter

public RecordQuery.Builder setIndexQueryabilityFilter(@Nonnull
                                                      IndexQueryabilityFilter queryabilityFilter)

Set a function that defines whether each index should be used by the query planner. Note that if allowed indexes are used then the queryability filter is ignored. The default index queryability filter is IndexQueryabilityFilter.DEFAULT.

Parameters:

queryabilityFilter - a queryability filter to use

Returns:

this builder

getFilter

@Nullable
public QueryComponent getFilter()

setFilter

public RecordQuery.Builder setFilter(@Nullable
                                     QueryComponent filter)

getSort

@Nullable
public KeyExpression getSort()

isSortReverse

public boolean isSortReverse()

setSort

public RecordQuery.Builder setSort(@Nullable
                                   KeyExpression sort,
                                   boolean sortReverse)

setSort

public RecordQuery.Builder setSort(@Nullable
                                   KeyExpression sort)

setRemoveDuplicates

public RecordQuery.Builder setRemoveDuplicates(boolean removeDuplicates)

getRequiredResults

@Nullable
public List<KeyExpression> getRequiredResults()

setRequiredResults

public RecordQuery.Builder setRequiredResults(@Nullable
                                              List<KeyExpression> requiredResults)