Class ValueComparisonRangePredicate
- java.lang.Object
-
- com.apple.foundationdb.record.query.predicates.ValueComparisonRangePredicate
-
- All Implemented Interfaces:
PlanHashable
,Bindable
,Correlated<QueryPredicate>
,PredicateWithValue
,QueryPredicate
- Direct Known Subclasses:
ValueComparisonRangePredicate.Placeholder
,ValueComparisonRangePredicate.Sargable
@API(EXPERIMENTAL) public abstract class ValueComparisonRangePredicate extends Object implements PredicateWithValue
A special predicate used to represent a parameterized tuple range.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ValueComparisonRangePredicate.Placeholder
A place holder predicate solely used for index matching.static class
ValueComparisonRangePredicate.Sargable
A query predicate that can be used as a (s)earch (arg)ument for an index scan.-
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.PlanHashable
PlanHashable.PlanHashKind
-
-
Constructor Summary
Constructors Constructor Description ValueComparisonRangePredicate(Value value)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Stream<PlannerBindings>
bindTo(PlannerBindings outerBindings, ExpressionMatcher<? extends Bindable> matcher)
Attempt to match the matcher to this bindable object.boolean
equals(Object other)
Set<CorrelationIdentifier>
getCorrelatedTo()
Returns the set ofCorrelationIdentifier
s this entity is correlated to.Value
getValue()
int
hashCode()
static ValueComparisonRangePredicate.Placeholder
placeholder(Value value, CorrelationIdentifier parameterAlias)
int
planHash(PlanHashable.PlanHashKind hashKind)
Return a hash similar tohashCode
, but with the additional guarantee that is is stable across JVMs.static ValueComparisonRangePredicate.Sargable
sargable(Value value, ComparisonRange comparisonRange)
boolean
semanticEquals(Object other, AliasMap aliasMap)
Determine equality with respect to an equivalence map betweenCorrelationIdentifier
s based on semantic equality: equality of the plan fragments implementing under the given correlation bindings.int
semanticHashCode()
Return a semantic hash code for this object.-
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.Correlated
rebase
-
Methods inherited from interface com.apple.foundationdb.record.PlanHashable
planHash
-
Methods inherited from interface com.apple.foundationdb.record.query.predicates.QueryPredicate
eval, findImpliedMappings, impliesCandidatePredicate, isTautology
-
-
-
-
Method Detail
-
getValue
@Nonnull public Value getValue()
- Specified by:
getValue
in interfacePredicateWithValue
-
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<QueryPredicate>
- Returns:
- the set of
CorrelationIdentifier
s this entity is correlated to
-
bindTo
@Nonnull public Stream<PlannerBindings> bindTo(@Nonnull PlannerBindings outerBindings, @Nonnull ExpressionMatcher<? extends Bindable> matcher)
Description copied from interface:Bindable
Attempt to match the matcher to this bindable object.
-
semanticEquals
public boolean semanticEquals(@Nullable Object other, @Nonnull AliasMap aliasMap)
Description copied from interface:Correlated
Determine equality with respect to an equivalence map betweenCorrelationIdentifier
s based on semantic equality: equality of the plan fragments implementing under the given correlation bindings. The contract of this variant ofequals()
differs from its regular Java counterpart. A correlation is mostly just one part inside of composition of objects that expresses a more complicated (correlated) structure such as a filter. For instanceq1.x = 5
uses a correlation toq1
. That entity representing the filter is said to be correlated toq1
. Similarly,q1.x = 6
is a different filter and is not equal under any correlation mapping. In contrast, consider a predicate where everything except the correlation is the same, such asq2.x = 5
. Without a binding, these two filters are not the same. However, the filters may be a part of some other entity that can express correlations:SELECT * FROM T as q1 WHERE q1.x = 5
is equal toSELECT * FROM T as q2 WHERE q2.x = 5
. It does not matter thatq1
andq2
are named differently. It is important, however, that their semantic meaning is the same. In the example bothq1
andq2
refer to a record typeT
which presumably is the same record type. Therefore, these two query blocks are the same, even though they are labelled differently. In the context of this method, we can establish equality betweenq1.x = 5
andq2.x = 5
if we know thatq1
andq2
refer to the same underlying entity. The equivalence map passed in encodes that equality betweenCorrelationIdentifier
s. Note: This method has the same interaction withObject.hashCode()
as the regularequals()
method. As we can only ever establish true equality using equivalence maps,hashCode()
implementations in implementors of this interface must not be dependent on any correlation identifiers used in the structure of the entity. Doing so might violate the fundamental property of hash codes:e1.equals(e2, ...) => e1.hashCode() == e2.hashCode()
- Specified by:
semanticEquals
in interfaceCorrelated<QueryPredicate>
- Parameters:
other
- the other object to establish equality withaliasMap
- a map ofCorrelationIdentifier
sids
toids'
. A correlation identifierid
used inthis
should be considered equal to another correlation identifierid'
used inother
if either they are the same byObject.equals(java.lang.Object)
of if there is a mapping fromid
toid'
.- Returns:
true
if both entities are considered equal using the equivalences passed in,false
otherwise
-
semanticHashCode
public int semanticHashCode()
Description copied from interface:Correlated
Return a semantic hash code for this object. The hash code must obey the convention that for any two objectso1
ando2
and for everyAliasMap
aliasMap
:o1.semanticEquals(o1, aliasMap)
followso1.semanticHash() == o2.semanticHash()
Correlated.semanticEquals(java.lang.Object, com.apple.foundationdb.record.query.plan.temp.AliasMap)
returnstrue
for these two objects the plan fragments are considered to produce the same result under the given correlations bindings. The left sideo1.semanticEquals(o1, aliasMap)
depends on anAliasMap
whileo1.semanticHash() == o2.semanticHash()
does not. Hence, the hash that is computed is identical regardless of possible bindings.- Specified by:
semanticHashCode
in interfaceCorrelated<QueryPredicate>
- Returns:
- the semantic hash code
-
planHash
public int planHash(@Nonnull PlanHashable.PlanHashKind hashKind)
Description copied from interface:PlanHashable
Return a hash similar tohashCode
, but with the additional guarantee that is is stable across JVMs.- Specified by:
planHash
in interfacePlanHashable
- Parameters:
hashKind
- the "kind" of hash to calculate. Each kind of hash has a particular logic with regards to included and excluded items.- Returns:
- a stable hash code
-
placeholder
public static ValueComparisonRangePredicate.Placeholder placeholder(@Nonnull Value value, @Nonnull CorrelationIdentifier parameterAlias)
-
sargable
public static ValueComparisonRangePredicate.Sargable sargable(@Nonnull Value value, @Nonnull ComparisonRange comparisonRange)
-
-