Package com.apple.foundationdb.record.spatial.geophile

Class GeophileSpatialObjectQueryPlan

java.lang.Object

com.apple.foundationdb.record.spatial.geophile.GeophileSpatialObjectQueryPlan

All Implemented Interfaces:

PlanHashable, PlanSerializable, Correlated<RelationalExpression>, com.apple.foundationdb.record.query.plan.cascades.explain.PlannerGraphRewritable, RelationalExpression, Narrowable<RelationalExpression>, com.apple.foundationdb.record.query.plan.cascades.typing.Typed, QueryPlan<FDBQueriedRecord<Message>>, RecordQueryPlan, RecordQueryPlanWithIndex, RecordQueryPlanWithMatchCandidate, RecordQueryPlanWithNoChildren

Direct Known Subclasses:

GeophilePointWithinDistanceQueryPlan

@API(EXPERIMENTAL)
public abstract class GeophileSpatialObjectQueryPlan
extends Object
implements RecordQueryPlanWithNoChildren, RecordQueryPlanWithIndex

Base class for query plans that execute a spatial join between a single spatial object and a spatial index.

Nested Class Summary

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

Correlated.BoundEquivalence<S extends Correlated<S>>

Nested classes/interfaces inherited from interface com.apple.foundationdb.record.PlanHashable

PlanHashable.PlanHashKind, PlanHashable.PlanHashMode

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

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

Field Summary

Fields inherited from interface com.apple.foundationdb.record.PlanHashable

CURRENT_FOR_CONTINUATION, CURRENT_LEGACY

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

UNKNOWN_MAX_CARDINALITY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GeophileSpatialObjectQueryPlan(String indexName, ScanComparisons prefixComparisons)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object other)
boolean	equalsWithoutChildren(RelationalExpression otherExpression, AliasMap equivalencesMap)
<M extends Message> RecordCursor<IndexEntry>	executeEntries(FDBRecordStoreBase<M> store, EvaluationContext context, byte[] continuation, ExecuteProperties executeProperties)
int	getComplexity()
Set<CorrelationIdentifier>	getCorrelatedTo()
protected com.geophile.z.SpatialJoin.Filter<com.geophile.z.index.RecordWithSpatialObject,com.apple.foundationdb.record.spatial.geophile.GeophileRecordImpl>	getFilter(EvaluationContext context)	Get a optional filter to eliminate false positives from the spatial join.
String	getIndexName()
Optional<? extends MatchCandidate>	getMatchCandidateMaybe()
ScanComparisons	getPrefixComparisons()
List<? extends Quantifier>	getQuantifiers()
protected BiFunction<IndexEntry,Tuple,com.apple.foundationdb.record.spatial.geophile.GeophileRecordImpl>	getRecordFunction()	Get the function to use for mapping IndexEntry to GeophileRecordImpl.
IndexScanType	getScanType()
protected abstract com.geophile.z.SpatialObject	getSpatialObject(EvaluationContext context)	Get the spatial object with which to join spatial index entries.
Set<String>	getUsedIndexes()
boolean	hasFullRecordScan()
int	hashCode()
int	hashCodeWithoutChildren()
boolean	hasIndexScan(String indexName)
boolean	hasLoadBykeys()
boolean	hasRecordScan()
boolean	isReverse()
void	logPlanStructure(StoreTimer timer)
GeophileSpatialObjectQueryPlan	translateCorrelations(com.apple.foundationdb.record.query.plan.cascades.values.translation.TranslationMap translationMap, boolean shouldSimplifyValues, List<? extends Quantifier> translatedQuantifiers)

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.cascades.Correlated

isCorrelatedTo

Methods inherited from interface com.apple.foundationdb.record.query.plan.cascades.Narrowable

narrowMaybe

Methods inherited from interface com.apple.foundationdb.record.PlanHashable

planHash, planHash, planHash

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

collectDescendantPlans, execute, execute, isStrictlySorted, maxCardinality

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

accept, canBeMinimized, execute, execute, execute, execute, getAvailableFields, getQueryPlanChildren, minimize, minimize, structuralEquals, structuralEquals, structuralHashCode, toProto, toRecordQueryPlanProto

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

allowedForCoveringIndexPlan, createIndexPlannerGraph, executePlan, fetchIndexRecords, getFetchIndexRecords, rewritePlannerGraph, strictlySorted

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

getMatchCandidate

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

getChildren

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

acceptVisitor, adjustMatch, bindIdentities, canCorrelate, compensate, enumerateUnboundCorrelatedTo, exactlySubsumedBy, findMatches, getCorrelationOrder, getDynamicTypes, getMatchedQuantifiers, getResultType, getResultValue, hasIncompatibleBoundQuantifiers, hasUnboundQuantifiers, isCompatiblyAndCompletelyBound, match, match, rebase, semanticEquals, semanticEquals, semanticEqualsForResults, semanticHashCode, show, showExploratory, subsumedBy, withQuantifiers

