Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	HermesParser.DatabaseQueryVisitor This visitor traverses the parsed tree and create the right EclipseLink query and populates it.

Field Summary

Modifier and Type	Field and Description
private String	validationLevel Determines how to validate the JPQL query grammatically.

Constructor Summary

Access	Constructor and Description
public	HermesParser() Creates a new `HermesParser`.

Method Summary

Modifier and Type	Method and Description
private void	addArguments(JPQLQueryContext The `JPQLQueryContext` containing the information about the JPQL query queryContext, DatabaseQuery The EclipseLink `DatabaseQuery` where the input parameter types are added databaseQuery) Registers the input parameters derived from the JPQL expression with the `DatabaseQuery`.
private JPQLException	Returns: The `JPQLException` indicating the problems with the JPQL query buildException(JPQLQueryContext The `JPQLQueryContext` containing the information about the JPQL query queryContext, Collection<JPQLQueryProblem> The `problems` found in the JPQL query that are translated into an exception problems, String The key used to retrieve the localized message messageKey) Creates a `JPQLException` indicating the problems with the JPQL query.
public DatabaseQuery	buildQuery(CharSequence A non-`null` string representation of the query to parse and to convert into a `DatabaseQuery` jpqlQuery, AbstractSession The EclipseLink `AbstractSession` that this query will execute against session) Implements org.eclipse.persistence.queries.JPAQueryBuilder.buildQuery. Creates a fully initialized `DatabaseQuery` by parsing the given JPQL query.
public Expression	buildSelectionCriteria(String The name of the entity for which a criteria is created entityName, String The string representation of a conditional expression to parse selectionCriteria, AbstractSession The EclipseLink `AbstractSession` that this query will execute against session) Implements org.eclipse.persistence.queries.JPAQueryBuilder.buildSelectionCriteria. Creates a new `Expression` that represents the given selection criteria.
private JPQLException	buildUnexpectedException(CharSequence jpqlQuery, Exception exception)
private boolean	Returns: `true` if the query might be incomplete or invalid; `false` if the query is complete and grammatically valid isTolerant() Determines whether the JPQL query should be parsed with tolerance turned on or off, i.e. if validation is turned off, then it's assumed the JPQL query is grammatically valid and complete.
private JPQLGrammar	Returns: The `JPQLGrammar` written for a specific JPA version or for the current version of EclipseLink jpqlGrammar() Returns the `JPQLGrammar` that will help to validate the JPQL query grammatically and semantically (contextually).
public void	populateQuery(CharSequence A non-`null` string representation of the query to parse and to convert into a `DatabaseQuery` jpqlQuery, DatabaseQuery The query to populate with the derived JPQL query query, AbstractSession The EclipseLink `AbstractSession` that this query will execute against session) Implements org.eclipse.persistence.queries.JPAQueryBuilder.populateQuery. Populates the given `DatabaseQuery` by parsing the given JPQL query.
private DatabaseQuery	populateQueryImp(CharSequence jpqlQuery, DatabaseQuery query, AbstractSession session)
private ResourceBundle	resourceBundle()
public void	setValidationLevel(String The validation levels are defined in ParserValidationType validationLevel) Implements org.eclipse.persistence.queries.JPAQueryBuilder.setValidationLevel. Allow the parser validation level to be set.
private void	validate(JPQLQueryContext The context used to query information about the application metadata and cached information queryContext, Expression The `Expression` to validate grammatically and semantically expression) Grammatically and semantically validates the JPQL query.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

validationLevel	back to summary
private String validationLevel Determines how to validate the JPQL query grammatically.

Constructor Detail

HermesParser	back to summary
public HermesParser() Creates a new `HermesParser`.

Method Detail

addArguments back to summary

addArguments	back to summary
private void addArguments(JPQLQueryContext queryContext, DatabaseQuery databaseQuery) Registers the input parameters derived from the JPQL expression with the `DatabaseQuery`. Parameters queryContext:JPQLQueryContext The `JPQLQueryContext` containing the information about the JPQL query databaseQuery:DatabaseQuery The EclipseLink `DatabaseQuery` where the input parameter types are added

private void addArguments(JPQLQueryContext queryContext, DatabaseQuery databaseQuery)

