com.orientechnologies.orient.core.sql.parser

Class OFunctionCall

java.lang.Object

com.orientechnologies.orient.core.sql.parser.SimpleNode

com.orientechnologies.orient.core.sql.parser.OFunctionCall

All Implemented Interfaces:

Node

public class OFunctionCall
extends SimpleNode

Field Summary

Fields

Modifier and Type	Field and Description
protected OIdentifier	name
protected List<OExpression>	params

Fields inherited from class com.orientechnologies.orient.core.sql.parser.SimpleNode

children, firstToken, id, lastToken, parent, parser, value

Constructor Summary

Constructors

Constructor and Description
OFunctionCall(int id)
OFunctionCall(OrientSql p, int id)

Method Summary

Modifier and Type	Method and Description
boolean	allowsIndexedFunctionExecutionOnTarget(OFromClause target, OCommandContext context, OBinaryCompareOperator operator, Object right) tests if current function is an indexed function AND that function can be used on this target
boolean	canExecuteIndexedFunctionWithoutIndex(OFromClause target, OCommandContext context, OBinaryCompareOperator operator, Object right) tests if current function is an indexed function AND that function can also be executed without using the index
OFunctionCall	copy()
void	deserialize(OResult fromResult)
boolean	equals(Object o)
long	estimateIndexedFunction(OFromClause target, OCommandContext ctx, OBinaryCompareOperator operator, Object rightValue)
Object	execute(Object targetObjects, OCommandContext ctx)
Iterable<OIdentifiable>	executeIndexedFunction(OFromClause target, OCommandContext ctx, OBinaryCompareOperator operator, Object rightValue) see OIndexableSQLFunction.searchFromTarget()
boolean	executeIndexedFunctionAfterIndexSearch(OFromClause target, OCommandContext context, OBinaryCompareOperator operator, Object right) tests if current expression is an indexed function AND the function has also to be executed after the index search.
void	extractSubQueries(OIdentifier letAlias, SubQueryCollector collector)
void	extractSubQueries(SubQueryCollector collector)
AggregationContext	getAggregationContext(OCommandContext ctx)
static ODatabaseDocumentInternal	getDatabase()
OIdentifier	getName()
List<OExpression>	getParams()
int	hashCode()
boolean	isAggregate()
boolean	isCacheable()
boolean	isEarlyCalculated(OCommandContext ctx)
boolean	isExpand()
boolean	isIndexedFunctionCall()
boolean	isStar()
boolean	needsAliases(Set<String> aliases)
boolean	refersToParent()
OResult	serialize()
void	setParams(List<OExpression> params)
SimpleNode	splitForAggregation(AggregateProjectionSplit aggregateProj, OCommandContext ctx)
OMethodCall	toMethod()
void	toString(Map<Object,Object> params, StringBuilder builder)

Methods inherited from class com.orientechnologies.orient.core.sql.parser.SimpleNode

childrenAccept, dump, getValue, jjtAccept, jjtAddChild, jjtClose, jjtGetChild, jjtGetFirstToken, jjtGetLastToken, jjtGetNumChildren, jjtGetParent, jjtGetValue, jjtOpen, jjtSetFirstToken, jjtSetLastToken, jjtSetParent, jjtSetValue, toString, toString

Methods inherited from class java.lang.Object

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

Field Detail

name

protected OIdentifier name

params

protected List<OExpression> params

Constructor Detail

OFunctionCall

public OFunctionCall(int id)

OFunctionCall

public OFunctionCall(OrientSql p,
                     int id)

Method Detail

getDatabase

public static ODatabaseDocumentInternal getDatabase()

isStar

public boolean isStar()

getParams

public List<OExpression> getParams()

setParams

public void setParams(List<OExpression> params)

toString

public void toString(Map<Object,Object> params,
                     StringBuilder builder)

Overrides:

toString in class SimpleNode

execute

public Object execute(Object targetObjects,
                      OCommandContext ctx)

isIndexedFunctionCall

public boolean isIndexedFunctionCall()

executeIndexedFunction

public Iterable<OIdentifiable> executeIndexedFunction(OFromClause target,
                                                      OCommandContext ctx,
                                                      OBinaryCompareOperator operator,
                                                      Object rightValue)

see OIndexableSQLFunction.searchFromTarget()

Parameters:

target -

ctx -

operator -

rightValue -

Returns:

estimateIndexedFunction

public long estimateIndexedFunction(OFromClause target,
                                    OCommandContext ctx,
                                    OBinaryCompareOperator operator,
                                    Object rightValue)

Parameters:

target - query target

ctx - execution context

operator - operator at the right of the function

rightValue - value to compare to funciton result

Returns:

the approximate number of items returned by the condition execution, -1 if the extimation cannot be executed

canExecuteIndexedFunctionWithoutIndex

public boolean canExecuteIndexedFunctionWithoutIndex(OFromClause target,
                                                     OCommandContext context,
                                                     OBinaryCompareOperator operator,
                                                     Object right)

tests if current function is an indexed function AND that function can also be executed without using the index

Parameters:

target - the query target

context - the execution context

operator -

right -

Returns:

true if current function is an indexed funciton AND that function can also be executed without using the index, false otherwise

allowsIndexedFunctionExecutionOnTarget

public boolean allowsIndexedFunctionExecutionOnTarget(OFromClause target,
                                                      OCommandContext context,
                                                      OBinaryCompareOperator operator,
                                                      Object right)

tests if current function is an indexed function AND that function can be used on this target

Parameters:

target - the query target

context - the execution context

operator -

right -

Returns:

true if current function is an indexed function AND that function can be used on this target, false otherwise

executeIndexedFunctionAfterIndexSearch

public boolean executeIndexedFunctionAfterIndexSearch(OFromClause target,
                                                      OCommandContext context,
                                                      OBinaryCompareOperator operator,
                                                      Object right)

tests if current expression is an indexed function AND the function has also to be executed after the index search. In some cases, the index search is accurate, so this condition can be excluded from further evaluation. In other cases the result from the index is a superset of the expected result, so the function has to be executed anyway for further filtering

Parameters:

target - the query target

context - the execution context

Returns:

true if current expression is an indexed function AND the function has also to be executed after the index search.

isExpand

public boolean isExpand()

needsAliases

public boolean needsAliases(Set<String> aliases)

isAggregate

public boolean isAggregate()

splitForAggregation

public SimpleNode splitForAggregation(AggregateProjectionSplit aggregateProj,
                                      OCommandContext ctx)

isEarlyCalculated

public boolean isEarlyCalculated(OCommandContext ctx)

getAggregationContext

public AggregationContext getAggregationContext(OCommandContext ctx)

copy

public OFunctionCall copy()

Overrides:

copy in class SimpleNode

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

refersToParent

public boolean refersToParent()

getName

public OIdentifier getName()

toMethod

public OMethodCall toMethod()

serialize

public OResult serialize()

deserialize

public void deserialize(OResult fromResult)

extractSubQueries

public void extractSubQueries(OIdentifier letAlias,
                              SubQueryCollector collector)

extractSubQueries

public void extractSubQueries(SubQueryCollector collector)

isCacheable

public boolean isCacheable()