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

Class GeophileSpatialFunctionKeyExpression

java.lang.Object

com.apple.foundationdb.record.metadata.expressions.BaseKeyExpression

com.apple.foundationdb.record.metadata.expressions.FunctionKeyExpression

com.apple.foundationdb.record.spatial.geophile.GeophileSpatialFunctionKeyExpression

All Implemented Interfaces:

AtomKeyExpression, KeyExpression, KeyExpressionWithChild, KeyExpressionWithChildren, PlanHashable

Direct Known Subclasses:

GeophileSpatialFunctionKeyExpression.GeoJsonZ, GeophileSpatialFunctionKeyExpression.GeoPointZ, GeophileSpatialFunctionKeyExpression.GeoWKBZ, GeophileSpatialFunctionKeyExpression.GeoWKTZ

@API(EXPERIMENTAL)
public abstract class GeophileSpatialFunctionKeyExpression
extends FunctionKeyExpression

Spatial function key expressions.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GeophileSpatialFunctionKeyExpression.GeoJsonZ	A serialized JTS geometry in GeoJson text format.
static class	GeophileSpatialFunctionKeyExpression.GeoPointZ	A geospatial point.
static class	GeophileSpatialFunctionKeyExpression.GeoWKBZ	A serialized JTS geometry in WKB binary format.
static class	GeophileSpatialFunctionKeyExpression.GeoWKTZ	A serialized JTS geometry in WKT text format.

Nested classes/interfaces inherited from class com.apple.foundationdb.record.metadata.expressions.FunctionKeyExpression

FunctionKeyExpression.BiFunctionBuilder, FunctionKeyExpression.Builder, FunctionKeyExpression.Factory, FunctionKeyExpression.Registry

Nested classes/interfaces inherited from class com.apple.foundationdb.record.metadata.expressions.BaseKeyExpression

BaseKeyExpression.IllegalSubKeyException, BaseKeyExpression.UnsplittableKeyExpressionException

Nested classes/interfaces inherited from interface com.apple.foundationdb.record.metadata.expressions.KeyExpression

KeyExpression.DeserializationException, KeyExpression.FanType, KeyExpression.InvalidExpressionException, KeyExpression.InvalidResultException, KeyExpression.NoSuchArgumentException, KeyExpression.SerializationException

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

PlanHashable.PlanHashKind, PlanHashable.PlanHashMode

Field Summary

Fields

Modifier and Type	Field	Description
static final com.geophile.z.Space	SPACE_LAT_LON

Fields inherited from class com.apple.foundationdb.record.metadata.expressions.FunctionKeyExpression

arguments, name

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

CURRENT_FOR_CONTINUATION, CURRENT_LEGACY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GeophileSpatialFunctionKeyExpression(String name, KeyExpression arguments)

Method Summary

Modifier and Type	Method	Description
boolean	createsDuplicates()
<M extends Message> List<Key.Evaluated>	evaluateFunction(FDBRecord<M> record, Message message, Key.Evaluated arguments)
int	getColumnSize()
com.geophile.z.Space	getSpace()
protected abstract com.geophile.z.SpatialObject	parseSpatialObject(Key.Evaluated arguments)
protected boolean	shouldSwapLatLong(Key.Evaluated arguments)

Methods inherited from class com.apple.foundationdb.record.metadata.expressions.FunctionKeyExpression

basePlanHash, create, equals, equalsAtomic, evaluateMessage, expand, fromProto, getArguments, getChild, getMaxArguments, getMinArguments, getName, groupBy, hashCode, resolveAndEncapsulateFunction, toKeyExpression, toProto, toString, toValue, validate

Methods inherited from class com.apple.foundationdb.record.metadata.expressions.BaseKeyExpression

getSubKey, getSubKeyImpl, isPrefixKey

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.apple.foundationdb.record.metadata.expressions.KeyExpression

evaluate, evaluateMessageSingleton, evaluateSingleton, getSubKey, hasLosslessNormalization, hasProperInterfaces, hasRecordTypeKey, isPrefixKey, needsCopyingToPartialRecord, normalizeKeyForPositions, versionColumns

Methods inherited from interface com.apple.foundationdb.record.metadata.expressions.KeyExpressionWithChild

getChildren

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

planHash, planHash, planHash

Field Details

SPACE_LAT_LON

public static final com.geophile.z.Space SPACE_LAT_LON

Constructor Details

GeophileSpatialFunctionKeyExpression

protected GeophileSpatialFunctionKeyExpression(@Nonnull
 String name,
 @Nonnull
 KeyExpression arguments)

Method Details

getSpace

@Nonnull
public com.geophile.z.Space getSpace()

parseSpatialObject

@Nullable
protected abstract com.geophile.z.SpatialObject parseSpatialObject(@Nonnull
 Key.Evaluated arguments)
                                                            throws org.locationtech.jts.io.ParseException

Throws:

org.locationtech.jts.io.ParseException

evaluateFunction

@Nonnull
public <M extends Message> List<Key.Evaluated> evaluateFunction(@Nullable
 FDBRecord<M> record,
 @Nullable
 Message message,
 @Nonnull
 Key.Evaluated arguments)

Specified by:

evaluateFunction in class FunctionKeyExpression

createsDuplicates

public boolean createsDuplicates()

getColumnSize

public int getColumnSize()

shouldSwapLatLong

protected boolean shouldSwapLatLong(@Nonnull
 Key.Evaluated arguments)