Package org.eclipse.persistence.jpa.jpql

This package contains the Hermes features (except the parser itself): semantic and grammatical validations, content assist support, calculating the query result type or the possible type of an input parameter, refactoring tools.

Interface Summary

Interface	Description
AbstractGrammarValidator.AbstractEncapsulatedExpressionHelper<T extends AbstractEncapsulatedExpression>	The root helper that validates any AbstractEncapsulatedExpression.
EclipseLinkSemanticValidatorExtension	This extension provides additional support to semantic validation by adding support for non-JPA specific artifacts, such as database objects.
ITypeHelper
JPQLQueryDeclaration	A JPQLQueryDeclaration represents either an identification variable declaration or a collection member declaration.
JPQLQueryProblem	A problem describes an issue found in a JPQL query because it is either grammatically or semantically incorrect.
JPQLQueryProblemMessages	The list of messages used by JPQLQueryProblems when validating a JPQL query.
SemanticValidatorHelper	This helper is used by AbstractSemanticValidator in order to retrieve JPA information.

Class Summary

Class	Description
AbstractEclipseLinkParameterTypeVisitor	This visitor calculates the type of an input parameter.
AbstractEclipseLinkSemanticValidator	This validator is responsible to gather the problems found in a JPQL query by validating the content to make sure it is semantically valid for EclipseLink.
AbstractEclipseLinkSemanticValidator.EclipseLinkOwningClauseVisitor	This visitor retrieves the clause owning the visited Expression.
AbstractEclipseLinkSemanticValidator.SubquerySelectItemCalculator
AbstractEclipseLinkSemanticValidator.TableExpressionVisitor
AbstractEclipseLinkSemanticValidator.TopLevelFirstDeclarationVisitor
AbstractGrammarValidator	The base validator responsible to gather the problems found in a JPQL query by validating it against the provided JPQL grammar.
AbstractGrammarValidator.AbstractCollectionValidator	This validate is responsible to validate the collection of Expressions: Making sure they are all separated by a comma or by a space (depending on which one is required); Making sure it does not end with a comma; There is no empty expression between two commas.
AbstractGrammarValidator.AbstractDoubleEncapsulatedExpressionHelper<T extends AbstractDoubleEncapsulatedExpression>
AbstractGrammarValidator.AbstractSingleEncapsulatedExpressionHelper<T extends AbstractSingleEncapsulatedExpression>	The abstract implementation of AbstractGrammarValidator.AbstractSingleEncapsulatedExpressionHelper which implements some of the methods since the behavior is the same for all subclasses of AbstractSingleEncapsulatedExpression.
AbstractGrammarValidator.AbstractTripleEncapsulatedExpressionHelper<T extends AbstractTripleEncapsulatedExpression>
AbstractGrammarValidator.CollectionExpressionVisitor	This visitor retrieves the CollectionExpression if it is visited.
AbstractGrammarValidator.CollectionSeparatedByCommaValidator	This validator validates a CollectionExpression by making sure each item is separated by a comma.
AbstractGrammarValidator.CollectionSeparatedBySpaceValidator	This validator validates a CollectionExpression by making sure each item is not separated by a comma.
AbstractGrammarValidator.ComparisonExpressionVisitor
AbstractGrammarValidator.DateTimeVisitor
AbstractGrammarValidator.NullExpressionVisitor	This visitor checks to see if the visited expression is NullExpression.
AbstractSemanticValidator	The base validator responsible to gather the problems found in a JPQL query by validating the content to make sure it is semantically valid, i.e. based on the information contained in the JPA application.
AbstractSemanticValidator.CollectionValuedPathExpressionVisitor	This visitor is meant to retrieve an CollectionValuedPathExpression if the visited Expression is that object.
AbstractSemanticValidator.ComparingEntityTypeLiteralVisitor
AbstractSemanticValidator.ComparisonExpressionVisitor	This visitor compares the left and right expressions of a comparison expression and gathers information about those expressions if they are an identification variable or a path expression.
AbstractSemanticValidator.FirstDeclarationVisitor
AbstractSemanticValidator.InItemsVisitor
AbstractSemanticValidator.StateFieldPathExpressionVisitor	This visitor is meant to retrieve an AbstractSemanticValidator.StateFieldPathExpressionVisitor if the visited Expression is that object.
AbstractSemanticValidator.SubqueryFirstDeclarationVisitor
AbstractSemanticValidator.TopLevelFirstDeclarationVisitor
AbstractValidator	The abstract definition of a validator, which provides helper methods and visitors.
AbstractValidator.BypassChildCollectionExpressionVisitor	This visitor is responsible to traverse the children of a CollectionExpression in order to properly validate the Expression.
AbstractValidator.BypassParentSubExpressionVisitor	This visitor is responsible to traverse the parent hierarchy and to skip SubExpression if it's a parent.
AbstractValidator.ChildrenCollectorVisitor	This visitor gathers the children of a CollectionExpression or a single visited Expression.
AbstractValidator.JPQLQueryBNFValidator	This visitor validates any Expression by checking its BNF against some BNFs.
AbstractValidator.NestedArrayVisitor
AbstractValidator.OwningClauseVisitor	This visitor retrieves the clause owning the visited Expression.
AbstractValidator.OwningStatementVisitor	This visitor retrieves the statement owning the visited Expression.
AbstractValidator.SubqueryVisitor	This visitor retrieves the statement owning the visited Expression.
Assert	An utility class that provides various checks and when the condition fails, then an Assert.AssertException is thrown.
BaseDeclarationIdentificationVariableFinder	This visitor traverses the parsed tree and retrieves the IdentificationVariable defined in the base range variable declaration for the top-level statement if and only if the query is a DELETE or UPDATE query.
EclipseLinkGrammarValidator	This validator adds EclipseLink extension over what the JPA functional specification had defined.
EclipseLinkGrammarValidator.InExpressionVisitor
EclipseLinkGrammarValidator.InExpressionWithNestedArrayVisitor
EclipseLinkLiteralVisitor	This visitor traverses an Expression and retrieves the "literal" value.
ExpressionTools	A utility class containing various methods related to the Hermes parser.
JPQLQueryProblemResourceBundle	The resource bundle containing the problems encountered in a JPQL query.
LiteralVisitor	This visitor traverses an Expression and retrieves the "literal" value.
ParameterTypeVisitor	This visitor calculates the type of an input parameter.
WordParser	This "parser/scanner" holds onto the string version of the JPQL query that is parsed into a parsed tree.

Enum Summary

Enum	Description
AbstractSemanticValidator.PathType	This enumeration allows AbstractSemanticValidator.validateStateFieldPathExpression( StateFieldPathExpression, PathType) to validate the type of the mapping and to make sure it is allowed based on its location.
EclipseLinkVersion	An enumeration listing the various releases of EclipseLink.
JPAVersion	An enumeration listing the various releases of the Java Persistence specification.
JPQLQueryDeclaration.Type	This enum type defines the various types of declarations supported by both the JPA functional specification and EclipseLink.
LiteralType	Some Expression can have a "literal", this enumeration is used to visit an Expression and to retrieve the right value.
WordParser.WordType	This enumeration determines the type of word that was scanned.

Exception Summary

Exception	Description
Assert.AssertException	The exception thrown when the condition is not met.