Package com.orientechnologies.spatial.functions

Class OSpatialFunctionAbstractIndexable

java.lang.Object

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

com.orientechnologies.spatial.functions.OSpatialFunctionAbstract

com.orientechnologies.spatial.functions.OSpatialFunctionAbstractIndexable

All Implemented Interfaces:

OIndexableSQLFunction, OSQLFunction

Direct Known Subclasses:

OSTContainsFunction, OSTDistanceSphereFunction, OSTDWithinFunction, OSTIntersectsFunction, OSTWithinFunction

public abstract class OSpatialFunctionAbstractIndexable
extends OSpatialFunctionAbstract
implements OIndexableSQLFunction

Created by Enrico Risa on 31/08/15.

Field Summary

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

factory

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

maxParams, minParams, name

Constructor Summary

Constructors

Constructor	Description
OSpatialFunctionAbstractIndexable(String iName, int iMinParams, int iMaxParams)

Method Summary

Modifier and Type	Method	Description
boolean	allowsIndexedExecution(OFromClause target, OBinaryCompareOperator operator, Object rightValue, OCommandContext ctx, OExpression... args)	Checks if this function can be used to fetch data from this target and with these arguments (eg. if the index exists on this target and it's defined on these fields)
boolean	canExecuteInline(OFromClause target, OBinaryCompareOperator operator, Object rightValue, OCommandContext ctx, OExpression... args)	checks if the function can be used even on single records, not as an indexed function (even if the index does not exist at all)
long	estimate(OFromClause target, OBinaryCompareOperator operator, Object rightValue, OCommandContext ctx, OExpression... args)	estimates the number of entries returned by searchFromTarget() with these parameters
<T> boolean	intersect(List<T> list1, List<T> list2)
protected boolean	isValidBinaryOperator(OBinaryCompareOperator operator)
protected void	onAfterParsing(Map<String,Object> params, OExpression[] args, OCommandContext ctx, Object rightValue)
protected abstract String	operator()
protected Iterable<OIdentifiable>	results(OFromClause target, OExpression[] args, OCommandContext ctx, Object rightValue)
protected OLuceneSpatialIndex	searchForIndex(OFromClause target, OExpression[] args, OCommandContext ctx)
boolean	shouldExecuteAfterSearch(OFromClause target, OBinaryCompareOperator operator, Object rightValue, OCommandContext ctx, OExpression... args)	Checks if this function should be called even if the method OIndexableSQLFunction.searchFromTarget(com.orientechnologies.orient.core.sql.parser.OFromClause, com.orientechnologies.orient.core.sql.parser.OBinaryCompareOperator, java.lang.Object, com.orientechnologies.orient.core.command.OCommandContext, com.orientechnologies.orient.core.sql.parser.OExpression...) is executed.

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

toShape

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

aggregateResults, config, filterResult, getDatabase, 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.OIndexableSQLFunction

searchFromTarget

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

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

Constructor Details

OSpatialFunctionAbstractIndexable

public OSpatialFunctionAbstractIndexable(String iName,
 int iMinParams,
 int iMaxParams)

Method Details

searchForIndex

protected OLuceneSpatialIndex searchForIndex(OFromClause target,
 OExpression[] args,
 OCommandContext ctx)

results

protected Iterable<OIdentifiable> results(OFromClause target,
 OExpression[] args,
 OCommandContext ctx,
 Object rightValue)

onAfterParsing

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

operator

protected abstract String operator()

canExecuteInline

public boolean canExecuteInline(OFromClause target,
 OBinaryCompareOperator operator,
 Object rightValue,
 OCommandContext ctx,
 OExpression... args)

Description copied from interface: OIndexableSQLFunction

checks if the function can be used even on single records, not as an indexed function (even if the index does not exist at all)

Specified by:

canExecuteInline in interface OIndexableSQLFunction

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:

true if the function can be calculated without the index. False otherwise

allowsIndexedExecution

public boolean allowsIndexedExecution(OFromClause target,
 OBinaryCompareOperator operator,
 Object rightValue,
 OCommandContext ctx,
 OExpression... args)

Description copied from interface: OIndexableSQLFunction

Checks if this function can be used to fetch data from this target and with these arguments (eg. if the index exists on this target and it's defined on these fields)

Specified by:

allowsIndexedExecution in interface OIndexableSQLFunction

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:

True if the function can be used to fetch from an index. False otherwise

shouldExecuteAfterSearch

public boolean shouldExecuteAfterSearch(OFromClause target,
 OBinaryCompareOperator operator,
 Object rightValue,
 OCommandContext ctx,
 OExpression... args)

Description copied from interface: OIndexableSQLFunction

Checks if this function should be called even if the method OIndexableSQLFunction.searchFromTarget(com.orientechnologies.orient.core.sql.parser.OFromClause, com.orientechnologies.orient.core.sql.parser.OBinaryCompareOperator, java.lang.Object, com.orientechnologies.orient.core.command.OCommandContext, com.orientechnologies.orient.core.sql.parser.OExpression...) is executed.

Specified by:

shouldExecuteAfterSearch in interface OIndexableSQLFunction

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:

True if this function should be called even if the method OIndexableSQLFunction.searchFromTarget(com.orientechnologies.orient.core.sql.parser.OFromClause, com.orientechnologies.orient.core.sql.parser.OBinaryCompareOperator, java.lang.Object, com.orientechnologies.orient.core.command.OCommandContext, com.orientechnologies.orient.core.sql.parser.OExpression...) is executed. False otherwise

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

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

intersect

public <T> boolean intersect(List<T> list1,
 List<T> list2)

isValidBinaryOperator

protected boolean isValidBinaryOperator(OBinaryCompareOperator operator)