Registers the input parameters derived from the JPQL expression with the DatabaseQuery.

Parameters

queryContext:JPQLQueryContext: The JPQLQueryContext containing the information about the JPQL query
databaseQuery:DatabaseQuery: The EclipseLink DatabaseQuery where the input parameter types are added

buildException back to summary

buildException	back to summary
private JPQLException buildException(JPQLQueryContext queryContext, Collection<JPQLQueryProblem> problems, String messageKey) Creates a `JPQLException` indicating the problems with the JPQL query. Parameters queryContext:JPQLQueryContext The `JPQLQueryContext` containing the information about the JPQL query problems:Collection<JPQLQueryProblem> The `problems` found in the JPQL query that are translated into an exception messageKey:String The key used to retrieve the localized message Returns:JPQLException The `JPQLException` indicating the problems with the JPQL query

private JPQLException buildException(JPQLQueryContext queryContext, Collection<JPQLQueryProblem> problems, String messageKey)

Creates a JPQLException indicating the problems with the JPQL query.

Parameters

queryContext:JPQLQueryContext: The JPQLQueryContext containing the information about the JPQL query
problems:Collection<JPQLQueryProblem>: The problems found in the JPQL query that are translated into an exception
messageKey:String: The key used to retrieve the localized message

Returns:JPQLException

The JPQLException indicating the problems with the JPQL query

buildQuery back to summary

buildQuery	back to summary
public DatabaseQuery buildQuery(CharSequence jpqlQuery, AbstractSession session) Implements org.eclipse.persistence.queries.JPAQueryBuilder.buildQuery. Doc from org.eclipse.persistence.queries.JPAQueryBuilder.buildQuery. Creates a fully initialized `DatabaseQuery` by parsing the given JPQL query. Parameters jpqlQuery:CharSequence A non-`null` string representation of the query to parse and to convert into a `DatabaseQuery` session:AbstractSession The EclipseLink `AbstractSession` that this query will execute against Returns:DatabaseQuery The fully initialized `DatabaseQuery` Annotations @Override

public DatabaseQuery buildQuery(CharSequence jpqlQuery, AbstractSession session)

Implements org.eclipse.persistence.queries.JPAQueryBuilder.buildQuery.

Doc from org.eclipse.persistence.queries.JPAQueryBuilder.buildQuery.

Creates a fully initialized DatabaseQuery by parsing the given JPQL query.

Parameters

jpqlQuery:CharSequence: A non-null string representation of the query to parse and to convert into a DatabaseQuery
session:AbstractSession: The EclipseLink AbstractSession that this query will execute against

Returns:DatabaseQuery

The fully initialized DatabaseQuery

Annotations

@Override

buildSelectionCriteria back to summary

buildSelectionCriteria	back to summary
public Expression buildSelectionCriteria(String entityName, String selectionCriteria, AbstractSession session) Implements org.eclipse.persistence.queries.JPAQueryBuilder.buildSelectionCriteria. Doc from org.eclipse.persistence.queries.JPAQueryBuilder.buildSelectionCriteria. Creates a new `Expression` that represents the given selection criteria. Parameters entityName:String The name of the entity for which a criteria is created selectionCriteria:String The string representation of a conditional expression to parse session:AbstractSession The EclipseLink `AbstractSession` that this query will execute against Returns:Expression The fully initialized `Expression` Annotations @Override

public Expression buildSelectionCriteria(String entityName, String selectionCriteria, AbstractSession session)

Implements org.eclipse.persistence.queries.JPAQueryBuilder.buildSelectionCriteria.

Doc from org.eclipse.persistence.queries.JPAQueryBuilder.buildSelectionCriteria.

Creates a new Expression that represents the given selection criteria.

Parameters

entityName:String: The name of the entity for which a criteria is created
selectionCriteria:String: The string representation of a conditional expression to parse
session:AbstractSession: The EclipseLink AbstractSession that this query will execute against

Returns:Expression

The fully initialized Expression

Annotations

@Override

buildUnexpectedException	back to summary
private JPQLException buildUnexpectedException(CharSequence jpqlQuery, Exception exception)

isTolerant back to summary

