Top Description Interfaces Classes Enums
module org.eclipse.persistence.jpa.jpql

Package org.eclipse.persistence.jpa.jpql.parser


This is the core of Hermes, this package contains the classes that can parse a JPQL query.

Interface Summary

Modifier and TypeInterface and Description
public interface
EclipseLinkExpressionVisitor

The ExpressionVisitor that adds support for the additional JPQL identifiers supported by EclipseLink that is not defined in the JPA function specification.

public interface
Expression

This is the root interface of the parsed tree representation of a JPQL query.

public interface
ExpressionVisitor

This interface is used to traverse the JPQL parsed tree.

public interface
JPQLGrammar

A JPQL grammar defines how a JPQL query can be parsed.

Class Summary

Modifier and TypeClass and Description
public class
AbsExpression

The ABS function removes the minus sign from a specified argument and returns the absolute value, which is always a positive number or zero.

public class
AbsExpressionFactory

This AbsExpressionFactory creates a new AbsExpression when the portion of the query to parse starts with ABS.

public abstract class
AbstractConditionalClause

Conditional expressions are composed of other conditional expressions, comparison operations, logical operations, path expressions that evaluate to boolean values, boolean literals, and boolean input parameters.

public abstract class
AbstractDoubleEncapsulatedExpression

This Expression takes care of parsing an expression that encapsulates two expressions separated by a comma.

public abstract class
public abstract class
AbstractEclipseLinkTraverseChildrenVisitor

This ExpressionVisitor traverses the entire hierarchy of the JPQL parsed tree by going down into each of the children of any given Expression.

public abstract class
public abstract class
AbstractEncapsulatedExpression

This expression handles parsing the identifier followed by an expression encapsulated within parenthesis.

public abstract class
AbstractExpression

This is the abstract definition of all the parts used to create the tree hierarchy representing the parsed JPQL query.

public abstract class
AbstractExpressionVisitor

The abstract definition of ExpressionVisitor, which implements all the methods but does nothing.

public abstract class
AbstractFromClause

The FROM clause of a query defines the domain of the query by declaring identification variables.

public abstract class
AbstractJPQLGrammar

The abstract definition of a JPQLGrammar.

public abstract class
AbstractLiteralExpressionFactory

This factory is responsible to return the right literal expression.

public abstract class
AbstractOrderByClause

An ordering clause allows the objects or values that are returned by the query to be ordered.

public abstract class
AbstractPathExpression

An identification variable followed by the navigation operator (.) and a state field or association field is a path expression.

public class
AbstractSchemaName

An abstract schema name designates the abstract schema type over which the query ranges.

public class
AbstractSchemaNameBNF

The query BNF for an abstract schema name.

public class
public abstract class
AbstractSelectClause

The SELECT clause denotes the query result.

public abstract class
AbstractSelectStatement

A query is an operation that retrieves data from one or more tables or views.

public abstract class
AbstractSingleEncapsulatedExpression

This expression handles parsing a JPQL identifier followed by an expression encapsulated within parenthesis.

public abstract class
AbstractTraverseChildrenVisitor

This ExpressionVisitor traverses the entire hierarchy of the JPQL parsed tree by going down into each of the children of any given Expression.

public abstract class
AbstractTraverseParentVisitor

This ExpressionVisitor traverses up the hierarchy.

public abstract class
AbstractTripleEncapsulatedExpression

This Expression takes care of parsing an expression that encapsulates three expressions separated by a comma.

public class
AdditionExpression

One of the four binary operators.

public class
AggregateExpressionBNF

The query BNF for an aggregate expression.

public abstract class
AggregateFunction

In the SELECT clause the result of a query may be the result of an aggregate function applied to a path expression.

public class
AllOrAnyExpression

An ALL conditional expression is a predicate that is true if the comparison operation is true for all values in the result of the subquery or the result of the subquery is empty.

public class
AllOrAnyExpressionBNF

The query BNF for an all or any expression.

public class
AllOrAnyExpressionFactory

This AllOrAnyExpressionFactory creates a new AllOrAnyExpression when the portion of the query to parse starts with ALL, ANY or SOME.

public class
AndExpression

The AND logical operator chains multiple criteria together.

public class
AndExpressionFactory

This AndExpression creates a new AdditionExpression when the portion of the query to parse starts with AND.

public abstract class
AnonymousExpressionVisitor

This visitor allows a subclass to simply override visit(Expression) and perform the same task for all visited expressions.

public abstract class
ArithmeticExpression

This expression represents an arithmetic expression, which means the first and second expressions are aggregated with an arithmetic sign.

public class
ArithmeticExpressionBNF

The query BNF for an arithmetic expression.

public class
ArithmeticExpressionFactory

This ExpressionFactory creates a new expression when the portion of the query to parse starts with an arithmetic identifier.

public class
ArithmeticFactor

This expression simply adds a plus or minus sign to the arithmetic primary expression.

public class
ArithmeticFactorBNF

The query BNF for an arithmetic factor expression.

public class
ArithmeticPrimaryBNF

The query BNF for an arithmetic primary expression.

public class
ArithmeticTermBNF

