Class JPQLGrammar2_0
java.lang.Object
org.eclipse.persistence.jpa.jpql.parser.AbstractJPQLGrammar
org.eclipse.persistence.jpa.jpql.parser.JPQLGrammar2_0
- All Implemented Interfaces:
JPQLGrammar
This JPQLGrammar
provides support for parsing JPQL queries defined in
JSR-337 - Java Persistence 2.0.
QL_statement ::= select_statement | update_statement | delete_statement
select_statement ::= select_clause from_clause [where_clause] [groupby_clause] [having_clause] [orderby_clause]
update_statement ::= update_clause [where_clause]
delete_statement ::= delete_clause [where_clause]
from_clause ::= FROM identification_variable_declaration {, {identification_variable_declaration | collection_member_declaration}}*
identification_variable_declaration ::= range_variable_declaration { join | fetch_join }*
range_variable_declaration ::= entity_name [AS] identification_variable
join ::= join_spec join_association_path_expression [AS] identification_variable
fetch_join ::= join_spec FETCH join_association_path_expression
join_spec ::= [ LEFT [OUTER] | INNER ] JOIN
join_association_path_expression ::= join_collection_valued_path_expression |
join_single_valued_path_expression
join_collection_valued_path_expression ::= identification_variable.{single_valued_embeddable_object_field.}*collection_valued_field
join_single_valued_path_expression ::= identification_variable.{single_valued_embeddable_object_field.}*single_valued_object_field
collection_member_declaration ::= IN (collection_valued_path_expression) [AS] identification_variable
qualified_identification_variable ::= KEY(identification_variable) |
VALUE(identification_variable) |
ENTRY(identification_variable)
single_valued_path_expression ::= qualified_identification_variable |
state_field_path_expression |
single_valued_object_path_expression
general_identification_variable ::= identification_variable |
KEY(identification_variable) |
VALUE(identification_variable)
state_field_path_expression ::= general_identification_variable.{single_valued_object_field.}*state_field
single_valued_object_path_expression ::= general_identification_variable.{single_valued_object_field.}*single_valued_object_field
collection_valued_path_expression ::= general_identification_variable.{single_valued_object_field.}*collection_valued_field
update_clause ::= UPDATE entity_name [[AS] identification_variable] SET update_item {, update_item}*
update_item ::= [identification_variable.]{state_field | single_valued_object_field} = new_value
new_value ::= scalar_expression |
simple_entity_expression |
NULL
delete_clause ::= DELETE FROM entity_name [[AS] identification_variable]
select_clause ::= SELECT [DISTINCT] select_item {, select_item}*
select_item ::= select_expression [[AS] result_variable]
select_expression ::= single_valued_path_expression |
scalar_expression |
aggregate_expression |
identification_variable |
OBJECT(identification_variable) |
constructor_expression
constructor_expression ::= NEW constructor_name ( constructor_item {, constructor_item}* )
constructor_item ::= single_valued_path_expression |
scalar_expression |
aggregate_expression |
identification_variable
aggregate_expression ::= { AVG | MAX | MIN | SUM } ([DISTINCT] state_field_path_expression) |
COUNT ([DISTINCT] identification_variable |
state_field_path_expression |
single_valued_object_path_expression)
where_clause ::= WHERE conditional_expression
groupby_clause ::= GROUP BY groupby_item {, groupby_item}*
groupby_item ::= single_valued_path_expression | identification_variable
having_clause ::= HAVING conditional_expression
orderby_clause ::= ORDER BY orderby_item {, orderby_item}*
orderby_item ::= state_field_path_expression | result_variable [ ASC | DESC ]
subquery ::= simple_select_clause subquery_from_clause [where_clause] [groupby_clause] [having_clause]
subquery_from_clause ::= FROM subselect_identification_variable_declaration
{, subselect_identification_variable_declaration | collection_member_declaration}*
subselect_identification_variable_declaration ::= identification_variable_declaration |
derived_path_expression [AS] identification_variable {join}* |
derived_collection_member_declaration
derived_path_expression ::= superquery_identification_variable.{single_valued_object_field.}*collection_valued_field |
superquery_identification_variable.{single_valued_object_field.}*single_valued_object_field
derived_collection_member_declaration ::= IN superquery_identification_variable.{single_valued_object_field.}*collection_valued_field
simple_select_clause ::= SELECT [DISTINCT] simple_select_expression
simple_select_expression ::= single_valued_path_expression |
scalar_expression |
aggregate_expression |
identification_variable
scalar_expression ::= simple_arithmetic_expression |
string_primary |
enum_primary |
datetime_primary |
boolean_primary |
case_expression |
entity_type_expression
conditional_expression ::= conditional_term | conditional_expression OR conditional_term
conditional_term ::= conditional_factor | conditional_term AND conditional_factor
conditional_factor ::= [NOT] conditional_primary
conditional_primary ::= simple_cond_expression | (conditional_expression)
simple_cond_expression ::= comparison_expression |
between_expression |
like_expression |
in_expression |
null_comparison_expression |
empty_collection_comparison_expression |
collection_member_expression |
exists_expression
between_expression ::= arithmetic_expression [NOT] BETWEEN arithmetic_expression AND arithmetic_expression |
string_expression [NOT] BETWEEN string_expression AND string_expression |
datetime_expression [NOT] BETWEEN datetime_expression AND datetime_expression
in_expression ::= {state_field_path_expression | type_discriminator} [NOT] IN { ( in_item {, in_item}* ) | (subquery) | collection_valued_input_parameter }
in_item ::= literal | single_valued_input_parameter
like_expression ::= string_expression [NOT] LIKE pattern_value [ESCAPE escape_character]
escape_character ::= single_character_string_literal | character_valued_input_parameter
null_comparison_expression ::= {single_valued_path_expression | input_parameter} IS [NOT] NULL
empty_collection_comparison_expression ::= collection_valued_path_expression IS [NOT] EMPTY
collection_member_expression ::= entity_or_value_expression [NOT] MEMBER [OF] collection_valued_path_expression
entity_or_value_expression ::= single_valued_object_path_expression |
state_field_path_expression |
simple_entity_or_value_expression
simple_entity_or_value_expression ::= identification_variable |
input_parameter |
literal
exists_expression ::= [NOT] EXISTS (subquery)
all_or_any_expression ::= { ALL | ANY | SOME} (subquery)
comparison_expression ::= string_expression comparison_operator {string_expression | all_or_any_expression} |
boolean_expression { = | <> } {boolean_expression | all_or_any_expression} |
enum_expression { = | <> } {enum_expression | all_or_any_expression} |
datetime_expression comparison_operator {datetime_expression | all_or_any_expression} |
entity_expression { = | <> } {entity_expression | all_or_any_expression} |
arithmetic_expression comparison_operator {arithmetic_expression | all_or_any_expression} |
entity_type_expression { = | <> } entity_type_expression}
comparison_operator ::= = | > | >= | < | <= | <>
arithmetic_expression ::= simple_arithmetic_expression | (subquery)
simple_arithmetic_expression ::= arithmetic_term | simple_arithmetic_expression { + | - } arithmetic_term
arithmetic_term ::= arithmetic_factor | arithmetic_term { * | / } arithmetic_factor
arithmetic_factor ::= [{ + | - }] arithmetic_primary
arithmetic_primary ::= state_field_path_expression |
numeric_literal |
(simple_arithmetic_expression) |
input_parameter |
functions_returning_numerics |
aggregate_expression |
case_expression
string_expression ::= string_primary | (subquery)
string_primary ::= state_field_path_expression |
string_literal |
input_parameter |
functions_returning_strings |
aggregate_expression |
case_expression
datetime_primary ::= state_field_path_expression |
input_parameter |
functions_returning_datetime |
aggregate_expression |
case_expression |
date_time_timestamp_literal
datetime_expression ::= datetime_primary | (subquery)
boolean_expression ::= boolean_primary | (subquery)
boolean_primary ::= state_field_path_expression |
boolean_literal |
input_parameter |
case_expression
enum_expression ::= enum_primary | (subquery)
enum_primary ::= state_field_path_expression |
enum_literal |
input_parameter |
case_expression
entity_expression ::= single_valued_object_path_expression | simple_entity_expression
simple_entity_expression ::= identification_variable |
input_parameter
entity_type_expression ::= type_discriminator |
entity_type_literal |
input_parameter
type_discriminator ::= TYPE(identification_variable | single_valued_object_path_expression | input_parameter)
functions_returning_numerics ::= LENGTH(string_primary) |
LOCATE(string_primary, string_primary[, simple_arithmetic_expression]) |
ABS(simple_arithmetic_expression) |
SQRT(simple_arithmetic_expression) |
MOD(simple_arithmetic_expression, simple_arithmetic_expression) |
SIZE(collection_valued_path_expression) |
INDEX(identification_variable)
functions_returning_datetime ::= CURRENT_DATE | CURRENT_TIME | CURRENT_TIMESTAMP | literal_temporal
functions_returning_strings ::= CONCAT(string_primary, string_primary {, string_primary}*) |
SUBSTRING(string_primary, simple_arithmetic_expression [, simple_arithmetic_expression]) |
TRIM([[trim_specification] [trim_character] FROM] string_primary) |
LOWER(string_primary) |
UPPER(string_primary)
trim_specification ::= LEADING | TRAILING | BOTH
trim_character ::= string_literal | input_parameter
case_expression ::= general_case_expression |
simple_case_expression |
coalesce_expression |
nullif_expression
general_case_expression ::= CASE when_clause {when_clause}* ELSE scalar_expression END
when_clause ::= WHEN conditional_expression THEN scalar_expression
simple_case_expression ::= CASE case_operand simple_when_clause {simple_when_clause}* ELSE scalar_expression END
case_operand ::= state_field_path_expression | type_discriminator
simple_when_clause ::= WHEN scalar_expression THEN scalar_expression
coalesce_expression ::= COALESCE(scalar_expression {, scalar_expression}+)
nullif_expression ::= NULLIF(scalar_expression, scalar_expression)
literal ::= boolean_literal |
enum_literal
numeric_literal |
string_literal |
boolean_literal ::= TRUE | FALSE
string_literal ::= '''{identifier}*'''
enum_literal ::= {identifier'.'}+identifier
identifier ::= Character.isJavaIdentifierStart(char){Character.isJavaIdentifierPart(char)}*
literal_temporal ::= date_literal | time_literal | timestamp_literal
input_parameter ::= ':'{identifier}+ | '?'{'1'-'9'}{'0'-'9'}*
date_literal ::= '{' ''d'' (' ' | '\t')+ '\'' date_string '\'' (' ' | '\t')* '}'
time_literal ::= '{' ''t'' (' ' | '\t')+ '\'' trim_string '\'' (' ' | '\t')* '}'
timestamp_literal ::= '{' ('ts') (' ' | '\t')+ '\'' date_string ' ' trim_string '\'' (' ' | '\t')* '}'
date_string ::= [0-9] [0-9] [0-9] [0-9] '-' [0-9] [0-9] '-' [0-9] [0-9]
trim_string ::= [0-9] ([0-9])? ':' [0-9] [0-9] ':' [0-9] [0-9] '.' [0-9]*
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.
- Since:
- 2.4
- Version:
- 2.5.1
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected JPQLGrammar
Creates the baseJPQLGrammar
this one extends, if one exists.static void
extend
(AbstractJPQLGrammar jpqlGrammar) Extends the givenJPQLGrammar
with the information of this one without instantiating the baseJPQLGrammar
.Returns theJPAVersion
of the Java Persistence supported by this grammar.Returns the persistence provider name.Returns the version of the persistence provider.protected void
Registers the JPQL query BNFs defining the JPQL grammar.protected void
Registers theExpressionFactories
required to properly parse JPQL queries.protected void
Registers the JPQL identifiers support by thisJPQLGrammar
.static JPQLGrammar
instance()
Returns the singleton instance of the default implementation ofJPQLGrammar
which provides support for the JPQL grammar defined in the JPA 2.0 functional specification.toString()
Methods inherited from class org.eclipse.persistence.jpa.jpql.parser.AbstractJPQLGrammar
addChildBNF, addChildFactory, addIdentifier, addIdentifiers, buildExpressionRegistry, getBaseGrammar, getExpressionRegistry, initialize, registerBNF, registerFactory, registerIdentifierRole, registerIdentifierVersion, setFallbackBNFId, setFallbackExpressionFactoryId, setHandleCollection, setHandleNestedArray, setHandleSubExpression
-
Constructor Details
-
JPQLGrammar2_0
public JPQLGrammar2_0()Creates a newJPQLExtension2_0
.
-
-
Method Details
-
extend
Extends the givenJPQLGrammar
with the information of this one without instantiating the baseJPQLGrammar
.- Parameters:
jpqlGrammar
- TheJPQLGrammar
to extend with the content of this one without instantiating the baseJPQLGrammar
-
instance
Returns the singleton instance of the default implementation ofJPQLGrammar
which provides support for the JPQL grammar defined in the JPA 2.0 functional specification.- Returns:
- The
JPQLGrammar
that only has support for JPA 2.0
-
buildBaseGrammar
Description copied from class:AbstractJPQLGrammar
Creates the baseJPQLGrammar
this one extends, if one exists.IMPORTANT: The singleton instance of any
JPQLGrammar
(for exampleJPQLGrammar1_0.instance()
cannot be used, the API does not support extending it, a new instance has to be created.- Specified by:
buildBaseGrammar
in classAbstractJPQLGrammar
- Returns:
- The base
JPQLGrammar
ornull
if there is no base grammar
-
getJPAVersion
Description copied from interface:JPQLGrammar
Returns theJPAVersion
of the Java Persistence supported by this grammar.- Returns:
- The
JPA version
supported by this grammar
-
getProvider
Description copied from interface:JPQLGrammar
Returns the persistence provider name.- Returns:
- The name of the persistence provider,
null
should never be returned
-
getProviderVersion
Description copied from interface:JPQLGrammar
Returns the version of the persistence provider.- Returns:
- The version of the persistence provider, if one is extending the default JPQL grammar defined in the Java Persistence specification, otherwise returns an empty string
-
initializeBNFs
protected void initializeBNFs()Description copied from class:AbstractJPQLGrammar
Registers the JPQL query BNFs defining the JPQL grammar.- Specified by:
initializeBNFs
in classAbstractJPQLGrammar
-
initializeExpressionFactories
protected void initializeExpressionFactories()Description copied from class:AbstractJPQLGrammar
Registers theExpressionFactories
required to properly parse JPQL queries. AnExpressionFactory
is responsible to create anExpression
object that represents a portion of the JPQL query.- Specified by:
initializeExpressionFactories
in classAbstractJPQLGrammar
-
initializeIdentifiers
protected void initializeIdentifiers()Description copied from class:AbstractJPQLGrammar
Registers the JPQL identifiers support by thisJPQLGrammar
. The registration involves registering theJPAVersion
and theIdentifierRole
.- Specified by:
initializeIdentifiers
in classAbstractJPQLGrammar
-
toString
-