isTolerant	back to summary
private boolean isTolerant() Determines whether the JPQL query should be parsed with tolerance turned on or off, i.e. if validation is turned off, then it's assumed the JPQL query is grammatically valid and complete. In this case, it will be parsed with tolerance turned off resulting in better performance. Returns:boolean `true` if the query might be incomplete or invalid; `false` if the query is complete and grammatically valid

private boolean isTolerant()

Determines whether the JPQL query should be parsed with tolerance turned on or off, i.e. if validation is turned off, then it's assumed the JPQL query is grammatically valid and complete. In this case, it will be parsed with tolerance turned off resulting in better performance.

Returns:boolean: true if the query might be incomplete or invalid; false if the query is complete and grammatically valid

jpqlGrammar back to summary

jpqlGrammar	back to summary
private JPQLGrammar jpqlGrammar() Returns the `JPQLGrammar` that will help to validate the JPQL query grammatically and semantically (contextually). It will also checks if any specific feature added to that grammar is allowed. For instance, if the JPQL query has functions defined for EclipseLink grammar but the validation level is set for generic JPA, then an exception will be thrown. Returns:JPQLGrammar The `JPQLGrammar` written for a specific JPA version or for the current version of EclipseLink

private JPQLGrammar jpqlGrammar()

Returns the JPQLGrammar that will help to validate the JPQL query grammatically and semantically (contextually). It will also checks if any specific feature added to that grammar is allowed. For instance, if the JPQL query has functions defined for EclipseLink grammar but the validation level is set for generic JPA, then an exception will be thrown.

Returns:JPQLGrammar: The JPQLGrammar written for a specific JPA version or for the current version of EclipseLink

populateQuery back to summary

populateQuery	back to summary
public void populateQuery(CharSequence jpqlQuery, DatabaseQuery query, AbstractSession session) Implements org.eclipse.persistence.queries.JPAQueryBuilder.populateQuery. Doc from org.eclipse.persistence.queries.JPAQueryBuilder.populateQuery. Populates the given `DatabaseQuery` by parsing the given JPQL query. Parameters jpqlQuery:CharSequence A non-`null` string representation of the query to parse and to convert into a `DatabaseQuery` query:DatabaseQuery The query to populate with the derived JPQL query session:AbstractSession The EclipseLink `AbstractSession` that this query will execute against Annotations @Override

public void populateQuery(CharSequence jpqlQuery, DatabaseQuery query, AbstractSession session)

Implements org.eclipse.persistence.queries.JPAQueryBuilder.populateQuery.

Doc from org.eclipse.persistence.queries.JPAQueryBuilder.populateQuery.

Populates the given DatabaseQuery by parsing the given JPQL query.

Parameters

jpqlQuery:CharSequence: A non-null string representation of the query to parse and to convert into a DatabaseQuery
query:DatabaseQuery: The query to populate with the derived JPQL query
session:AbstractSession: The EclipseLink AbstractSession that this query will execute against

Annotations

@Override

populateQueryImp	back to summary
private DatabaseQuery populateQueryImp(CharSequence jpqlQuery, DatabaseQuery query, AbstractSession session)

resourceBundle	back to summary
private ResourceBundle resourceBundle()

setValidationLevel	back to summary
public void setValidationLevel(String validationLevel) Implements org.eclipse.persistence.queries.JPAQueryBuilder.setValidationLevel. Doc from org.eclipse.persistence.queries.JPAQueryBuilder.setValidationLevel. Allow the parser validation level to be set. Parameters validationLevel:String The validation levels are defined in ParserValidationType Annotations @Override

setValidationLevel

back to summary

public void setValidationLevel(String validationLevel)

Implements org.eclipse.persistence.queries.JPAQueryBuilder.setValidationLevel.

Doc from org.eclipse.persistence.queries.JPAQueryBuilder.setValidationLevel.

Allow the parser validation level to be set.

Parameters

validationLevel:String: The validation levels are defined in ParserValidationType

Annotations

@Override

validate back to summary

validate	back to summary
private void validate(JPQLQueryContext queryContext, Expression expression) Grammatically and semantically validates the JPQL query. If the query is not valid, then an exception will be thrown. Parameters queryContext:JPQLQueryContext The context used to query information about the application metadata and cached information expression:Expression The `Expression` to validate grammatically and semantically