The query BNF for an arithmetic term expression.

public class
AsOfClause

An AS OF clause is part of a flashback query, which provides ways to view past states of database objects, or to return database objects to a previous state, without using traditional point-in-time recovery.

public class
AsOfClauseBNF

The query BNF for the AS OF clause.

public class
AsOfClauseFactory

This AsOfClauseFactory creates a new AsOfClause when the portion of the JPQL query to parse starts with AS OF.

public class
AvgFunction

One of the aggregate functions.

public class
AvgFunctionFactory

This AvgFunctionFactory creates a new AvgFunction when the portion of the query to parse starts with AVG.

public class
BadExpression

This wraps another Expression that was correctly parsed by it is located in an invalid location within the JPQL query.

public class
BadExpressionBNF

The query BNF used for an expression that is invalid.

public class
BadExpressionFactory

This BadExpressionFactory creates a new BadExpression when the portion of the query to parse is malformed.

public class
BetweenExpression

Used in conditional expression to determine whether the result of an expression falls within an inclusive range of values.

public class
BetweenExpressionBNF

The query BNF for the between expression.

public class
BetweenExpressionFactory

This BetweenExpressionFactory creates a new BetweenExpression when the portion of the query to parse starts with BETWEEN or NOT BETWEEN.

public class
BooleanExpressionBNF

The query BNF for a boolean expression.

public class
BooleanLiteralBNF

The query BNF for a boolean literal expression.

public class
BooleanPrimaryBNF

The query BNF for a boolean primary expression.

public class
CaseExpression

BNF: general_case_expression ::= CASE when_clause {when_clause}* ELSE scalar_expression END
public class
CaseExpressionBNF

The query BNF for a case expression.

public class
CaseExpressionFactory

This CaseExpressionFactory creates a new CaseExpression when the portion of the query to parse starts with CASE.

public class
CaseOperandBNF

The query BNF for the case operand specified in the case expression.

public class
CastExpression

The CAST function cast value to a different type.

public class
CastExpressionBNF

The query BNF for the CAST function.

public class
CastExpressionFactory

This CastExpressionFactory creates a new CastExpression when the portion of the query to parse starts with CAST.

public class
CoalesceExpression

A COALESCE expression returns null if all its arguments evaluate to null, and the value of the first non-null argument otherwise.

public class
CoalesceExpressionBNF

The query BNF for a coalesce expression.

public class
CoalesceExpressionFactory

This CoalesceExpressionFactory creates a new CoalesceExpression when the portion of the query to parse starts with COALESCE.

public class
CollectionExpression

A CollectionExpression wraps many expression which they are separated by spaces and/or commas.

public class
CollectionMemberDeclaration

An identification variable declared by a collection member declaration ranges over values of a collection obtained by navigation using a path expression.

public class
CollectionMemberDeclarationBNF

The query BNF for a collection member declaration expression.

public class
CollectionMemberDeclarationFactory

This CollectionMemberDeclarationFactory creates a new CollectionMemberDeclaration when the portion of the query to parse starts with IN.

public class
CollectionMemberExpression

This expression tests whether the designated value is a member of the collection specified by the collection-valued path expression.

public class
CollectionMemberExpressionBNF

The query BNF for a collection member expression.

public class
CollectionMemberExpressionFactory

This CollectionMemberExpressionFactory creates a new CollectionMemberExpression when the portion of the query to parse starts with MEMBER, MEMBER OF, NOT MEMBER or NOT MEMBER OF.

public class
CollectionValuedPathExpression

A collection_valued_field is designated by the name of an association field in a one-to-many or a many-to-many relationship or by the name of an element collection field.

public class
CollectionValuedPathExpressionBNF

The query BNF for a collection-valued path expression.

public class
public class
ComparisonExpression

Only the values of like types are permitted to be compared.

public class
ComparisonExpressionBNF

The query BNF for a comparison expression.

public class
ComparisonExpressionFactory

This ComparisonExpressionFactory creates a new ComparisonExpression when the portion of the query to parse starts with <, >, <>, <=, >= or =.

public abstract class
CompoundExpression

A compound expression has a left and right expressions combined by an identifier.

public class
ConcatExpression

The CONCAT function returns a string that is a concatenation of its arguments.

public class
ConcatExpressionFactory

This ConcatExpressionFactory creates a new ConcatExpression when the portion of the query to parse starts with CONCAT.

public class
ConditionalExpressionBNF

The query BNF for a conditional expression.

public class
ConditionalFactorBNF

The query BNF for a conditional factor expression.

public class
ConditionalPrimaryBNF

The query BNF for a conditional primary expression.

public class
ConditionalTermBNF

The query BNF for a conditional term expression.

public class
ConnectByClause

The CONNECT BY clause allows selecting rows in a hierarchical order using the hierarchical query clause.

public class
ConnectByClauseBNF

The query BNF for a CONNECT BY clause.

public class
ConnectByClauseFactory

This ConnectByClauseFactory creates a new ConnectByClause when the portion of the query to parse starts with CONNECT BY.

public class
ConstructorExpression

In the SELECT clause a constructor may be used in the SELECT list to return one or more Java instances.

