Module org.datanucleus

Package org.datanucleus.store.query.inmemory

Class InMemoryExpressionEvaluator

java.lang.Object

org.datanucleus.store.query.expression.AbstractExpressionEvaluator

org.datanucleus.store.query.inmemory.InMemoryExpressionEvaluator

All Implemented Interfaces:

ExpressionEvaluator

public class InMemoryExpressionEvaluator
extends AbstractExpressionEvaluator

Class providing evaluation of java "string-based" queries in-memory.

Constructor Summary

Constructors

Constructor	Description
InMemoryExpressionEvaluator(ExecutionContext ec, Map params, Map<String,Object> state, Imports imports, ClassLoaderResolver clr, String candidateAlias, String queryLang)	Constructor for an in-memory evaluator.

Method Summary

Modifier and Type	Method	Description
int	getIntegerForLiteral(Literal lit)	Convenience method to get an int value from the supplied literal.
Map	getParameterValues()
String	getQueryLanguage()
Object	getValueForExpression(Expression expr)
Object	getValueForInvokeExpression(InvokeExpression invokeExpr)	Method to evaluate an InvokeExpression.
Object	getValueForPrimaryExpression(PrimaryExpression primExpr)	Convenience method to get the value for a PrimaryExpression.
Object	getValueForVariableExpression(VariableExpression varExpr)	Convenience method to get the (current) value for a VariableExpression.
Map<String,Object>	getVariableExpressionValues()
protected Object	processAddExpression(Expression expr)	Method to process the supplied ADD expression.
protected Object	processAndExpression(Expression expr)	Method to process the supplied AND expression.
protected Object	processBitAndExpression(Expression expr)	Method to process the supplied BITWISE AND expression.
protected Object	processBitOrExpression(Expression expr)	Method to process the supplied BITWISE OR expression.
protected Object	processBitXorExpression(Expression expr)	Method to process the supplied BITWISE XOR expression.
protected Object	processCaseExpression(CaseExpression expr)	Method to process the supplied case expression.
protected Object	processCastExpression(Expression expr)	Method to process the supplied cast expression.
protected Object	processComExpression(Expression expr)	Method to process the supplied COM expression.
protected Object	processCreatorExpression(CreatorExpression expr)	Method to process the supplied creator expression.
protected Object	processDivExpression(Expression expr)	Method to process the supplied DIV expression.
protected Object	processEqExpression(Expression expr)	Method to process the supplied EQ expression.
protected Object	processGteqExpression(Expression expr)	Method to process the supplied GTEQ expression.
protected Object	processGtExpression(Expression expr)	Method to process the supplied GT expression.
protected Object	processInExpression(Expression expr)	Method to process the supplied IN expression.
protected Object	processInvokeExpression(InvokeExpression expr)	Method to process the supplied invoke expression.
protected Object	processIsExpression(Expression expr)	Method to process the supplied IS (instanceof) expression.
protected Object	processIsnotExpression(Expression expr)	Method to process the supplied ISNOT (!instanceof) expression.
protected Object	processLikeExpression(Expression expr)	Method to process the supplied LIKE expression.
protected Object	processLiteral(Literal expr)	Method to process the supplied invoke expression.
protected Object	processLteqExpression(Expression expr)	Method to process the supplied LTEQ expression.
protected Object	processLtExpression(Expression expr)	Method to process the supplied LT expression.
protected Object	processModExpression(Expression expr)	Method to process the supplied MOD expression.
protected Object	processMulExpression(Expression expr)	Method to process the supplied MUL expression.
protected Object	processNegExpression(Expression expr)	Method to process the supplied NEG expression.
protected Object	processNoteqExpression(Expression expr)	Method to process the supplied NOTEQ expression.
protected Object	processNotExpression(Expression expr)	Method to process the supplied NOT expression.
protected Object	processNotInExpression(Expression expr)	Method to process the supplied NOT IN expression.
protected Object	processOrExpression(Expression expr)	Method to process the supplied OR expression.
protected Object	processParameterExpression(ParameterExpression expr)	Method to process the supplied parameter expression.
protected Object	processPrimaryExpression(PrimaryExpression expr)	Method to process the supplied primary expression.
protected Object	processSubExpression(Expression expr)	Method to process the supplied SUB expression.
protected Object	processVariableExpression(VariableExpression expr)	Method to process the supplied variable expression.
void	removeVariableValue(String id)	Method to remove a variable value.
void	setVariableValue(String id, Object value)	Method to set the value for a variable.

