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

Class FullUnorderedScanExpression

java.lang.Object

com.apple.foundationdb.record.query.plan.temp.expressions.FullUnorderedScanExpression

All Implemented Interfaces:

Bindable, Correlated<RelationalExpression>, PlannerGraphRewritable, RelationalExpression

@API(EXPERIMENTAL)
public class FullUnorderedScanExpression
extends Object
implements RelationalExpression, PlannerGraphRewritable

A planner expression representing a full, unordered scan of the records by primary key, which is the logical version of a RecordQueryScanPlan with ScanComparisons.EMPTY. Unlike a RecordQueryScanPlan, a FullUnorderedScanExpression is not implicitly ordered by the primary key.

This expression is useful as the source of records for the initial planner expression produced from a RecordQuery.

Nested Class Summary

Nested classes/interfaces inherited from interface com.apple.foundationdb.record.query.plan.temp.RelationalExpression

RelationalExpression.CombineFunction<R,S>, RelationalExpression.CombinePredicate

Constructor Summary

Constructors

Constructor	Description
FullUnorderedScanExpression(Set<String> recordTypes)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object other)
boolean	equalsWithoutChildren(RelationalExpression otherExpression, AliasMap equivalencesMap)
Set<CorrelationIdentifier>	getCorrelatedTo()	Returns the set of CorrelationIdentifiers this entity is correlated to.
List<? extends Quantifier>	getQuantifiers()	Return an iterator of references to the children of this planner expression.
Set<String>	getRecordTypes()
int	hashCode()
int	hashCodeWithoutChildren()
FullUnorderedScanExpression	rebase(AliasMap translationMap)	Rebases this and all other objects this objects is composed of using a given translation map.
PlannerGraph	rewritePlannerGraph(List<? extends PlannerGraph> childGraphs)	Method to rewrite the planner graph.
String	toString()

Methods inherited from class java.lang.Object

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

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

acceptPropertyVisitor, bindIdentities, bindTo, canCorrelate, enumerateUnboundCorrelatedTo, findMatches, match, semanticEquals, semanticEquals, semanticHashCode, show

Constructor Detail

FullUnorderedScanExpression

public FullUnorderedScanExpression(Set<String> recordTypes)

Method Detail

getRecordTypes

@Nonnull
public Set<String> getRecordTypes()

getQuantifiers

@Nonnull
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

getCorrelatedTo

@Nonnull
public Set<CorrelationIdentifier> getCorrelatedTo()

Description copied from interface: Correlated

Returns the set of CorrelationIdentifiers this entity is correlated to. This means that without a process that binds these correlations to values, the RelationalExpression (or others that implement this interface) cannot even in principle produce a meaningful result. As often times entities that implement this interface use composition and effectively describe trees or DAGs, this method should be the set union of the CorrelationIdentifiers this object is correlated to as well as all children, constituent parts, etc.

Specified by:

getCorrelatedTo in interface Correlated<RelationalExpression>

Returns:

the set of CorrelationIdentifiers this entity is correlated to

rebase

@Nonnull
public FullUnorderedScanExpression rebase(@Nonnull
                                          AliasMap translationMap)

Description copied from interface: Correlated

Rebases this and all other objects this objects is composed of using a given translation map.

Specified by:

rebase in interface Correlated<RelationalExpression>

Parameters:

translationMap - a map defining a translation from CorrelationIdentifiers ids to CorrelationIdentifiers ids'. After the rebase, every correlation to an id contained ids that is contained or referred to directly or indirectly by this must have been transformed to use the mapped counterpart of id id' in ids'. IDs not contained in the translation map must remain unmodified by the rebase operation.

Returns:

a new entity that has been rebased

equalsWithoutChildren

public boolean equalsWithoutChildren(@Nonnull
                                     RelationalExpression otherExpression,
                                     @Nonnull
                                     AliasMap equivalencesMap)

Specified by:

equalsWithoutChildren in interface RelationalExpression

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

hashCodeWithoutChildren

public int hashCodeWithoutChildren()

Specified by:

hashCodeWithoutChildren in interface RelationalExpression

toString

public String toString()

Overrides:

toString in class Object

rewritePlannerGraph

@Nonnull
public PlannerGraph rewritePlannerGraph(@Nonnull
                                        List<? extends PlannerGraph> childGraphs)

Description copied from interface: PlannerGraphRewritable

Method to rewrite the planner graph.

Specified by:

rewritePlannerGraph in interface PlannerGraphRewritable

Parameters:

childGraphs - planner graphs of children expression that already have been computed

Returns:

a new planner graph that can combine the childGraphs in a meaningful way. Note that there is no obligation to use the childGraphs at all, this method can create a new independent planner graph completely from scratch.