public class
ConstructorExpressionBNF

The query BNF for a constructor expression.

public class
ConstructorExpressionFactory

This ConstructorExpressionFactory creates a new ConstructorExpression when the portion of the query to parse starts with NEW.

public class
ConstructorItemBNF

The query BNF for a constructor item expression.

public class
CountFunction

One of the aggregate functions.

public class
CountFunctionFactory

This CountFunctionFactory creates a new CountFunction when the portion of the query to parse starts with COUNT.

public class
DatabaseType

This expression represents the database specific data type, which may include size and scale.

public class
public class
DatabaseTypeQueryBNF

The query BNF for the database type.

public class
DateTime

This Expression represents a date or time.

public class
DatetimeExpressionBNF

The query BNF for a date/time expression.

public class
DateTimeFactory

This DateTimeFactory creates a new DateTime when the portion of the query to parse starts with CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP or with the JDBC escape format used for date/time/timestamp.

public class
DateTimePrimaryBNF

The query BNF for a date/time primary expression.

public class
DateTimeTimestampLiteralBNF

The query BNF for a date/time/timestamp expression.

public class
DefaultEclipseLinkJPQLGrammar

This JPQL grammar provides support for parsing JPQL queries defined by the latest Jakarta Persistence functional specification and the latest EclipseLink.

public class
DefaultJPQLGrammar

This JPQL grammar provides support for parsing JPQL queries defined in the latest Jakarta Persistence functional specification.

public class
DefaultStringExpression

An implementation of an Expression that wraps a string.

public class
DeleteClause

This is the delete clause of the delete statement.

public class
DeleteClauseBNF

The query BNF for the delete clause.

public class
DeleteClauseFactory

This DeleteClauseFactory creates a new DeleteClause when the portion of the query to parse starts with DELETE FROM.

public class
DeleteClauseRangeVariableDeclarationBNF

The query BNF for a range variable declaration expression used by the DELETE clause, which accepts collection and aggregate expression, which is used by invalid queries.

public class
DeleteStatement

Bulk delete operation apply to entities of a single entity class (together with its subclasses, if any).

public class
DeleteStatementBNF

The query BNF for the delete statement.

public class
DeleteStatementFactory

This DeleteStatementFactory creates a new DeleteStatement when the portion of the query to parse starts with DELETE FROM.

public class
DerivedCollectionMemberDeclarationBNF

The query BNF for a derived collection member declaration expression.

public class
DivisionExpression

One of the four binary operators.

public abstract class
EclipseLinkAnonymousExpressionVisitor

This visitor allows a subclass to simply override visit(Expression) and perform the same task for all visited expressions including those defined by EclipseLink.

public class
EclipseLinkJPQLGrammar1

This JPQL grammar provides support for parsing JPQL queries defined in JSR-220 - Enterprise JavaBeans 3.0.

public class
EclipseLinkJPQLGrammar2_0

This JPQLGrammar provides support for parsing JPQL queries defined in JSR-337 - Java Persistence 2.0.

public class
EclipseLinkJPQLGrammar2_1

This JPQLGrammar provides support for parsing JPQL queries defined in JSR-337 - Java Persistence 2.0 and the additional support provided by EclipseLink 2.1.

public class
EclipseLinkJPQLGrammar2_2

This JPQLGrammar provides support for parsing JPQL queries defined in JSR-337 - Java Persistence 2.0.

public class
EclipseLinkJPQLGrammar2_3

This JPQLGrammar provides support for parsing JPQL queries defined in JSR-337 - Java Persistence 2.0.

public class
EclipseLinkJPQLGrammar2_4

This JPQLGrammar provides support for parsing JPQL queries defined in JSR-338 - Java Persistence 2.1 and the additional support provided by EclipseLink 2.4.

public class
EclipseLinkJPQLGrammar2_5

This JPQLGrammar provides support for parsing JPQL queries defined in JSR-338 - Java Persistence 2.1 and the additional support provided by EclipseLink 2.5.

public class
EclipseLinkJPQLGrammar2_6

This JPQLGrammar provides support for parsing JPQL queries defined in JSR-338 - Java Persistence 2.1 and the additional support provided by EclipseLink 2.6.

public class
EclipseLinkJPQLGrammar4_0

This JPQLGrammar provides support for parsing JPQL queries defined in Jakarta Persistence 3.1 and the additional support provided by EclipseLink 4.0.

public class
ElseExpressionBNF

The query BNF for a else expression specified in the case expression.

public class
EmptyCollectionComparisonExpression

This expression tests whether or not the collection designated by the collection-valued path expression is empty (i.e, has no elements).

public class
EmptyCollectionComparisonExpressionBNF

The query BNF for an empty collection comparison expression.

public abstract class
EncapsulatedIdentificationVariableExpression

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

public class
EntityExpressionBNF

The query BNF for a entity expression.

public class
EntityOrValueExpressionBNF

The query BNF for a entity or value expression.

public class
EntityTypeExpressionBNF

The query BNF for the TYPE expression.

public class
EntityTypeLiteral

This Expression wraps the name of an entity type.

