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

Class LogicalSortExpression

java.lang.Object

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

All Implemented Interfaces:

Bindable, Correlated<RelationalExpression>, InternalPlannerGraphRewritable, RelationalExpressionWithChildren, RelationalExpression

@API(EXPERIMENTAL)
public class LogicalSortExpression
extends Object
implements RelationalExpressionWithChildren, InternalPlannerGraphRewritable

A relational planner expression that represents an unimplemented sort on the records produced by its inner relational planner expression.

Nested Class Summary

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

Correlated.BoundEquivalence

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
LogicalSortExpression(KeyExpression sort, boolean reverse, Quantifier inner)
LogicalSortExpression(KeyExpression sort, boolean reverse, RelationalExpression inner)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object other)
boolean	equalsWithoutChildren(RelationalExpression otherExpression, AliasMap equivalencesMap)
Set<CorrelationIdentifier>	getCorrelatedToWithoutChildren()
List<? extends Quantifier>	getQuantifiers()	Return an iterator of references to the children of this planner expression.
int	getRelationalChildCount()
KeyExpression	getSort()
int	hashCode()
int	hashCodeWithoutChildren()
boolean	isReverse()
LogicalSortExpression	rebase(AliasMap translationMap)	Rebases this and all other objects this objects is composed of using a given translation map.
LogicalSortExpression	rebaseWithRebasedQuantifiers(AliasMap translationMap, List<Quantifier> rebasedQuantifiers)
PlannerGraph	rewriteInternalPlannerGraph(List<? extends PlannerGraph> childGraphs)	Method to rewrite the planner graph.

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.RelationalExpression

acceptPropertyVisitor, adjustMatch, bindIdentities, bindTo, canCorrelate, compensate, enumerateUnboundCorrelatedTo, exactlySubsumedBy, findMatches, getResultValues, hasIncompatibleBoundQuantifiers, hasUnboundQuantifiers, match, match, semanticEquals, semanticEquals, semanticHashCode, show, subsumedBy

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

getCorrelatedTo

Constructor Detail

LogicalSortExpression

public LogicalSortExpression(@Nonnull
                             KeyExpression sort,
                             boolean reverse,
                             @Nonnull
                             RelationalExpression inner)

LogicalSortExpression

public LogicalSortExpression(@Nonnull
                             KeyExpression sort,
                             boolean reverse,
                             @Nonnull
                             Quantifier inner)

Method Detail

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

getRelationalChildCount

public int getRelationalChildCount()

Specified by:

getRelationalChildCount in interface RelationalExpressionWithChildren

getSort

@Nonnull
public KeyExpression getSort()

isReverse

public boolean isReverse()

getCorrelatedToWithoutChildren

@Nonnull
public Set<CorrelationIdentifier> getCorrelatedToWithoutChildren()

Specified by:

getCorrelatedToWithoutChildren in interface RelationalExpressionWithChildren

rebase

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

Specified by:

rebase in interface RelationalExpressionWithChildren

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

rebaseWithRebasedQuantifiers

@Nonnull
public LogicalSortExpression rebaseWithRebasedQuantifiers(@Nonnull
                                                          AliasMap translationMap,
                                                          @Nonnull
                                                          List<Quantifier> rebasedQuantifiers)

Specified by:

rebaseWithRebasedQuantifiers in interface RelationalExpressionWithChildren

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

rewriteInternalPlannerGraph

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

Description copied from interface: InternalPlannerGraphRewritable

Method to rewrite the planner graph.

Specified by:

rewriteInternalPlannerGraph in interface InternalPlannerGraphRewritable

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.