com.orientechnologies.spatial.functions

Class OSTDistanceSphereFunction

java.lang.Object

com.orientechnologies.orient.core.sql.functions.OSQLFunctionAbstract

com.orientechnologies.spatial.functions.OSpatialFunctionAbstract

com.orientechnologies.spatial.functions.OSpatialFunctionAbstractIndexable

com.orientechnologies.spatial.functions.OSTDistanceSphereFunction

All Implemented Interfaces:

OIndexableSQLFunction, OSQLFunction

public class OSTDistanceSphereFunction
extends OSpatialFunctionAbstractIndexable

Created by Enrico Risa on 25/09/15.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Fields inherited from class com.orientechnologies.orient.core.sql.functions.OSQLFunctionAbstract

maxParams, minParams, name

Constructor Summary

Constructors

Constructor and Description
OSTDistanceSphereFunction()

Method Summary

Modifier and Type	Method and Description
long	estimate(OFromClause target, OBinaryCompareOperator operator, Object rightValue, OCommandContext ctx, OExpression... args) estimates the number of entries returned by searchFromTarget() with these parameters
Object	execute(Object iThis, OIdentifiable iCurrentRecord, Object iCurrentResult, Object[] iParams, OCommandContext iContext) Process a record.
String	getSyntax() Returns a convenient SQL String representation of the function.
protected void	onAfterParsing(Map<String,Object> params, OExpression[] args, OCommandContext ctx, Object rightValue)
protected String	operator()
Iterable<OIdentifiable>	searchFromTarget(OFromClause target, OBinaryCompareOperator operator, Object rightValue, OCommandContext ctx, OExpression... args) returns all the entries belonging to the target that match the binary condition where this function appears

Methods inherited from class com.orientechnologies.spatial.functions.OSpatialFunctionAbstractIndexable

allowsIndexedExecution, canExecuteInline, getDb, intersect, results, searchForIndex, shouldExecuteAfterSearch

Methods inherited from class com.orientechnologies.spatial.functions.OSpatialFunctionAbstract

toShape

Methods inherited from class com.orientechnologies.orient.core.sql.functions.OSQLFunctionAbstract

aggregateResults, config, filterResult, getDistributedStorageId, getMaxParams, getMinParams, getName, getResult, getSingleItem, getSingleProperty, mergeDistributedResult, returnDistributedResult, setResult, shouldMergeDistributedResult, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.orientechnologies.orient.core.sql.functions.OSQLFunction

aggregateResults, config, filterResult, getMaxParams, getMinParams, getName, getResult, mergeDistributedResult, setResult, shouldMergeDistributedResult

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

OSTDistanceSphereFunction

public OSTDistanceSphereFunction()

Method Detail

execute

public Object execute(Object iThis,
                      OIdentifiable iCurrentRecord,
                      Object iCurrentResult,
                      Object[] iParams,
                      OCommandContext iContext)

Description copied from interface: OSQLFunction

Process a record.

iCurrentRecord - : current record

iCurrentResult - TODO

iParams - : function parameters, number is ensured to be within minParams and maxParams.

iContext - : object calling this function

Returns:

function result, can be null. Special cases : can be null if function aggregate results, can be null if function filter results : this mean result is excluded

getSyntax

public String getSyntax()

Description copied from interface: OSQLFunction

Returns a convenient SQL String representation of the function.

Example :

  myFunction( param1, param2, [optionalParam3])
 

This text will be used in exception messages.

Returns:

String , never null.

operator

protected String operator()

Specified by:

operator in class OSpatialFunctionAbstractIndexable

searchFromTarget

public Iterable<OIdentifiable> searchFromTarget(OFromClause target,
                                                OBinaryCompareOperator operator,
                                                Object rightValue,
                                                OCommandContext ctx,
                                                OExpression... args)

Description copied from interface: OIndexableSQLFunction

returns all the entries belonging to the target that match the binary condition where this function appears

Parameters:

target - the query target

operator - the operator after the function, eg. in select from Foo where myFunction(name) > 4 the operator is >

rightValue - the value that has to be compared to the function result, eg. in select from Foo where myFunction(name) > 4 the right value is 4

ctx - the command context for this query

args - the function arguments, eg. in select from Foo where myFunction(name) > 4 the arguments are [name]

Returns:

an iterable of records that match the condition; null means that the execution could not be performed for some reason.

estimate

public long estimate(OFromClause target,
                     OBinaryCompareOperator operator,
                     Object rightValue,
                     OCommandContext ctx,
                     OExpression... args)

Description copied from interface: OIndexableSQLFunction

estimates the number of entries returned by searchFromTarget() with these parameters

Specified by:

estimate in interface OIndexableSQLFunction

Overrides:

estimate in class OSpatialFunctionAbstractIndexable

Parameters:

target - the query target

operator - the operator after the function, eg. in select from Foo where myFunction(name) > 4 the operator is >

rightValue - the value that has to be compared to the function result, eg. in select from Foo where myFunction(name) > 4 the right value is 4

ctx - the command context for this query

args - the function arguments, eg. in select from Foo where myFunction(name) > 4 the arguments are [name]

Returns:

an estimantion of how many entries will be returned by searchFromTarget() with these parameters, -1 if the estimation cannot be done

onAfterParsing

protected void onAfterParsing(Map<String,Object> params,
                              OExpression[] args,
                              OCommandContext ctx,
                              Object rightValue)

Overrides:

onAfterParsing in class OSpatialFunctionAbstractIndexable