public class
EntityTypeLiteralBNF

The query BNF for the entity type literal.

public class
EntityTypeLiteralFactory

This factory creates an EntityTypeLiteral, which wraps an entity name.

public class
EntryExpression

An identification variable qualified by the ENTRY operator is a path expression.

public class
EntryExpressionFactory

This EntryExpressionFactory creates a new EntryExpression when the portion of the query to parse starts with ENTRY.

public class
EnumExpressionBNF

The query BNF for a enum expression.

public class
EnumLiteralBNF

The query BNF for an enumeration constant expression.

public class
EnumPrimaryBNF

The query BNF for an enum primary expression.

public class
ExistsExpression

An EXISTS expression is a predicate that is true only if the result of the subquery consists of one or more values and that is false otherwise.

public class
ExistsExpressionBNF

The query BNF for the exists expression.

public class
ExistsExpressionFactory

This ExistsExpressionFactory creates a new ExistsExpression when the portion of the query to parse starts with EXISTS.

public abstract class
ExpressionFactory

An ExpressionFactory is responsible to parse a portion of JPQL query which starts with one of the factory's JPQL identifiers.

public class
ExpressionRegistry

This registry contains the necessary information used by Hermes parser.

public abstract class
ExpressionVisitorWrapper

This ExpressionVisitor wraps another ExpressionVisitor and delegates all its calls to it (the delegate).

public class
ExtractExpression

The EXTRACT function extracts a date part from a date/time value.

public class
ExtractExpressionBNF

The query BNF for the EXTRACT function.

public class
ExtractExpressionFactory

This ExtractExpressionFactory creates a new ExtractExpression when the portion of the query to parse starts with EXTRACT.

public class
FromClause

The FROM clause of a query defines the domain of the query by declaring identification variables.

public class
FromClauseBNF

The query BNF for the from clause.

public class
FromClauseFactory

This FromClauseFactory creates a new FromClause when the portion of the query to parse starts with FROM.

public class
FullyQualifyPathExpressionVisitor

This visitor makes sure that all path expressions are fully qualified with a "virtual" identification variable if the range variable declaration does not define one.

public class
FunctionExpression

This expression adds support to call native database functions.

public class
FunctionExpressionBNF

The query BNF for the EclipseLink's function expression.

public class
FunctionExpressionFactory

This FunctionExpressionFactory creates a new FunctionExpression when the portion of the query to parse starts with an identifier related to a SQL function.

public class
FunctionItemBNF

The query BNF for the parameters of a function expression.

public class
FunctionsReturningDatetimeBNF

The query BNF for a function expression returning a date/time value.

public class
FunctionsReturningNumericsBNF

The query BNF for a function expression returning a numeric value.

public class
FunctionsReturningStringsBNF

The query BNF for a function expression returning a string value.

public class
GeneralCaseExpressionBNF

The query BNF for a general case expression.

public abstract class
GeneralIdentificationExpressionFactory

This ValueExpressionFactory creates a general identification variable, which is either with the identifier KEY or VALUE and then checks the existence of a path expression.

public class
GeneralIdentificationVariableBNF

The query BNF for a general identification variable expression.

public class
GenericQueryBNF

A generic JPQLQueryBNF can be used to manually create a new BNF without having to create a concrete instance.

public class
GroupByClause

The GROUP BY construct enables the aggregation of values according to the properties of an entity class.

public class
GroupByClauseBNF

The query BNF for the group by clause.

public class
GroupByClauseFactory

This GroupByClauseFactory creates a new GroupByClause when the portion of the query to parse starts with GROUP BY.

public class
GroupByItemBNF

The query BNF for a group by item expression.

public class
GroupByItemFactory

This GroupByItemFactory is responsible to return the right expression and to support invalid expression as well.

public class
HavingClause

The HAVING construct enables conditions to be specified that further restrict the query result as restrictions upon the groups.

public class
HavingClauseBNF

The query BNF for the having clause.

public class
HavingClauseFactory

This HavingClauseFactory creates a new HavingClause when the portion of the query to parse starts with HAVING.

public class
HierarchicalQueryClause

If a table contains hierarchical data, then rows can be selected in a hierarchical order using the hierarchical query clause.

public class
public class
HierarchicalQueryClauseFactory

This HierarchicalQueryClauseFactory creates a new HierarchicalQueryClause when the portion of the query to parse starts with either VERSIONS or AS OF.

public class
IdentificationVariable

An identification variable is a valid identifier declared in the FROM clause of a query.

public class
IdentificationVariableBNF

The query BNF for an identification variable expression.

public class
IdentificationVariableDeclaration

An identification variable is a valid identifier declared in the FROM clause of a query.

public class
IdentificationVariableDeclarationBNF

The query BNF for an identification variable declaration expression.

public class
IdentificationVariableDeclarationFactory

This IdentificationVariableDeclarationFactory handles parsing the JPQL fragment within the FROM clause.

public class
public class
IndexExpression

The INDEX function returns an integer value corresponding to the position of its argument in an ordered list.

public class
IndexExpressionFactory

This IndexExpressionFactory creates a new IndexExpression when the portion of the query to parse starts with INDEX.