Methods inherited from class org.datanucleus.store.query.expression.AbstractExpressionEvaluator

compileAdditiveMultiplicativeExpression, compileOrAndExpression, compilePrimaryExpression, compileRelationalExpression, compileUnaryExpression, evaluate, processDistinctExpression, processSubqueryExpression

Methods inherited from class java.lang.Object

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

Constructor Detail

InMemoryExpressionEvaluator

public InMemoryExpressionEvaluator(ExecutionContext ec,
                                   Map params,
                                   Map<String,Object> state,
                                   Imports imports,
                                   ClassLoaderResolver clr,
                                   String candidateAlias,
                                   String queryLang)

Constructor for an in-memory evaluator.

Parameters:

ec - ExecutionContext

params - Input parameters

state - Map of state values keyed by their symbolic name

imports - Any imports

clr - ClassLoader resolver

candidateAlias - Alias for the candidate class. With JDOQL this is "this".

queryLang - Query language (JDOQL, JPQL etc)

Method Detail

getParameterValues

public Map getParameterValues()

getQueryLanguage

public String getQueryLanguage()

processAndExpression

protected Object processAndExpression(Expression expr)

Description copied from class: AbstractExpressionEvaluator

Method to process the supplied AND expression. To be implemented by subclasses.

Overrides:

processAndExpression in class AbstractExpressionEvaluator

Parameters:

expr - The expression

Returns:

The result

processOrExpression

protected Object processOrExpression(Expression expr)

Description copied from class: AbstractExpressionEvaluator

Method to process the supplied OR expression. To be implemented by subclasses.

Overrides:

processOrExpression in class AbstractExpressionEvaluator

Parameters:

expr - The expression

Returns:

The result

processBitOrExpression

protected Object processBitOrExpression(Expression expr)

Description copied from class: AbstractExpressionEvaluator

Method to process the supplied BITWISE OR expression. To be implemented by subclasses.

Overrides:

processBitOrExpression in class AbstractExpressionEvaluator

Parameters:

expr - The expression

Returns:

The result

processBitAndExpression

protected Object processBitAndExpression(Expression expr)

Description copied from class: AbstractExpressionEvaluator

Method to process the supplied BITWISE AND expression. To be implemented by subclasses.

Overrides:

processBitAndExpression in class AbstractExpressionEvaluator

Parameters:

expr - The expression

Returns:

The result

processBitXorExpression

protected Object processBitXorExpression(Expression expr)

Description copied from class: AbstractExpressionEvaluator

Method to process the supplied BITWISE XOR expression. To be implemented by subclasses.

Overrides:

processBitXorExpression in class AbstractExpressionEvaluator

Parameters:

expr - The expression

Returns:

The result

processEqExpression

protected Object processEqExpression(Expression expr)

Description copied from class: AbstractExpressionEvaluator

Method to process the supplied EQ expression. To be implemented by subclasses.

Overrides:

processEqExpression in class AbstractExpressionEvaluator

Parameters:

expr - The expression

Returns:

The result

processLikeExpression

protected Object processLikeExpression(Expression expr)

Description copied from class: AbstractExpressionEvaluator

Method to process the supplied LIKE expression. To be implemented by subclasses.

Overrides:

processLikeExpression in class AbstractExpressionEvaluator

Parameters:

expr - The expression

Returns:

The result

processNoteqExpression

protected Object processNoteqExpression(Expression expr)

Description copied from class: AbstractExpressionEvaluator

Method to process the supplied NOTEQ expression. To be implemented by subclasses.

Overrides:

processNoteqExpression in class AbstractExpressionEvaluator

Parameters:

expr - The expression

Returns:

The result

processGteqExpression

protected Object processGteqExpression(Expression expr)

Description copied from class: AbstractExpressionEvaluator

Method to process the supplied GTEQ expression. To be implemented by subclasses.

Overrides:

processGteqExpression in class AbstractExpressionEvaluator

Parameters:

expr - The expression

Returns:

The result

processGtExpression

protected Object processGtExpression(Expression expr)

Description copied from class: AbstractExpressionEvaluator

