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

Class RecordQueryInJoinPlan

java.lang.Object

com.apple.foundationdb.record.query.plan.plans.RecordQueryInJoinPlan

All Implemented Interfaces:

PlanHashable, QueryPlan<FDBQueriedRecord<Message>>, RecordQueryPlan, RecordQueryPlanWithChild, RecordQueryPlanWithChildren, Bindable, PlannerGraphRewritable, RelationalExpressionWithChildren, RelationalExpression

Direct Known Subclasses:

RecordQueryInParameterJoinPlan, RecordQueryInValuesJoinPlan

@API(MAINTAINED)
public abstract class RecordQueryInJoinPlan
extends Object
implements RecordQueryPlanWithChild

A query plan that executes a child plan once for each of the elements of some IN list.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	bindingName
protected ExpressionRef<RecordQueryPlan>	plan
protected boolean	sortReverse
protected boolean	sortValuesNeeded
protected static Comparator<Object>	VALUE_COMPARATOR

Constructor Summary

Constructors

Constructor	Description
RecordQueryInJoinPlan(RecordQueryPlan plan, String bindingName, boolean sortValuesNeeded, boolean sortReverse)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
boolean	equalsWithoutChildren(RelationalExpression otherExpression)
<M extends Message> RecordCursor<FDBQueriedRecord<M>>	execute(FDBRecordStoreBase<M> store, EvaluationContext context, byte[] continuation, ExecuteProperties executeProperties)	Execute this query plan.
RecordQueryPlan	getChild()
int	getComplexity()	Returns an integer representing the "complexity" of the generated plan.
RecordQueryPlan	getInner()
List<? extends Quantifier>	getQuantifiers()	Return an iterator of references to the children of this planner expression.
protected abstract List<Object>	getValues(EvaluationContext context)
int	hashCode()
boolean	isReverse()	Indicates whether this plan will return values in "reverse" order from the natural order of results of this plan.
boolean	isSorted()
int	planHash()	Return a hash similar to hashCode, but with the additional guarantee that is is stable across JVMs.
protected List<Object>	sortValues(List<Object> values)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.apple.foundationdb.record.query.plan.temp.explain.PlannerGraphRewritable

rewritePlannerGraph

Methods inherited from interface com.apple.foundationdb.record.query.plan.plans.QueryPlan

execute, execute, logPlanStructure

Methods inherited from interface com.apple.foundationdb.record.query.plan.plans.RecordQueryPlan

execute, execute, execute, getQueryPlanChildren

Methods inherited from interface com.apple.foundationdb.record.query.plan.plans.RecordQueryPlanWithChild

getChildren, getRelationalChildCount, getUsedIndexes, hasFullRecordScan, hasIndexScan, hasLoadBykeys, hasRecordScan

Methods inherited from interface com.apple.foundationdb.record.query.plan.temp.RelationalExpression

acceptPropertyVisitor, bindTo, show

Field Detail

VALUE_COMPARATOR

protected static final Comparator<Object> VALUE_COMPARATOR

plan

protected final ExpressionRef<RecordQueryPlan> plan

bindingName

protected final String bindingName

sortValuesNeeded

protected final boolean sortValuesNeeded

sortReverse

protected final boolean sortReverse

Constructor Detail

RecordQueryInJoinPlan

public RecordQueryInJoinPlan(RecordQueryPlan plan,
                             String bindingName,
                             boolean sortValuesNeeded,
                             boolean sortReverse)

Method Detail

execute

@Nonnull
public <M extends Message> RecordCursor<FDBQueriedRecord<M>> execute(@Nonnull
                                                                     FDBRecordStoreBase<M> store,
                                                                     @Nonnull
                                                                     EvaluationContext context,
                                                                     @Nullable
                                                                     byte[] continuation,
                                                                     @Nonnull
                                                                     ExecuteProperties executeProperties)

Description copied from interface: RecordQueryPlan

Execute this query plan.

Specified by:

execute in interface RecordQueryPlan

Type Parameters:

M - type used to represent stored records

Parameters:

store - record store from which to fetch records

context - evaluation context containing parameter bindings

continuation - continuation from a previous execution of this same plan

executeProperties - limits on execution

Returns:

a cursor of records that match the query criteria

getInner

@Nonnull
public RecordQueryPlan getInner()

getChild

@Nonnull
public RecordQueryPlan getChild()

Specified by:

getChild in interface RecordQueryPlanWithChild

isSorted

public boolean isSorted()

getQuantifiers

@Nonnull
@API(EXPERIMENTAL)
public List<? extends Quantifier> getQuantifiers()

Description copied from interface: RelationalExpression

Return an iterator of references to the children of this planner expression. The iterators returned by different calls are guaranteed to be independent (i.e., advancing one will not advance another). However, they might point to the same object, as when Collections.emptyIterator() is returned. The returned iterator should be treated as an immutable object and may throw an exception if Iterator.remove() is called. The iterator must return its elements in a consistent order.

Specified by:

getQuantifiers in interface RelationalExpression

Returns:

an iterator of references to the children of this planner expression

isReverse

public boolean isReverse()

Description copied from interface: QueryPlan

Indicates whether this plan will return values in "reverse" order from the natural order of results of this plan. The return value is true if the plan returns elements in descending order and false if the elements are returned in ascending order.

Specified by:

isReverse in interface QueryPlan<FDBQueriedRecord<Message>>

Returns:

true if this plan returns elements in reverse order

equalsWithoutChildren

@API(EXPERIMENTAL)
public boolean equalsWithoutChildren(@Nonnull
                                     RelationalExpression otherExpression)

Specified by:

equalsWithoutChildren in interface RelationalExpression

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

planHash

public int planHash()

Description copied from interface: PlanHashable

Return a hash similar to hashCode, but with the additional guarantee that is is stable across JVMs.

Specified by:

planHash in interface PlanHashable

Returns:

a stable hash code

sortValues

@Nullable
protected List<Object> sortValues(@Nullable
                                  List<Object> values)

getValues

@Nullable
protected abstract List<Object> getValues(EvaluationContext context)

getComplexity

public int getComplexity()

Description copied from interface: QueryPlan

Returns an integer representing the "complexity" of the generated plan. Currently, this should simply be the number of plans in the plan tree with this plan as the root (i.e. the number of descendants of this plan, including itself).

Specified by:

getComplexity in interface QueryPlan<FDBQueriedRecord<Message>>

Returns:

the complexity of this plan