public class
InExpression

The state field path expression must have a string, numeric, or enum value.

public class
InExpressionBNF

The query BNF for an in expression.

public class
InExpressionExpressionBNF

The query BNF describes the expression being tested by the IN expression.

public class
InExpressionFactory

This InExpressionFactory creates a new InExpression when the portion of the query to parse starts with IN or NOT IN.

public class
InExpressionItemBNF

The query BNF for the items of an IN expression.

public class
InputParameter

Either positional or named parameters may be used.

public class
InputParameterBNF

The query BNF for a input parameter.

public class
InternalAggregateFunctionBNF

The query BNF for the parameter of an aggregate expression.

public class
InternalBetweenExpressionBNF

The query BNF for the lower and upper expressions defined in the between expression.

public class
InternalCoalesceExpressionBNF

The query BNF for the parameters defined in the coalesce expression.

public class
InternalColumnExpressionBNF

The query BNF for the items of a COLUMN expression.

public class
InternalConcatExpressionBNF

The query BNF for the COUNT expression's encapsulated expressions.

public class
public class
InternalCountBNF

The query BNF for the parameter of the COUNT function.

public class
InternalEntityTypeExpressionBNF

The query BNF for the parameters defined in the type expression.

public class
InternalFromClauseBNF

The query BNF for the FROM declaration, basically what follows the FROM identifier.

public class
InternalJoinBNF

The query BNF for what's following the join identifier.

public class
InternalLengthExpressionBNF

The query BNF for the parameter of the LENGTH expression.

public class
InternalLocateStringExpressionBNF

The query BNF for the first two parameters of the LOCATE expression.

public class
InternalLocateThirdExpressionBNF

The query BNF for the third parameter of the LOCATE expression.

public class
InternalLowerExpressionBNF

The query BNF for the parameter of the LOWER expression.

public class
InternalModExpressionBNF

The query BNF for the parameters of the MOD expression.

public class
InternalOrderByClauseBNF

The query BNF for what's following the order by identifier.

public class
InternalOrderByItemBNF

The query BNF for an order by item.

public class
public class
InternalPowerExpressionBNF

The query BNF for the parameters of the POWER expression.

public class
InternalRoundExpressionBNF

The query BNF for the parameters of the ROUND expression.

public class
public class
InternalSimpleFromClauseBNF

The query BNF for the from declaration used in a subquery.

public class
public class
InternalSqrtExpressionBNF

The query BNF for the parameter of the SQRT expression.

public class
InternalSubstringPositionExpressionBNF

The query BNF for the position parameters of the SUBSTRING expression.

public class
InternalSubstringStringExpressionBNF

The query BNF for the parameter of the LENGTH expression.

public class
InternalUpdateClauseBNF

The query BNF for what's following the update identifier.

public class
InternalUpperExpressionBNF

The query BNF for the parameter of the UPPER expression.

public class
InternalWhenClauseBNF

The query BNF for the expression following the WHEN identifier.

public class
IsExpressionFactory

This IsExpressionFactory creates a new expression when the portion of the query to parse starts with IS.

public class
Join

A JOIN enables the fetching of an association as a side effect of the execution of a query.

public class
JoinAssociationPathExpressionBNF

The query BNF for a join association path expression.

public class
JoinBNF

The query BNF for the join expression.

public class
public class
JoinFactory

This JoinFactory creates a new Join when the portion of the query to parse starts with JOIN or FETCH JOIN, respectively.

public class
JoinFetchBNF

The query BNF for the fetch join expression.

public class
JPQLExpression

A JPQLExpression is the root of the parsed tree representation of a JPQL query.

public class
JPQLGrammar1_0

This JPQLGrammar provides support for parsing JPQL queries defined in JSR-220 - Enterprise JavaBeans 3.0.

public class
JPQLGrammar2_0

This JPQLGrammar provides support for parsing JPQL queries defined in JSR-337 - Java Persistence 2.0.

public class
JPQLGrammar2_1

This JPQLGrammar provides support for parsing JPQL queries defined in JSR-338 - Java Persistence 2.1.

public class
JPQLGrammar2_2

This JPQLGrammar provides support for parsing JPQL queries defined in Java Persistence 2.2.

public class
JPQLGrammar3_0

This JPQLGrammar provides support for parsing JPQL queries defined in Jakarta Persistence 3.0.

public class
JPQLGrammar3_1

This JPQLGrammar provides support for parsing JPQL queries defined in Jakarta Persistence 3.1.

public abstract class
JPQLQueryBNF

This defines a single Backus-Naur Form (BNF) of the JPQL grammar.

public class
JPQLStatementBNF

The query BNF for the JPQL expression.

public class
KeyExpression

An identification variable qualified by the KEY operator is a path expression.

public class
KeyExpressionFactory

This KeyExpressionFactory creates a new KeyExpression when the portion of the query to parse starts with KEY.

public class
KeywordExpression

The expression representing some keywords: TRUE, FALSE or NULL.

public class
KeywordExpressionFactory

This KeywordExpressionFactory creates a new KeywordExpression when the portion of the JPQL query to parse is FALSE, TRUE or NULL.