Method to process the supplied GT expression. To be implemented by subclasses.

Overrides:

processGtExpression in class AbstractExpressionEvaluator

Parameters:

expr - The expression

Returns:

The result

processIsExpression

protected Object processIsExpression(Expression expr)

Description copied from class: AbstractExpressionEvaluator

Method to process the supplied IS (instanceof) expression. To be implemented by subclasses.

Overrides:

processIsExpression in class AbstractExpressionEvaluator

Parameters:

expr - The expression

Returns:

The result

processIsnotExpression

protected Object processIsnotExpression(Expression expr)

Description copied from class: AbstractExpressionEvaluator

Method to process the supplied ISNOT (!instanceof) expression. To be implemented by subclasses.

Overrides:

processIsnotExpression in class AbstractExpressionEvaluator

Parameters:

expr - The expression

Returns:

The result

processCastExpression

protected Object processCastExpression(Expression expr)

Description copied from class: AbstractExpressionEvaluator

Method to process the supplied cast expression. To be implemented by subclasses.

Overrides:

processCastExpression in class AbstractExpressionEvaluator

Parameters:

expr - The expression

Returns:

The result

processLteqExpression

protected Object processLteqExpression(Expression expr)

Description copied from class: AbstractExpressionEvaluator

Method to process the supplied LTEQ expression. To be implemented by subclasses.

Overrides:

processLteqExpression in class AbstractExpressionEvaluator

Parameters:

expr - The expression

Returns:

The result

processLtExpression

protected Object processLtExpression(Expression expr)

Description copied from class: AbstractExpressionEvaluator

Method to process the supplied LT expression. To be implemented by subclasses.

Overrides:

processLtExpression in class AbstractExpressionEvaluator

Parameters:

expr - The expression

Returns:

The result

processAddExpression

protected Object processAddExpression(Expression expr)

Description copied from class: AbstractExpressionEvaluator

Method to process the supplied ADD expression. To be implemented by subclasses.

Overrides:

processAddExpression in class AbstractExpressionEvaluator

Parameters:

expr - The expression

Returns:

The result

processSubExpression

protected Object processSubExpression(Expression expr)

Description copied from class: AbstractExpressionEvaluator

Method to process the supplied SUB expression. To be implemented by subclasses.

Overrides:

processSubExpression in class AbstractExpressionEvaluator

Parameters:

expr - The expression

Returns:

The result

processDivExpression

protected Object processDivExpression(Expression expr)

Description copied from class: AbstractExpressionEvaluator

Method to process the supplied DIV expression. To be implemented by subclasses.

Overrides:

processDivExpression in class AbstractExpressionEvaluator

Parameters:

expr - The expression

Returns:

The result

processModExpression

protected Object processModExpression(Expression expr)

Description copied from class: AbstractExpressionEvaluator

Method to process the supplied MOD expression. To be implemented by subclasses.

Overrides:

processModExpression in class AbstractExpressionEvaluator

Parameters:

expr - The expression

Returns:

The result

processMulExpression

protected Object processMulExpression(Expression expr)

Description copied from class: AbstractExpressionEvaluator

Method to process the supplied MUL expression. To be implemented by subclasses.

Overrides:

processMulExpression in class AbstractExpressionEvaluator

Parameters:

expr - The expression

Returns:

The result

processNegExpression

protected Object processNegExpression(Expression expr)

Description copied from class: AbstractExpressionEvaluator

Method to process the supplied NEG expression. To be implemented by subclasses.

Overrides:

processNegExpression in class AbstractExpressionEvaluator

Parameters:

expr - The expression

Returns:

The result

processComExpression

protected Object processComExpression(Expression expr)

Description copied from class: AbstractExpressionEvaluator

Method to process the supplied COM expression. To be implemented by subclasses.

Overrides:

processComExpression in class AbstractExpressionEvaluator

Parameters:

expr - The expression

Returns:

The result

processNotExpression

protected Object processNotExpression(Expression expr)

Description copied from class: AbstractExpressionEvaluator

Method to process the supplied NOT expression. To be implemented by subclasses.

Overrides:

processNotExpression in class AbstractExpressionEvaluator

Parameters:

expr - The expression

Returns:

The result

processCreatorExpression

protected Object processCreatorExpression(CreatorExpression expr)

Description copied from class: AbstractExpressionEvaluator