private void validate(JPQLQueryContext queryContext, Expression expression)

Grammatically and semantically validates the JPQL query. If the query is not valid, then an exception will be thrown.

Parameters

queryContext:JPQLQueryContext: The context used to query information about the application metadata and cached information
expression:Expression: The Expression to validate grammatically and semantically

org.eclipse.persistence.internal.jpa.jpql back to summary

private Class HermesParser.DatabaseQueryVisitor

Class Inheritance

extends AbstractExpressionVisitor

java.lang.Object
org.eclipse.persistence.jpa.jpql.parser.AbstractExpressionVisitor
org.eclipse.persistence.internal.jpa.jpql.HermesParser.DatabaseQueryVisitor

This visitor traverses the parsed tree and create the right EclipseLink query and populates it.

Field Summary

Modifier and Type	Field and Description
private final String	jpqlQuery
private final JPQLQueryContext	queryContext

Constructor Summary

Access	Constructor and Description
pack-priv	DatabaseQueryVisitor(JPQLQueryContext queryContext, CharSequence jpqlQuery)

Method Summary

Modifier and Type	Method and Description
private ReadAllQuery	buildReadAllQuery(SelectStatement expression)
private AbstractObjectLevelReadQueryVisitor	buildVisitor(ObjectLevelReadQuery query)
public void	visit(DeleteStatement The `Expression` to visit expression) Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpressionVisitor.visit. Implements org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit. Visits the `DeleteStatement` expression.
public void	visit(JPQLExpression The `Expression` to visit expression) Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpressionVisitor.visit. Implements org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit. Visits the `JPQLExpression` expression.
public void	visit(SelectStatement The `Expression` to visit expression) Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpressionVisitor.visit. Implements org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit. Visits the `SelectStatement` expression.
public void	visit(UpdateStatement The `UpdateStatement` to visit expression) Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpressionVisitor.visit. Implements org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit. Visits the `UpdateStatement` expression.

Field Detail

jpqlQuery	back to summary
private final String jpqlQuery

queryContext	back to summary
private final JPQLQueryContext queryContext

Constructor Detail

DatabaseQueryVisitor	back to summary
pack-priv DatabaseQueryVisitor(JPQLQueryContext queryContext, CharSequence jpqlQuery)

Method Detail

buildReadAllQuery	back to summary
private ReadAllQuery buildReadAllQuery(SelectStatement expression)

buildVisitor	back to summary
private AbstractObjectLevelReadQueryVisitor buildVisitor(ObjectLevelReadQuery query)

visit back to summary

visit	back to summary
public void visit(DeleteStatement expression) Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpressionVisitor.visit. Implements org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit. Doc from org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit. Visits the `DeleteStatement` expression. Parameters expression:DeleteStatement The `Expression` to visit Annotations @Override

public void visit(DeleteStatement expression)

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

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

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

Visits the DeleteStatement expression.

Parameters

expression:DeleteStatement: The Expression to visit

Annotations

@Override

visit back to summary

visit	back to summary
public void visit(JPQLExpression expression) Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpressionVisitor.visit. Implements org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit. Doc from org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit. Visits the `JPQLExpression` expression. Parameters expression:JPQLExpression The `Expression` to visit Annotations @Override

public void visit(JPQLExpression expression)

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

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

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

Visits the JPQLExpression expression.

Parameters

expression:JPQLExpression: The Expression to visit

Annotations

@Override

visit back to summary

visit	back to summary
public void visit(SelectStatement expression) Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpressionVisitor.visit. Implements org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit. Doc from org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit. Visits the `SelectStatement` expression. Parameters expression:SelectStatement The `Expression` to visit Annotations @Override

public void visit(SelectStatement expression)

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

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

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

Visits the SelectStatement expression.

Parameters

expression:SelectStatement: The Expression to visit

Annotations

@Override

visit back to summary

visit	back to summary
public void visit(UpdateStatement expression) Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpressionVisitor.visit. Implements org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit. Doc from org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit. Visits the `UpdateStatement` expression. Parameters expression:UpdateStatement The `UpdateStatement` to visit Annotations @Override

public void visit(UpdateStatement expression)

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

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

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

Visits the UpdateStatement expression.

Parameters