public class
LengthExpression

The LENGTH function returns the length of the string in characters as an integer.

public class
LengthExpressionFactory

This LengthExpressionFactory creates a new LengthExpression when the portion of the query to parse starts with LENGTH.

public class
LikeExpression

The LIKE condition is used to specify a search for a pattern.

public class
LikeExpressionBNF

The query BNF for a expression.

public class
LikeExpressionEscapeCharacterBNF

This BNF is used when parsing an invalid fragment or to extend the default grammar.

public class
LikeExpressionFactory

This LikeExpressionFactory creates a new LikeExpression when the portion of the query to parse starts with LIKE or NOT LIKE.

public class
LiteralBNF

The query BNF for literals, which is based on the listing defined in section 4.6.1 of the Java Specification document for JPA 2.0.

public class
LiteralExpressionFactory

This LiteralExpressionFactory is responsible to return the right literal expression.

public class
LocalDateTime

The DATE | TIME | DATETIME argument of LOCAL local_datetime_type expression.

public class
LocalDateTypeBNF

The query BNF for type part of local date/time expression.

public class
LocalDateTypeFactory

This LocalDateTypeFactory creates a new LocalDateTime when the portion of the query to parse starts with LOCAL.

public class
LocalExpression

The LOCAL local_datetime_type expression.

public class
LocalExpressionBNF

The query BNF for local date/time expression.

public class
LocalExpressionFactory

This LocalExpressionFactory creates a new LocalExpression when the portion of the query to parse starts with LOCAL.

public class
LocateExpression

The LOCATE function returns the position of a given string within a string, starting the search at a specified position.

public class
LocateExpressionFactory

This LocateExpressionFactory creates a new LocateExpression when the portion of the query to parse starts with LOCATE.

public abstract class
LogicalExpression

This expression represents a logical expression, which means the first and second expressions are aggregated with either AND or OR.

public class
LowerExpression

The LOWER function converts a string to lower case and it returns a string.

public class
LowerExpressionFactory

This LowerExpressionFactory creates a new LowerExpression when the portion of the query to parse starts with LOWER.

public abstract class
MathDoubleExpression

Math double argument functions expressions.

public abstract class
MathExpressionFactory

Math functions expressions factories.

public abstract class
MathSingleExpression

Math single argument functions expressions.

public class
MaxFunction

One of the aggregate functions.

public class
MaxFunctionFactory

This MaxFunctionFactory creates a new MaxFunction when the portion of the query to parse starts with MAX.

public class
MinFunction

One of the aggregate functions.

public class
MinFunctionFactory

This MinFunctionFactory creates a new MinFunction when the portion of the query to parse starts with MIN.

public class
ModExpression

The modulo operation finds the remainder of division of one number by another.

public class
ModExpressionFactory

This ModExpressionFactory creates a new ModExpression when the portion of the query to parse starts with MOD.

public class
MultiplicationExpression

One of the four binary operators.

public class
NewValueBNF

The query BNF for a new value expression.

public class
NotExpression

BNF: expression ::= NOT conditional_primary
public class
NotExpressionFactory

This NotExpressionFactory creates a new NotExpression when the portion of the query to parse starts with NOT.

public class
NullComparisonExpression

A null comparison tests whether or not the single-valued path expression or input parameter is a NULL value.

public class
NullComparisonExpressionBNF

The query BNF for a null comparison expression.

public class
NullExpression

A null Expression is used instead of a true null, which allows operations to be performed without doing a null check first.

public class
NullIfExpression

NULLIF returns the first expression if the two expressions are not equal.

public class
NullIfExpressionBNF

The query BNF for a nullif expression.

public class
NullIfExpressionFactory

This NullIfExpressionFactory creates a new NullIfExpression when the portion of the query to parse starts with NULLIF.

public class
NumericLiteral

Exact numeric literals support the use of Java integer literal syntax as well as SQL exact numeric literal syntax.

public class
NumericLiteralBNF

The query BNF for a numeric literal.

public class
ObjectExpression

Stand-alone identification variables in the SELECT clause may optionally be qualified by the OBJECT operator.

public class
ObjectExpressionBNF

The query BNF for an object expression.

public class
ObjectExpressionFactory

This ObjectExpressionFactory creates a new ObjectExpression when the portion of the query to parse starts with OBJECT.

public class
OnClause

Returns an expression that allows a join ON clause to be defined.

public class
OnClauseBNF

The query BNF for the on clause.

public class
OnClauseFactory

This OnClauseFactory creates a new OnClause when the portion of the query to parse starts with ON.

public class
OrderByClause

The ORDER BY clause allows the objects or values that are returned by the query to be ordered.

public class
OrderByClauseBNF

The query BNF for the order by clause.

public class
OrderByClauseFactory

This OrderByClauseFactory creates a new OrderByClause when the portion of the query to parse starts with ORDER BY.

public class
OrderByItem

An orderby_item must be one of the following:

  1. A state_field_path_expression that evaluates to an orderable state field of an entity or embeddable class abstract schema type designated in the SELECT clause by one of the following:
    • A general_identification_variable
    • A single_valued_object_path_expression