Method to process the supplied creator expression. To be implemented by subclasses.

Overrides:

processCreatorExpression in class AbstractExpressionEvaluator

Parameters:

expr - The expression

Returns:

The result

processInvokeExpression

protected Object processInvokeExpression(InvokeExpression expr)

Description copied from class: AbstractExpressionEvaluator

Method to process the supplied invoke expression. To be implemented by subclasses.

Overrides:

processInvokeExpression in class AbstractExpressionEvaluator

Parameters:

expr - The expression

Returns:

The result

processInExpression

protected Object processInExpression(Expression expr)

Description copied from class: AbstractExpressionEvaluator

Method to process the supplied IN expression. To be implemented by subclasses.

Overrides:

processInExpression in class AbstractExpressionEvaluator

Parameters:

expr - The expression

Returns:

The result

processNotInExpression

protected Object processNotInExpression(Expression expr)

Description copied from class: AbstractExpressionEvaluator

Method to process the supplied NOT IN expression. To be implemented by subclasses.

Overrides:

processNotInExpression in class AbstractExpressionEvaluator

Parameters:

expr - The expression

Returns:

The result

processLiteral

protected Object processLiteral(Literal expr)

Description copied from class: AbstractExpressionEvaluator

Method to process the supplied invoke expression. To be implemented by subclasses.

Overrides:

processLiteral in class AbstractExpressionEvaluator

Parameters:

expr - The expression

Returns:

The result

processVariableExpression

protected Object processVariableExpression(VariableExpression expr)

Method to process the supplied variable expression. To be implemented by subclasses.

Overrides:

processVariableExpression in class AbstractExpressionEvaluator

Parameters:

expr - The expression

Returns:

The result

processParameterExpression

protected Object processParameterExpression(ParameterExpression expr)

Description copied from class: AbstractExpressionEvaluator

Method to process the supplied parameter expression. To be implemented by subclasses.

Overrides:

processParameterExpression in class AbstractExpressionEvaluator

Parameters:

expr - The expression

Returns:

The result

processPrimaryExpression

protected Object processPrimaryExpression(PrimaryExpression expr)

Description copied from class: AbstractExpressionEvaluator

Method to process the supplied primary expression. To be implemented by subclasses.

Overrides:

processPrimaryExpression in class AbstractExpressionEvaluator

Parameters:

expr - The expression

Returns:

The result

processCaseExpression

protected Object processCaseExpression(CaseExpression expr)

Description copied from class: AbstractExpressionEvaluator

Method to process the supplied case expression. To be implemented by subclasses.

Overrides:

processCaseExpression in class AbstractExpressionEvaluator

Parameters:

expr - The expression

Returns:

The result

getValueForInvokeExpression

public Object getValueForInvokeExpression(InvokeExpression invokeExpr)

Method to evaluate an InvokeExpression. Will navigate along chained invocations, evaluating the first one, then the second one etc until it gets the value for the passed in expression.

Parameters:

invokeExpr - The InvokeExpression

Returns:

The value

getValueForExpression

public Object getValueForExpression(Expression expr)

getIntegerForLiteral

public int getIntegerForLiteral(Literal lit)

Convenience method to get an int value from the supplied literal. Returns a value if it is convertible into an int.

Parameters:

lit - The literal

Returns:

The int value

Throws:

NucleusException - if impossible to convert into an int

getValueForPrimaryExpression

public Object getValueForPrimaryExpression(PrimaryExpression primExpr)

Convenience method to get the value for a PrimaryExpression.

Parameters:

primExpr - Expression

Returns:

The value in the object for this expression

setVariableValue

public void setVariableValue(String id,
                             Object value)

Method to set the value for a variable.

Parameters:

id - Id of the variable

value - The value to use

removeVariableValue

public void removeVariableValue(String id)

Method to remove a variable value.

Parameters:

id - The id of the variable

getValueForVariableExpression

public Object getValueForVariableExpression(VariableExpression varExpr)

Convenience method to get the (current) value for a VariableExpression. If the variable has no current value, throws a VariableNotSetException.

Parameters:

varExpr - Variable Expression

Returns:

The value

Throws:

VariableNotSetException - Thrown when the variable has no value currently set.

getVariableExpressionValues

public Map<String,Object> getVariableExpressionValues()