Top Description Fields Constructors Methods
org.eclipse.persistence.jpa.jpql

public abstract Class LiteralVisitor

extends AnonymousExpressionVisitor
Class Inheritance
Known Direct Subclasses
org.eclipse.persistence.jpa.jpql.tools.DefaultLiteralVisitor, org.eclipse.persistence.jpa.jpql.EclipseLinkLiteralVisitor
Imports
org.eclipse.persistence.jpa.jpql.parser.AbstractPathExpression, .AbstractSchemaName, .AnonymousExpressionVisitor, .CollectionMemberDeclaration, .CollectionValuedPathExpression, .EntityTypeLiteral, .FunctionExpression, .IdentificationVariable, .InputParameter, .Join, .RangeVariableDeclaration, .ResultVariable, .StateFieldPathExpression, .StringLiteral, .TreatExpression
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.

Author
Pascal Filion
Since
2.4
Version
2.5

Field Summary

Modifier and TypeField and Description
public 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

AccessConstructor and Description
protected
LiteralVisitor()

Creates a new AbstractLiteralVisitor.

Method Summary

Modifier and TypeMethod and Description
public LiteralType

Returns:

One of the possible LiteralTypes
getType()

Returns the way this visitor retrieves the literal value.

public void
setType(LiteralType
One of the possible LiteralTypes
type)

Changes the way this visitor should retrieve the literal value.

public void
visit(AbstractSchemaName
The Expression to visit
expression)

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

Implements org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit.

Visits the AbstractSchemaName expression.
public void
visit(CollectionMemberDeclaration
The Expression to visit
expression)

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

Implements org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit.

Visits the CollectionMemberDeclaration expression.
public void
visit(CollectionValuedPathExpression
The Expression to visit
expression)

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

Implements org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit.

Visits the CollectionValuedPathExpression expression.
public void
visit(EntityTypeLiteral
The Expression to visit
expression)

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

Implements org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit.

Visits the EntityTypeLiteral expression.
public void
visit(FunctionExpression
The Expression to visit
expression)

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

Implements org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit.

Visits the FunctionExpression expression.
public void
visit(IdentificationVariable
The Expression to visit
expression)

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

Implements org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit.

Visits the IdentificationVariable expression.
public void
visit(InputParameter
The Expression to visit
expression)

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

Implements org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit.

Visits the InputParameter expression.
public void
visit(Join
The Expression to visit
expression)

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

Implements org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit.

Visits the Join expression.
public void
visit(RangeVariableDeclaration
The Expression to visit
expression)

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

Implements org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit.

Visits the RangeVariableDeclaration expression.
public void
visit(ResultVariable
The Expression to visit
expression)

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

Implements org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit.

Visits the ResultVariable expression.
public void
visit(StateFieldPathExpression
The Expression to visit
expression)

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

Implements org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit.

Visits the StateFieldPathExpression expression.
public void
visit(StringLiteral
The Expression to visit
expression)

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

Implements org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit.

Visits the StringLiteral expression.
public void
visit(TreatExpression
The Expression to visit
expression)

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

Implements org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit.

Visits the TreatExpression expression.
protected void
visitAbstractPathExpression(AbstractPathExpression expression)

Inherited from org.eclipse.persistence.jpa.jpql.parser.AnonymousExpressionVisitor:
visitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisit

Field Detail

literalback to summary
public String literal

The literal value retrieved from the visited Expression.

typeback to summary
protected LiteralType type

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

Constructor Detail

LiteralVisitorback to summary
protected LiteralVisitor()

Creates a new AbstractLiteralVisitor.

Method Detail

getTypeback to summary
public LiteralType getType()

Returns the way this visitor retrieves the literal value.

Returns:LiteralType

One of the possible LiteralTypes

setTypeback to summary
public void setType(LiteralType type)

Changes the way this visitor should retrieve the literal value.

Parameters
type:LiteralType

One of the possible LiteralTypes

visitback to summary
public void visit(AbstractSchemaName expression)

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

Implements org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit.

Doc from org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit.

Visits the AbstractSchemaName expression.

Parameters
expression:AbstractSchemaName

The Expression to visit

Annotations
@Override
visitback to summary
public void visit(CollectionMemberDeclaration expression)

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

Implements org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit.

Doc from org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit.

Visits the CollectionMemberDeclaration expression.

Parameters
expression:CollectionMemberDeclaration

The Expression to visit

Annotations
@Override
visitback to summary
public void visit(CollectionValuedPathExpression expression)

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

Implements org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit.

Doc from org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit.

Visits the CollectionValuedPathExpression expression.

Parameters
expression:CollectionValuedPathExpression

The Expression to visit

Annotations
@Override
visitback to summary
public void visit(EntityTypeLiteral expression)

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

Implements org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit.

Doc from org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit.

Visits the EntityTypeLiteral expression.

Parameters
expression:EntityTypeLiteral

The Expression to visit

Annotations
@Override
visitback to summary
public void visit(FunctionExpression expression)

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

Implements org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit.

Doc from org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit.

Visits the FunctionExpression expression.

Parameters
expression:FunctionExpression

The Expression to visit

Annotations
@Override
visitback to summary
public void visit(IdentificationVariable expression)

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

Implements org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit.

Doc from org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit.

Visits the IdentificationVariable expression.

Parameters
expression:IdentificationVariable

The Expression to visit

Annotations
@Override
visitback to summary
public void visit(InputParameter expression)

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

Implements org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit.

Doc from org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit.

Visits the InputParameter expression.

Parameters
expression:InputParameter

The Expression to visit

Annotations
@Override
visitback to summary
public void visit(Join expression)

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

Implements org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit.

Doc from org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit.

Visits the Join expression.

Parameters
expression:Join

The Expression to visit

Annotations
@Override
visitback to summary
public void visit(RangeVariableDeclaration expression)

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

Implements org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit.

Doc from org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit.

Visits the RangeVariableDeclaration expression.

Parameters
expression:RangeVariableDeclaration

The Expression to visit

Annotations
@Override
visitback to summary
public void visit(ResultVariable expression)

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

Implements org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit.

Doc from org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit.

Visits the ResultVariable expression.

Parameters
expression:ResultVariable

The Expression to visit

Annotations
@Override
visitback to summary
public void visit(StateFieldPathExpression expression)

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

Implements org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit.

Doc from org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit.

Visits the StateFieldPathExpression expression.

Parameters
expression:StateFieldPathExpression

The Expression to visit

Annotations
@Override
visitback to summary
public void visit(StringLiteral expression)

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

Implements org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit.

Doc from org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit.

Visits the StringLiteral expression.

Parameters
expression:StringLiteral

The Expression to visit

Annotations
@Override
visitback to summary
public void visit(TreatExpression expression)

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

Implements org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit.

Doc from org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit.

Visits the TreatExpression expression.

Parameters
expression:TreatExpression

The Expression to visit

Annotations
@Override
visitAbstractPathExpressionback to summary
protected void visitAbstractPathExpression(AbstractPathExpression expression)