public class
OrderByItemBNF

The query BNF for the order by item expression.

public class
public class
OrderSiblingsByClause

In a hierarchical query, if the rows of siblings of the same parent need to be ordered, then the ORDER SIBLINGS BY clause should be used.

public class
OrderSiblingsByClauseBNF

The query BNF for the order siblings by clause.

public class
OrderSiblingsByClauseFactory

This OrderSiblingsByClauseFactory creates a new OrderSiblingsByClause when the portion of the query to parse starts with ORDER SIBLINGS BY.

public class
OrExpression

The OR logical operator chains multiple criteria together.

public class
OrExpressionFactory

This OrExpressionFactory creates a new OrExpression when the portion of the query to parse starts with OR.

public class
PatternValueBNF

The query BNF for a pattern value.

public class
QualifiedIdentificationVariableBNF

The query BNF for a qualified identification variable expression.

public class
QueryPosition

This object contains the cursor position within the parsed tree and within each of the Expression from the root to the deepest leaf.

public class
public class
public class
RangeVariableDeclaration

Range variable declarations allow the developer to designate a "root" for objects which may not be reachable by navigation.

public class
RangeVariableDeclarationBNF

The query BNF for a range variable declaration expression.

public class
public class
RegexpExpression

The REGEXP condition is used to specify a search for a pattern.

public class
RegexpExpressionBNF

The query BNF for a REGEXP expression.

public class
RegexpExpressionFactory

This RegexpExpressionFactory creates a new RegexpExpression when the portion of the query to parse starts with REGEXP.

public class
ResultVariable

A result variable may be used to name a select item in the query result.

public class
ResultVariableBNF

The query BNF for a result variable expression.

public class
ResultVariableFactory

This ResultVariableFactory creates a new ResultVariable when the portion of the query to parse starts with or without AS.

public class
ScalarExpressionBNF

The query BNF for a scalar expression.

public class
SelectClause

The SELECT clause queries data from entities.

public class
SelectClauseBNF

The query BNF for the select clause.

public class
SelectClauseFactory

This SelectClauseFactory creates a new SelectClause when the portion of the query to parse starts with SELECT.

public class
SelectExpressionBNF

The query BNF for a select expression.

public class
SelectStatement

A SELECT query is an operation that retrieves data from one or more tables or views.

public class
SelectStatementBNF

The query BNF for the select statement.

public class
SelectStatementFactory

This SelectStatementFactory creates a new SelectStatement when the portion of the query to parse starts with SELECT.

public class
SimpleArithmeticExpressionBNF

The query BNF for a simple arithmetic expression.

public class
SimpleCaseExpressionBNF

The query BNF for a simple case expression.

public class
SimpleConditionalExpressionBNF

The query BNF for a simple conditional expression.

public class
SimpleEntityExpressionBNF

The query BNF for a simple entity expression.

public class
SimpleEntityOrValueExpressionBNF

The query BNF for a simple entity or value expression.

public class
SimpleFromClause

The FROM clause of a query defines the domain of the query by declaring identification variables.

public class
SimpleResultVariableBNF

The query BNF for a result variable expression.

public class
SimpleSelectClause

The SELECT statement queries data from entities.

public class
SimpleSelectClauseBNF

The query BNF for the simple select clause.

public class
SimpleSelectExpressionBNF

The query BNF for a simple select expression.

public class
SimpleSelectStatement

BNFL subquery ::= simple_select_clause subquery_from_clause [where_clause] [groupby_clause] [having_clause]
public class
SimpleSelectStatementFactory

This SimpleSelectStatementFactory creates a new SimpleSelectStatement when the portion of the query to parse starts with SELECT.

public class
SingleValuedObjectPathExpressionBNF

The query BNF for a simple valued object path expression.

public class
SingleValuedPathExpressionBNF

The query BNF for a single valued path expression.

public class
SizeExpression

The SIZE function returns an integer value, the number of elements of the collection.

public class
SizeExpressionFactory

This SizeExpressionFactory creates a new SizeExpression when the portion of the query to parse starts with SIZE.

public class
SqrtExpression

The SQRT function takes a numeric argument and returns a double.

public class
SqrtExpressionFactory

This SqrtExpressionFactory creates a new SqrtExpression when the portion of the query to parse starts with SQRT.

public class
StartWithClause

A START WITH clause is optional and specifies the root row(s) of the hierarchy.

public class
StartWithClauseBNF

The query BNF for the START WITH clause.

public class
StartWithClauseFactory

This StartWithClauseFactory creates a new StartWithClause when the portion of the query to parse starts with START WITH.

public class
StateFieldPathExpression

A single_valued_association_field is designated by the name of an association-field in a one-to-one or many-to-one relationship.

public class
StateFieldPathExpressionBNF

The query BNF for a state field path expression.

public class
StateFieldPathExpressionFactory

This StateFieldPathExpressionFactory is meant to handle the parsing of a portion of the query when it's expected to be a state field path.

public class
StringExpressionBNF

The query BNF for a string expression.

public class
StringLiteral

