Class IndexEntrySourceScanExpression
- java.lang.Object
-
- com.apple.foundationdb.record.query.plan.temp.expressions.IndexEntrySourceScanExpression
-
- All Implemented Interfaces:
Bindable
,Correlated<RelationalExpression>
,RelationalExpression
public class IndexEntrySourceScanExpression extends Object implements RelationalExpression
A logical version ofRecordQueryIndexPlan
that represents a partially-implemented index scan. The primary difference between the two is that aRecordQueryIndexPlan
requires a fully formedScanComparisons
, which does not track which comparisons belong to which parts of the index's key expression. In contrast, this logical index scan has aViewExpressionComparisons
which explicitly tracks that information. Except for the final "implementation" rules, a planner rule should generally prefer to produce and consumeIndexEntrySourceScanExpression
s so that important information about the index key expression is retained.- See Also:
which converts this to a
-
-
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 IndexEntrySourceScanExpression(IndexEntrySource indexEntrySource, IndexScanType scanType, ViewExpressionComparisons comparisons, boolean reverse)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object other)
boolean
equalsWithoutChildren(RelationalExpression otherExpression, AliasMap equivalencesMap)
ViewExpressionComparisons
getComparisons()
Set<CorrelationIdentifier>
getCorrelatedTo()
Returns the set ofCorrelationIdentifier
s this entity is correlated to.IndexEntrySource
getIndexEntrySource()
String
getIndexName()
List<? extends Quantifier>
getQuantifiers()
Return an iterator of references to the children of this planner expression.IndexScanType
getScanType()
int
hashCode()
int
hashCodeWithoutChildren()
boolean
isReverse()
IndexEntrySourceScanExpression
rebase(AliasMap translationMap)
Rebases this and all other objects this objects is composed of using a given translation map.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
-
IndexEntrySourceScanExpression
public IndexEntrySourceScanExpression(@Nonnull IndexEntrySource indexEntrySource, @Nonnull IndexScanType scanType, @Nonnull ViewExpressionComparisons comparisons, boolean reverse)
-
-
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 whenCollections.emptyIterator()
is returned. The returned iterator should be treated as an immutable object and may throw an exception ifIterator.remove()
is called. The iterator must return its elements in a consistent order.- Specified by:
getQuantifiers
in interfaceRelationalExpression
- Returns:
- an iterator of references to the children of this planner expression
-
getIndexEntrySource
@Nonnull public IndexEntrySource getIndexEntrySource()
-
getScanType
@Nonnull public IndexScanType getScanType()
-
getComparisons
@Nonnull public ViewExpressionComparisons getComparisons()
-
isReverse
public boolean isReverse()
-
getCorrelatedTo
@Nonnull public Set<CorrelationIdentifier> getCorrelatedTo()
Description copied from interface:Correlated
Returns the set ofCorrelationIdentifier
s this entity is correlated to. This means that without a process that binds these correlations to values, theRelationalExpression
(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 theCorrelationIdentifier
s this object is correlated to as well as all children, constituent parts, etc.- Specified by:
getCorrelatedTo
in interfaceCorrelated<RelationalExpression>
- Returns:
- the set of
CorrelationIdentifier
s this entity is correlated to
-
rebase
@Nonnull public IndexEntrySourceScanExpression 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 interfaceCorrelated<RelationalExpression>
- Parameters:
translationMap
- a map defining a translation fromCorrelationIdentifier
sids
toCorrelationIdentifier
sids'
. After the rebase, every correlation to anid
containedids
that is contained or referred to directly or indirectly bythis
must have been transformed to use the mapped counterpart ofid
id'
inids'
. 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 interfaceRelationalExpression
-
hashCodeWithoutChildren
public int hashCodeWithoutChildren()
- Specified by:
hashCodeWithoutChildren
in interfaceRelationalExpression
-
-