Methods inherited from interface com.apple.foundationdb.record.query.plan.cascades.typing.Typed

describe

Constructor Details

GeophileSpatialObjectQueryPlan

protected GeophileSpatialObjectQueryPlan(@Nonnull
 String indexName,
 @Nonnull
 ScanComparisons prefixComparisons)

Method Details

getSpatialObject

@Nullable
protected abstract com.geophile.z.SpatialObject getSpatialObject(@Nonnull
 EvaluationContext context)

Get the spatial object with which to join spatial index entries.

Parameters:

context - query context containing parameter bindings

Returns:

a spatial object to use in spatial join or null if some bound parameter is null.

getFilter

@Nullable
protected com.geophile.z.SpatialJoin.Filter<com.geophile.z.index.RecordWithSpatialObject,com.apple.foundationdb.record.spatial.geophile.GeophileRecordImpl> getFilter(@Nonnull
 EvaluationContext context)

Get a optional filter to eliminate false positives from the spatial join. The filter will have access only to the SpatialObject for the join and the GeophileRecordImpl for the index entry. If the index is covering, GeophileRecordImpl.spatialObject() will then be available. If there is no filter, or the filter is not entirely effective, some QueryComponent form of the original predicate will almost certainly be needed downstream of the SpatialObjectQueryPlan.

Parameters:

context - query context containing parameter bindings

Returns:

a spatial join filter or null if none is possible

getRecordFunction

protected BiFunction<IndexEntry,Tuple,com.apple.foundationdb.record.spatial.geophile.GeophileRecordImpl> getRecordFunction()

Get the function to use for mapping IndexEntry to GeophileRecordImpl. If the index is covering, the indexed SpatialObject may be recoverable from the value part of the index entry.

Returns:

a function that creates new GeophileRecordImpl instances

getPrefixComparisons

@Nonnull
public ScanComparisons getPrefixComparisons()

getIndexName

@Nonnull
public String getIndexName()

Specified by:

getIndexName in interface RecordQueryPlanWithIndex

getScanType

@Nonnull
public IndexScanType getScanType()

Specified by:

getScanType in interface RecordQueryPlanWithIndex

getMatchCandidateMaybe

@Nonnull
public Optional<? extends MatchCandidate> getMatchCandidateMaybe()

Specified by:

getMatchCandidateMaybe in interface RecordQueryPlanWithMatchCandidate

executeEntries

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

Specified by:

executeEntries in interface RecordQueryPlanWithIndex

isReverse

public boolean isReverse()

Specified by:

isReverse in interface QueryPlan<FDBQueriedRecord<Message>>

hasRecordScan

public boolean hasRecordScan()

Specified by:

hasRecordScan in interface QueryPlan<FDBQueriedRecord<Message>>

hasFullRecordScan

public boolean hasFullRecordScan()

Specified by:

hasFullRecordScan in interface QueryPlan<FDBQueriedRecord<Message>>

hasIndexScan

public boolean hasIndexScan(@Nonnull
 String indexName)

Specified by:

hasIndexScan in interface QueryPlan<FDBQueriedRecord<Message>>

getUsedIndexes

@Nonnull
public Set<String> getUsedIndexes()

Specified by:

getUsedIndexes in interface QueryPlan<FDBQueriedRecord<Message>>

hasLoadBykeys

public boolean hasLoadBykeys()

Specified by:

hasLoadBykeys in interface QueryPlan<FDBQueriedRecord<Message>>

logPlanStructure

public void logPlanStructure(StoreTimer timer)

Specified by:

logPlanStructure in interface QueryPlan<FDBQueriedRecord<Message>>

getComplexity

public int getComplexity()

Specified by:

getComplexity in interface QueryPlan<FDBQueriedRecord<Message>>

getQuantifiers

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

Specified by:

getQuantifiers in interface RecordQueryPlanWithNoChildren

Specified by:

getQuantifiers in interface RelationalExpression

getCorrelatedTo

@Nonnull
public Set<CorrelationIdentifier> getCorrelatedTo()

Specified by:

getCorrelatedTo in interface Correlated<RelationalExpression>

translateCorrelations

@Nonnull
public GeophileSpatialObjectQueryPlan translateCorrelations(@Nonnull
 com.apple.foundationdb.record.query.plan.cascades.values.translation.TranslationMap translationMap,
 boolean shouldSimplifyValues,
 @Nonnull
 List<? extends Quantifier> translatedQuantifiers)

Specified by:

translateCorrelations in interface RecordQueryPlanWithIndex

Specified by:

translateCorrelations in interface RelationalExpression

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