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

Class GeophilePointWithinDistanceQueryPlan

java.lang.Object

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

com.apple.foundationdb.record.spatial.geophile.GeophilePointWithinDistanceQueryPlan

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

@API(EXPERIMENTAL)
public class GeophilePointWithinDistanceQueryPlan
extends GeophileSpatialObjectQueryPlan

Query spatial index for points (latitude, longitude) within a given distance (inclusive) of a given center.

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

Constructor	Description
GeophilePointWithinDistanceQueryPlan(DoubleValueOrParameter centerLatitude, DoubleValueOrParameter centerLongitude, DoubleValueOrParameter distance, String indexName, ScanComparisons prefixComparisons, boolean covering)

Method Summary

Modifier and Type	Method	Description
com.apple.foundationdb.record.query.plan.cascades.explain.PlannerGraph	createIndexPlannerGraph(RecordQueryPlan identity, com.apple.foundationdb.record.query.plan.cascades.explain.NodeInfo nodeInfo, List<String> additionalDetails, Map<String,com.apple.foundationdb.record.query.plan.cascades.explain.Attribute> additionalAttributeMap)
boolean	equalsWithoutChildren(RelationalExpression otherExpression, AliasMap equivalencesMap)
AvailableFields	getAvailableFields()
RecordQueryFetchFromPartialRecordPlan.FetchIndexRecords	getFetchIndexRecords()
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.
protected BiFunction<IndexEntry,Tuple,com.apple.foundationdb.record.spatial.geophile.GeophileRecordImpl>	getRecordFunction()	Get the function to use for mapping IndexEntry to GeophileRecordImpl.
Value	getResultValue()
protected com.geophile.z.SpatialObject	getSpatialObject(EvaluationContext context)	Get the spatial object with which to join spatial index entries.
int	hashCodeWithoutChildren()
int	planHash(PlanHashable.PlanHashMode mode)
com.apple.foundationdb.record.query.plan.cascades.explain.PlannerGraph	rewritePlannerGraph(List<? extends com.apple.foundationdb.record.query.plan.cascades.explain.PlannerGraph> childGraphs)
Message	toProto(PlanSerializationContext serializationContext)
com.apple.foundationdb.record.planprotos.PRecordQueryPlan	toRecordQueryPlanProto(PlanSerializationContext serializationContext)

Methods inherited from class com.apple.foundationdb.record.spatial.geophile.GeophileSpatialObjectQueryPlan

equals, executeEntries, getComplexity, getCorrelatedTo, getIndexName, getMatchCandidateMaybe, getPrefixComparisons, getQuantifiers, getScanType, getUsedIndexes, hasFullRecordScan, hashCode, hasIndexScan, hasLoadBykeys, hasRecordScan, isReverse, logPlanStructure, translateCorrelations

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

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, getQueryPlanChildren, minimize, minimize, structuralEquals, structuralEquals, structuralHashCode

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

allowedForCoveringIndexPlan, executePlan, fetchIndexRecords, 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, 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

GeophilePointWithinDistanceQueryPlan

public GeophilePointWithinDistanceQueryPlan(@Nonnull
 DoubleValueOrParameter centerLatitude,
 @Nonnull
 DoubleValueOrParameter centerLongitude,
 @Nonnull
 DoubleValueOrParameter distance,
 @Nonnull
 String indexName,
 @Nonnull
 ScanComparisons prefixComparisons,
 boolean covering)

Method Details

getSpatialObject

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

Description copied from class: GeophileSpatialObjectQueryPlan

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

Specified by:

getSpatialObject in class GeophileSpatialObjectQueryPlan

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)

Description copied from class: GeophileSpatialObjectQueryPlan

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.

Overrides:

getFilter in class GeophileSpatialObjectQueryPlan

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()

Description copied from class: GeophileSpatialObjectQueryPlan

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.

Overrides:

getRecordFunction in class GeophileSpatialObjectQueryPlan

Returns:

a function that creates new GeophileRecordImpl instances

getAvailableFields

@Nonnull
public AvailableFields getAvailableFields()

getFetchIndexRecords

@Nonnull
public RecordQueryFetchFromPartialRecordPlan.FetchIndexRecords getFetchIndexRecords()

getResultValue

@Nonnull
public Value getResultValue()

planHash

public int planHash(@Nonnull
 PlanHashable.PlanHashMode mode)

equalsWithoutChildren

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

Specified by:

equalsWithoutChildren in interface RelationalExpression

Overrides:

equalsWithoutChildren in class GeophileSpatialObjectQueryPlan

hashCodeWithoutChildren

public int hashCodeWithoutChildren()

Specified by:

hashCodeWithoutChildren in interface RelationalExpression

Overrides:

hashCodeWithoutChildren in class GeophileSpatialObjectQueryPlan

rewritePlannerGraph

@Nonnull
public com.apple.foundationdb.record.query.plan.cascades.explain.PlannerGraph rewritePlannerGraph(@Nonnull
 List<? extends com.apple.foundationdb.record.query.plan.cascades.explain.PlannerGraph> childGraphs)

createIndexPlannerGraph

@Nonnull
public com.apple.foundationdb.record.query.plan.cascades.explain.PlannerGraph createIndexPlannerGraph(@Nonnull
 RecordQueryPlan identity,
 @Nonnull
 com.apple.foundationdb.record.query.plan.cascades.explain.NodeInfo nodeInfo,
 @Nonnull
 List<String> additionalDetails,
 @Nonnull
 Map<String,com.apple.foundationdb.record.query.plan.cascades.explain.Attribute> additionalAttributeMap)

toProto

@Nonnull
public Message toProto(@Nonnull
 PlanSerializationContext serializationContext)

toRecordQueryPlanProto

@Nonnull
public com.apple.foundationdb.record.planprotos.PRecordQueryPlan toRecordQueryPlanProto(@Nonnull
 PlanSerializationContext serializationContext)