Package org.eclipse.persistence.internal.jpa.parsing

Class VariableNode

java.lang.Object

org.eclipse.persistence.internal.jpa.parsing.Node

org.eclipse.persistence.internal.jpa.parsing.VariableNode

All Implemented Interfaces:

AliasableNode

public class VariableNode
extends Node
implements AliasableNode

INTERNAL

Purpose: The node that represents typed variables, local variables, remote variables and TYPE constants

Since:

TopLink 4.0

Author:

Jon Driscoll and Joel Lucuik

Field Summary

Fields inherited from class org.eclipse.persistence.internal.jpa.parsing.Node

alias, left, right, shouldGenerateExpression

Constructor Summary

Constructors

Constructor	Description
VariableNode()	VariableNode constructor comment.
VariableNode(java.lang.String newVariableName)

Method Summary

Modifier and Type	Method	Description
void	applyToQuery(ObjectLevelReadQuery theQuery, GenerationContext generationContext)	INTERNAL Apply this node to the passed query
Expression	generateBaseBuilderExpression(GenerationContext context)
Expression	generateExpression(GenerationContext generationContext)	INTERNAL Generate an expression for the node.
Expression	generateExpressionForAlias(GenerationContext context)
java.lang.String	getAsString()	INTERNAL Get the string representation of this node.
java.lang.String	getCanonicalVariableName()
Node	getNodeForAlias(GenerationContext context)
java.lang.Object	getTypeForMapKey(ParseTreeContext context)
java.lang.String	getVariableName()
boolean	isAlias(GenerationContext context)	isAlias: Answer true if this variable represents an alias in the FROM clause.
boolean	isAlias(ParseTreeContext context)
boolean	isAliasableNode()
boolean	isVariableNode()	INTERNAL Is this node a VariableNode
Node	qualifyAttributeAccess(ParseTreeContext context)	INTERNAL This node represent an unqualified field access in the case the method is called and the variableName is not defined as identification variable.
java.lang.Class	resolveClass(GenerationContext generationContext)	resolveClass: Answer the class which corresponds to my variableName.
void	setVariableName(java.lang.String newVariableName)
java.lang.String	toString(int indent)
void	validate(ParseTreeContext context)	INTERNAL Validate node and calculate its type.

Methods inherited from class org.eclipse.persistence.internal.jpa.parsing.Node

addToExpression, appendExpression, getAlias, getColumn, getLeft, getLine, getRight, getType, hasLeft, hasRight, isAggregateNode, isAttributeNode, isConstructorNode, isCountNode, isDivideNode, isDotNode, isEscape, isLiteralNode, isMapKeyNode, isMinusNode, isMultiplyNode, isNotNode, isParameterNode, isPlusNode, isSubqueryNode, resolveAttribute, resolveClass, resolveMapping, resolveMapping, setAlias, setColumn, setLeft, setLine, setRight, setType, toString, toStringDisplayName, toStringIndent, validateParameter

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.persistence.internal.jpa.parsing.AliasableNode

getAlias, setAlias

Constructor Detail

VariableNode

public VariableNode()

VariableNode constructor comment.

VariableNode

public VariableNode(java.lang.String newVariableName)

Method Detail

getVariableName

public java.lang.String getVariableName()

setVariableName

public void setVariableName(java.lang.String newVariableName)

getCanonicalVariableName

public java.lang.String getCanonicalVariableName()

isVariableNode

public boolean isVariableNode()

INTERNAL Is this node a VariableNode

Overrides:

isVariableNode in class Node

applyToQuery

public void applyToQuery(ObjectLevelReadQuery theQuery,
                         GenerationContext generationContext)

INTERNAL Apply this node to the passed query

Overrides:

applyToQuery in class Node

qualifyAttributeAccess

public Node qualifyAttributeAccess(ParseTreeContext context)

INTERNAL This node represent an unqualified field access in the case the method is called and the variableName is not defined as identification variable. The method returns a DotNode representing a qualified field access with the base variable as left child node. The right child node is an AttributeNode using the variableName as field name.

Overrides:

qualifyAttributeAccess in class Node

validate

public void validate(ParseTreeContext context)

INTERNAL Validate node and calculate its type.

Overrides:

validate in class Node

generateBaseBuilderExpression

public Expression generateBaseBuilderExpression(GenerationContext context)

generateExpression

public Expression generateExpression(GenerationContext generationContext)

Description copied from class: Node

INTERNAL Generate an expression for the node. Each subclass will generate a different expression and thus will need to override this method

Overrides:

generateExpression in class Node

generateExpressionForAlias

public Expression generateExpressionForAlias(GenerationContext context)

getNodeForAlias

public Node getNodeForAlias(GenerationContext context)

isAlias

public boolean isAlias(GenerationContext context)

isAlias: Answer true if this variable represents an alias in the FROM clause. i.e. "FROM Employee emp" declares "emp" as an alias

isAlias

public boolean isAlias(ParseTreeContext context)

resolveClass

public java.lang.Class resolveClass(GenerationContext generationContext)

resolveClass: Answer the class which corresponds to my variableName. This is the class for an alias, where the variableName is registered to an alias.

Overrides:

resolveClass in class Node

toString

public java.lang.String toString(int indent)

Overrides:

toString in class Node

getAsString

public java.lang.String getAsString()

INTERNAL Get the string representation of this node.

Overrides:

getAsString in class Node

getTypeForMapKey

public java.lang.Object getTypeForMapKey(ParseTreeContext context)

isAliasableNode

public boolean isAliasableNode()

Overrides:

isAliasableNode in class Node