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

public abstract Class EncapsulatedIdentificationVariableExpression

extends AbstractSingleEncapsulatedExpression
Class Inheritance
Known Direct Subclasses
org.eclipse.persistence.jpa.jpql.parser.EntryExpression, org.eclipse.persistence.jpa.jpql.parser.IndexExpression, org.eclipse.persistence.jpa.jpql.parser.ObjectExpression, org.eclipse.persistence.jpa.jpql.parser.ValueExpression, org.eclipse.persistence.jpa.jpql.parser.KeyExpression
Imports
org.eclipse.persistence.jpa.jpql.WordParser

This Expression represents an identification variable that maps a Map property, either the key, the value or a Map.Entry).

This is part of JPA 2.0.

BNF: <identifier>(identification_variable)
Author
Pascal Filion
Since
2.3
Version
2.5

Constructor Summary

AccessConstructor and Description
protected
EncapsulatedIdentificationVariableExpression(AbstractExpression
The parent of this expression
parent
,
String
The JPQL identifier that starts this expression
identifier
)

Creates a new MapEntryIdentificationVariableExpression.

Method Summary

Modifier and TypeMethod and Description
public final String
public JPQLQueryBNF
protected AbstractExpression
parse(WordParser
The text to parse based on the current position of the cursor
wordParser
,
String
The unique identifier of the JPQLQueryBNF that is used to determine how to parse the text at the current cursor position within the JPQL query
queryBNFId
,
boolean
Determines whether the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries
tolerant
)

Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.parse.

Parses the given text by using the specified BNF.
Inherited from org.eclipse.persistence.jpa.jpql.parser.AbstractSingleEncapsulatedExpression:
acceptChildrenaddChildrenToaddOrderedEncapsulatedExpressionTofindQueryBNFgetExpressionhasEncapsulatedExpressionhasExpressionparseEncapsulatedExpressionremoveEncapsulatedExpressionsetExpressiontoParsedTextEncapsulatedExpression

Constructor Detail

EncapsulatedIdentificationVariableExpressionback to summary
protected EncapsulatedIdentificationVariableExpression(AbstractExpression parent, String identifier)

Creates a new MapEntryIdentificationVariableExpression.

Parameters
parent:AbstractExpression

The parent of this expression

identifier:String

The JPQL identifier that starts this expression

Method Detail

getEncapsulatedExpressionQueryBNFIdback to summary
public final String getEncapsulatedExpressionQueryBNFId()

Implements abstract org.eclipse.persistence.jpa.jpql.parser.AbstractSingleEncapsulatedExpression.getEncapsulatedExpressionQueryBNFId.

Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractSingleEncapsulatedExpression.getEncapsulatedExpressionQueryBNFId.

Returns the BNF used to parse the encapsulated expression.

Returns:String

The BNF used to parse the encapsulated expression

Annotations
@Override
getQueryBNFback to summary
public JPQLQueryBNF getQueryBNF()

Implements org.eclipse.persistence.jpa.jpql.parser.Expression.getQueryBNF.

Doc from org.eclipse.persistence.jpa.jpql.parser.Expression.getQueryBNF.

Returns the BNF of this Expression.

Returns:JPQLQueryBNF

The JPQLQueryBNF, which represents the grammar of this Expression

Annotations
@Override
parseback to summary
protected AbstractExpression parse(WordParser wordParser, String queryBNFId, boolean tolerant)

Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.parse.

Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.parse.

Parses the given text by using the specified BNF.

Parameters
wordParser:WordParser

The text to parse based on the current position of the cursor

queryBNFId:String

The unique identifier of the JPQLQueryBNF that is used to determine how to parse the text at the current cursor position within the JPQL query

tolerant:boolean

Determines whether the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries

Returns:AbstractExpression

The Expression representing the given sub-query

Annotations
@Override