A string literal is enclosed in single quotes.

public class
StringLiteralBNF

The query BNF for a string literal.

public class
StringLiteralFactory

This StringLiteralFactory is responsible to parse a sub-query starting with a single quote.

public class
StringPrimaryBNF

The query BNF for a string primary expression.

public class
SubExpression

This expression wraps a sub-expression within parenthesis.

public class
SubqueryBNF

The query BNF for a subquery expression.

public class
SubqueryFromClauseBNF

The query BNF for the from clause defined in a subquery.

public class
SubSelectIdentificationVariableDeclarationBNF

The query BNF for an identification variable declaration expression defined in a sub-select expression.

public class
SubstringExpression

The second and third arguments of the SUBSTRING function denote the starting position and length of the substring to be returned.

public class
SubstringExpressionFactory

This SubstringExpressionFactory creates a new SubstringExpression when the portion of the query to parse starts with SUBSTRING.

public class
SubtractionExpression

One of the four binary operators.

public class
SumFunction

One of the aggregate functions.

public class
SumFunctionFactory

This SumFunctionFactory creates a new SumFunction when the portion of the query to parse starts with SUM.

public class
TableExpression

Defines a table expression.

public class
TableExpressionBNF

The query BNF for a table expression.

public class
public class
TableVariableDeclaration

Defines a table expression.

public class
TableVariableDeclarationBNF

The query BNF for a table declaration.

public class
public class
TreatExpression

Returns an expression that allows to treat its base as if it were a subclass of the class returned by the base.

public class
TreatExpressionBNF

The query BNF for a TREAT expression.

public class
TreatExpressionFactory

This TreatExpressionFactory creates a new TreatExpression when the portion of the query to parse starts with TREAT.

public class
TrimExpression

The TRIM function trims the specified character from a string.

public class
TrimExpressionFactory

This TrimExpressionFactory creates a new TrimExpression when the portion of the query to parse starts with TRIM.

public class
TypeExpression

An entity type expression can be used to restrict query polymorphism.

public class
TypeExpressionBNF

The query BNF for a type expression.

public class
TypeExpressionFactory

This TypeExpressionFactory creates a new TypeExpression when the portion of the query to parse starts with TYPE.

public class
UnionClause

The UNION clause allows the results of two queries to be combined.

public class
UnionClauseBNF

The query BNF for the order by clause.

public class
UnionClauseFactory

This UnionClauseFactory creates a new UnionClause when the portion of the query to parse starts with UNION, INTERSECT or EXCEPT.

public class
UnknownExpression

This expression contains a portion of the query that is unknown to the parser.

public class
UnknownExpressionFactory

This UnknownExpressionFactory creates a new UnknownExpression when the portion of the query to parse is unknown.

public class
UpdateClause

This is the update clause of the update statement.

public class
UpdateClauseBNF

The query BNF for the update clause.

public class
UpdateClauseFactory

This UpdateClauseFactory creates a new UpdateClause when the portion of the query to parse starts with UPDATE.

public class
UpdateItem

The new_value specified for an update operation must be compatible in type with the field to which it is assigned.

public class
UpdateItemBNF

The query BNF for the update item expression.

public class
public class
UpdateItemStateFieldPathExpressionBNF

The query BNF for a state field path expression used in an update item.

public class
UpdateItemStateFieldPathExpressionFactory

This UpdateItemStateFieldPathExpressionFactory is meant to handle the parsing of a portion of the query when it's expected to be a state field path.

public class
UpdateStatement

The UPDATE clause of a query consists of a conditional expression used to select objects or values that satisfy the expression.

public class
UpdateStatementBNF

The query BNF for the update statement.

public class
UpdateStatementFactory

This UpdateStatementFactory creates a new UpdateStatement when the portion of the query to parse starts with UPDATE.

public class
UpperExpression

The UPPER function converts a string to upper case and it returns a string.

public class
UpperExpressionFactory

This UpperExpressionFactory creates a new UpperExpression when the portion of the query to parse starts with UPPER.

public class
ValueExpression

An identification variable qualified by the VALUE operator is a path expression.

public class
ValueExpressionFactory

This ValueExpressionFactory creates a new ValueExpression when the portion of the query to parse starts with VALUE.

public class
VirtualJPQLQueryBNF

This JPQLQueryBNF can be used as a virtual BNF, which can wrap another BNF or BNFs and modify the default behavior.

public class
WhenClause

A WHEN predicate is used to calculate a condition and when it's true, its THEN will be executed.

public class
WhenClauseBNF

The query BNF for the when clause of the case expression.

public class
WhenClauseFactory

This WhenClauseFactory creates a new WhenClause when the portion of the query to parse starts with WHEN.

public class
WhereClause

The WHERE clause of a query consists of a conditional expression used to select objects or values that satisfy the expression.

public class
WhereClauseBNF

The query BNF for the where clause.

public class
WhereClauseFactory

This WhereClauseFactory creates a new WhereClause when the portion of the query to parse starts with WHERE.

Enum Summary

Modifier and TypeEnum and Description
public enum
IdentifierRole

A role describes the purpose of the JPQL identifier.