org.eclipse.persistence.jpa.jpql

Class LiteralVisitor

java.lang.Object

org.eclipse.persistence.jpa.jpql.parser.AnonymousExpressionVisitor

org.eclipse.persistence.jpa.jpql.LiteralVisitor

All Implemented Interfaces:

ExpressionVisitor

Direct Known Subclasses:

DefaultLiteralVisitor, EclipseLinkLiteralVisitor

public abstract class LiteralVisitor
extends AnonymousExpressionVisitor

This visitor traverses an Expression and retrieves the "literal" value. The literal to retrieve depends on the type. The literal is basically a string value like an identification variable name, an input parameter, a path expression, an abstract schema name, etc.

Provisional API: This interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

Version:

2.5

Author:

Pascal Filion

Since:

2.4

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	literal The literal value retrieved from the visited Expression.
protected LiteralType	type The LiteralType helps to determine when traversing an Expression what to retrieve.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LiteralVisitor() Creates a new AbstractLiteralVisitor.

Method Summary

Modifier and Type	Method and Description
LiteralType	getType() Returns the way this visitor retrieves the literal value.
void	setType(LiteralType type) Changes the way this visitor should retrieve the literal value.
void	visit(AbstractSchemaName expression) Visits the AbstractSchemaName expression.
void	visit(CollectionMemberDeclaration expression) Visits the CollectionMemberDeclaration expression.
void	visit(CollectionValuedPathExpression expression) Visits the CollectionValuedPathExpression expression.
void	visit(EntityTypeLiteral expression) Visits the EntityTypeLiteral expression.
void	visit(FunctionExpression expression) Visits the FunctionExpression expression.
void	visit(IdentificationVariable expression) Visits the IdentificationVariable expression.
void	visit(InputParameter expression) Visits the InputParameter expression.
void	visit(Join expression) Visits the Join expression.
void	visit(RangeVariableDeclaration expression) Visits the RangeVariableDeclaration expression.
void	visit(ResultVariable expression) Visits the ResultVariable expression.
void	visit(StateFieldPathExpression expression) Visits the StateFieldPathExpression expression.
void	visit(StringLiteral expression) Visits the StringLiteral expression.
void	visit(TreatExpression expression) Visits the TreatExpression expression.
protected void	visitAbstractPathExpression(AbstractPathExpression expression)

Methods inherited from class org.eclipse.persistence.jpa.jpql.parser.AnonymousExpressionVisitor

visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit

Methods inherited from class java.lang.Object

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

Field Detail

literal

public java.lang.String literal

The literal value retrieved from the visited Expression.

type

protected LiteralType type

The LiteralType helps to determine when traversing an Expression what to retrieve.

Constructor Detail

LiteralVisitor

protected LiteralVisitor()

Creates a new AbstractLiteralVisitor.

Method Detail

getType

public LiteralType getType()

Returns the way this visitor retrieves the literal value.

Returns:

One of the possible LiteralTypes

setType

public void setType(LiteralType type)

Changes the way this visitor should retrieve the literal value.

Parameters:

type - One of the possible LiteralTypes

visit

public void visit(AbstractSchemaName expression)

Visits the AbstractSchemaName expression.

Specified by:

visit in interface ExpressionVisitor

Overrides:

visit in class AnonymousExpressionVisitor

Parameters:

expression - The Expression to visit

visit

public void visit(CollectionMemberDeclaration expression)

Visits the CollectionMemberDeclaration expression.

Specified by:

visit in interface ExpressionVisitor

Overrides:

visit in class AnonymousExpressionVisitor

Parameters:

expression - The Expression to visit

visit

public void visit(CollectionValuedPathExpression expression)

Visits the CollectionValuedPathExpression expression.

Specified by:

visit in interface ExpressionVisitor

Overrides:

visit in class AnonymousExpressionVisitor

Parameters:

expression - The Expression to visit

visit

public void visit(EntityTypeLiteral expression)

Visits the EntityTypeLiteral expression.

Specified by:

visit in interface ExpressionVisitor

Overrides:

visit in class AnonymousExpressionVisitor

Parameters:

expression - The Expression to visit

visit

public void visit(FunctionExpression expression)

Visits the FunctionExpression expression.

Specified by:

visit in interface ExpressionVisitor

Overrides:

visit in class AnonymousExpressionVisitor

Parameters:

expression - The Expression to visit

visit

public void visit(IdentificationVariable expression)

Visits the IdentificationVariable expression.

Specified by:

visit in interface ExpressionVisitor

Overrides:

visit in class AnonymousExpressionVisitor

Parameters:

expression - The Expression to visit

visit

public void visit(InputParameter expression)

Visits the InputParameter expression.

Specified by:

visit in interface ExpressionVisitor

Overrides:

visit in class AnonymousExpressionVisitor

Parameters:

expression - The Expression to visit

visit

public void visit(Join expression)

Visits the Join expression.

Specified by:

visit in interface ExpressionVisitor

Overrides:

visit in class AnonymousExpressionVisitor

Parameters:

expression - The Expression to visit

visit

public void visit(RangeVariableDeclaration expression)

Visits the RangeVariableDeclaration expression.

Specified by:

visit in interface ExpressionVisitor

Overrides:

visit in class AnonymousExpressionVisitor

Parameters:

expression - The Expression to visit

visit

public void visit(ResultVariable expression)

Visits the ResultVariable expression.

Specified by:

visit in interface ExpressionVisitor

Overrides:

visit in class AnonymousExpressionVisitor

Parameters:

expression - The Expression to visit

visit

public void visit(StateFieldPathExpression expression)

Visits the StateFieldPathExpression expression.

Specified by:

visit in interface ExpressionVisitor

Overrides:

visit in class AnonymousExpressionVisitor

Parameters:

expression - The Expression to visit

visit

public void visit(StringLiteral expression)

Visits the StringLiteral expression.

Specified by:

visit in interface ExpressionVisitor

Overrides:

visit in class AnonymousExpressionVisitor

Parameters:

expression - The Expression to visit

visit

public void visit(TreatExpression expression)

Visits the TreatExpression expression.

Specified by:

visit in interface ExpressionVisitor

Overrides:

visit in class AnonymousExpressionVisitor

Parameters:

expression - The Expression to visit

visitAbstractPathExpression

protected void visitAbstractPathExpression(AbstractPathExpression expression)