| Interface | Description |
|---|---|
| Expression |
This is the root interface of the Java Persistence query parsed tree.
|
| ExpressionVisitor |
The interface is used to traverse the JPQL parsed tree.
|
| Class | Description |
|---|---|
| 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.
|
| 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.
|
| AbstractDoubleEncapsulatedExpression |
This
Expression takes care of parsing an expression that encapsulates two expressions
separated by a comma. |
| AbstractEncapsulatedExpression |
This expression handles parsing the identifier followed by an expression encapsulated within
parenthesis.
|
| AbstractExpression |
This is the abstract definition of all the parts used to create the tree hierarchy representing
the parsed JPQL query.
|
| AbstractExpressionVisitor |
The abstract definition of
ExpressionVisitor, which implements all the methods but does
nothing. |
| AbstractFromClause |
The FROM clause of a query defines the domain of the query by declaring identification
variables.
|
| AbstractPathExpression |
An identification variable followed by the navigation operator (.) and a state field or
association field is a path expression.
|
| AbstractSchemaName |
An abstract schema name designates the abstract schema type over which the query ranges.
|
| AbstractSchemaNameBNF |
The query BNF for an abstract schema name.
|
| AbstractSelectClause |
The SELECT clause denotes the query result.
|
| AbstractSelectStatement |
A select statement must always have a SELECT and a FROM clause.
|
| AbstractSingleEncapsulatedExpression |
This expression handles parsing a JPQL identifier followed by an expression encapsulated within
parenthesis.
|
| AbstractTraverseChildrenVisitor |
This
ExpressionVisitor traverses the entire hierarchy of the JPQL
parsed tree by going down into each of the children of any given
Expression. |
| AbstractTraverseParentVisitor |
This
ExpressionVisitor traverses up the hierarchy. |
| AbstractTripleEncapsulatedExpression |
This
Expression takes care of parsing an expression that encapsulates three expressions
separated by a comma. |
| AdditionExpression |
BNF:
arithmetic_expression ::= arithmetic_expression + arithmetic_term |
| AggregateExpressionBNF |
The query BNF for an aggregate expression.
|
| AggregateFunction |
In the SELECT clause the result of a query may be the result of an aggregate function
applied to a path expression.
|
| 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. |
| AllOrAnyExpressionBNF |
The query BNF for an all or any expression.
|
| AndExpression |
BNF:
conditional_term ::= conditional_term AND conditional_factor |
| AnonymousExpressionVisitor |
This visitor allows a subclass to simply override
AnonymousExpressionVisitor.visit(Expression) and perform the
same task for all visited expressions. |
| ArithmeticExpression |
This expression represents an arithmetic expression, which means the first and second expressions
are aggregated with an arithmetic sign.
|
| ArithmeticExpressionBNF |
The query BNF for an arithmetic expression.
|
| ArithmeticFactor |
This expression simply adds a plus or minus sign to the arithmetic primary expression.
|
| ArithmeticFactorBNF |
The query BNF for an arithmetic factor expression.
|
| ArithmeticPrimaryBNF |
The query BNF for an arithmetic primary expression.
|
| ArithmeticTermBNF |
The query BNF for an arithmetic term expression.
|
| AvgFunction |
One of the aggregate functions.
|
| BadExpression | |
| BadExpressionBNF |
The query BNF used for an expression that is invalid.
|
| BetweenExpression |
Used in conditional expression to determine whether the result of an expression falls within an
inclusive range of values.
|
| BetweenExpressionBNF |
The query BNF for the between expression.
|
| BooleanExpressionBNF |
The query BNF for a boolean expression.
|
| BooleanLiteralBNF |
The query BNF for a boolean literal expression.
|
| BooleanPrimaryBNF |
The query BNF for a boolean primary expression.
|
| CaseExpression |
BNF: general_case_expression ::= CASE when_clause {when_clause}* ELSE scalar_expression END
or
BNF:
simple_case_expression ::= CASE case_operand simple_when_clause {simple_when_clause}* ELSE scalar_expression END |
| CaseExpressionBNF |
The query BNF for a case expression.
|
| CaseOperandBNF |
The query BNF for the case operand specified in the case expression.
|
| CoalesceExpression |
A COALESCE expression returns
null if all its arguments evaluate to
null, and the value of the first non-null argument otherwise. |
| CoalesceExpressionBNF |
The query BNF for a coalesce expression.
|
| CollectionExpression |
A
CollectionExpression wraps many expression which they are separated by spaces
and/or commas. |
| CollectionMemberDeclaration |
An identification variable declared by a collection member declaration ranges over values of a
collection obtained by navigation using a path expression.
|
| CollectionMemberDeclarationBNF |
The query BNF for a collection member declaration expression.
|
| CollectionMemberExpression |
This expression tests whether the designated value is a member of the collection specified by the
collection-valued path expression.
|
| CollectionMemberExpressionBNF |
The query BNF for a collection member expression.
|
| 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. |
| CollectionValuedPathExpressionBNF |
The query BNF for a collection-valued path expression.
|
| ComparisonExpression |
Only the values of like types are permitted to be compared.
|
| ComparisonExpressionBNF |
The query BNF for a comparison expression.
|
| CompoundExpression |
A compound expression has a left and right expressions combined by an identifier.
|
| ConcatExpression |
The CONCAT function returns a string that is a concatenation of its arguments.
|
| ConditionalExpressionBNF |
The query BNF for a conditional expression.
|
| ConditionalFactorBNF |
The query BNF for a conditional factor expression.
|
| ConditionalPrimaryBNF |
The query BNF for a conditional primary expression.
|
| ConditionalTermBNF |
The query BNF for a conditional term expression.
|
| ConstructorExpression |
In the SELECT clause a constructor may be used in the SELECT list to return one or
more Java instances.
|
| ConstructorExpressionBNF |
The query BNF for a constructor expression.
|
| ConstructorItemBNF |
The query BNF for a constructor item expression.
|
| CountFunction |
One of the aggregate functions.
|
| DateTime |
This
Expression represents a date or time. |
| DatetimeExpressionBNF |
The query BNF for a date/time expression.
|
| DateTimePrimaryBNF |
The query BNF for a date/time primary expression.
|
| DateTimeTimestampLiteralBNF |
The query BNF for a date/time/timestamp expression.
|
| DeleteClause |
This is the delete clause of the delete statement.
|
| DeleteClauseBNF |
The query BNF for the delete clause.
|
| 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.
|
| DeleteStatement |
Bulk delete operation apply to entities of a single entity class (together with its subclasses,
if any).
|
| DeleteStatementBNF |
The query BNF for the delete statement.
|
| DerivedCollectionMemberDeclarationBNF |
The query BNF for a derived collection member declaration expression.
|
| DivisionExpression |
BNF:
arithmetic_expression ::= arithmetic_expression / arithmetic_term |
| ElseExpressionBNF |
The query BNF for a else expression specified in the case expression.
|
| EmptyCollectionComparisonExpression |
This expression tests whether or not the collection designated by the collection-valued path
expression is empty (i.e, has no elements).
|
| EmptyCollectionComparisonExpressionBNF |
The query BNF for an empty collection comparison expression.
|
| EncapsulatedIdentificationVariableExpression |
This
Expression represents an identification variable that maps a Map
property, either the key, the value or a Map.Entry). |
| EntityExpressionBNF |
The query BNF for a entity expression.
|
| EntityOrValueExpressionBNF |
The query BNF for a entity or value expression.
|
| EntityTypeExpressionBNF |
The query BNF for the TYPE expression.
|
| EntityTypeLiteral |
This
Expression wraps the name of an entity type. |
| EntityTypeLiteralBNF |
The query BNF for the entity type literal.
|
| EntryExpression |
This is part of JPA 2.0.
|
| EnumExpressionBNF |
The query BNF for a enum expression.
|
| EnumLiteralBNF |
The query BNF for an enumeration constant expression.
|
| EnumPrimaryBNF |
The query BNF for an enum primary expression.
|
| 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. |
| ExistsExpressionBNF |
The query BNF for the exists expression.
|
| ExpressionVisitorWrapper |
This
ExpressionVisitor wraps another ExpressionVisitor and delegates all its
calls to it (the delegate). |
| FromClause |
The FROM clause of a query defines the domain of the query by declaring identification
variables.
|
| FromClauseBNF |
The query BNF for the from clause.
|
| FuncExpression |
This expression adds support to call native database functions.
|
| FuncExpressionBNF |
The query BNF for the EclipseLink's func expression.
|
| FuncItemBNF |
The query BNF for the parameters of a func expression.
|
| FunctionsReturningDatetimeBNF |
The query BNF for a function expression returning a date/time value.
|
| FunctionsReturningNumericsBNF |
The query BNF for a function expression returning a numeric value.
|
| FunctionsReturningStringsBNF |
The query BNF for a function expression returning a string value.
|
| GeneralCaseExpressionBNF |
The query BNF for a general case expression.
|
| GeneralIdentificationVariableBNF |
The query BNF for a general identification variable expression.
|
| GroupByClause |
The GROUP BY construct enables the aggregation of values according to the properties of an
entity class.
|
| GroupByClauseBNF |
The query BNF for the group by clause.
|
| GroupByItemBNF |
The query BNF for a group by item expression.
|
| HavingClause |
The HAVING construct enables conditions to be specified that further
restrict the query result as restrictions upon the groups.
|
| HavingClauseBNF |
The query BNF for the having clause.
|
| IdentificationVariable |
An identification variable is a valid identifier declared in the FROM clause of a query.
|
| IdentificationVariableBNF |
The query BNF for an identification variable expression.
|
| IdentificationVariableDeclaration |
An identification variable is a valid identifier declared in the FROM clause of a query.
|
| IdentificationVariableDeclarationBNF |
The query BNF for an identification variable declaration expression.
|
| IndexExpression |
The INDEX function returns an integer value corresponding to the position of its argument
in an ordered list.
|
| InExpression |
The
state_field_path_expression must have a string, numeric, or enum value. |
| InExpressionBNF |
The query BNF for an in expression.
|
| InExpressionExpressionBNF | |
| InItemBNF |
The query BNF for the items of an IN expression.
|
| InputParameter |
Either positional or named parameters may be used.
|
| InputParameterBNF |
The query BNF for a input parameter.
|
| InternalBetweenExpressionBNF |
The query BNF for the lower and upper expressions defined in the between
expression.
|
| InternalCoalesceExpressionBNF |
The query BNF for the parameters defined in the coalesce expression.
|
| InternalConcatExpressionBNF |
The query BNF for the COUNT expression's encapsulated expressions.
|
| InternalCountBNF |
The query BNF for the parameter of the COUNT function.
|
| InternalEntityTypeExpressionBNF |
The query BNF for the parameters defined in the type expression.
|
| InternalFromClauseBNF |
The query BNF for the from declaration.
|
| InternalJoinBNF |
The query BNF for what's following the join identifier.
|
| InternalOrderByClauseBNF |
The query BNF for what's following the order by identifier.
|
| InternalOrderByItemBNF |
The query BNF for an order by item.
|
| InternalSimpleFromClauseBNF |
The query BNF for the from declaration used in a subquery.
|
| InternalUpdateClauseBNF |
The query BNF for what's following the update identifier.
|
| InternalWhenClauseBNF |
The query BNF for the expression following the WHEN identifier.
|
| Join |
A JOIN enables the fetching of an association as a side effect of the execution of a query.
|
| JoinAssociationPathExpressionBNF |
The query BNF for a join association path expression.
|
| JoinBNF |
The query BNF for the join expression.
|
| JoinFetch |
A JOIN FETCH enables the fetching of an association as a side effect of the execution of
a query.
|
| JoinFetchBNF |
The query BNF for the fetch join expression.
|
| JPQLExpression |
A JPQL expression is the parsed tree representation of a Java Persistence query.
|
| JPQLQueryBNF |
This defines the Backus-Naur Form (BNF) of the
JSR 317: Java™ Persistence 2.0.
|
| JPQLStatementBNF |
The query BNF for the JPQL expression.
|
| KeyExpression |
This is part of JPA 2.0.
|
| KeywordExpression |
The expression representing some keywords:
TRUE, FALSE or NULL. |
| LengthExpression |
The LENGTH function returns the length of the string in characters as an integer.
|
| LikeExpression |
The LIKE condition is used to specify a search for a pattern.
|
| LikeExpressionBNF |
The query BNF for a expression.
|
| 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.
|
| LocateExpression |
The LOCATE function returns the position of a given string within a string, starting the
search at a specified position.
|
| LogicalExpression |
This expression represents a logical expression, which means the first and second expressions are
aggregated with either AND or OR.
|
| LowerExpression |
The LOWER function converts a string to lower case and it returns a string.
|
| MaxFunction |
One of the aggregate functions.
|
| MinFunction |
One of the aggregate functions.
|
| ModExpression |
The modulo operation finds the remainder of division of one number by another.
|
| MultiplicationExpression |
BNF:
arithmetic_expression ::= arithmetic_expression * arithmetic_term |
| NewValueBNF |
The query BNF for a new value expression.
|
| NotExpression |
BNF:
expression ::= NOT conditional_primary |
| NullComparisonExpression |
A null comparison tests whether or not the single-valued path expression or input parameter is a
NULL value.
|
| NullComparisonExpressionBNF |
The query BNF for a null comparison expression.
|
| NullExpression |
A
null Expression is used instead of a true null,
allowing operations to be performed without doing a null check. |
| NullIfExpression |
NULLIF returns the first expression if the two expressions are not equal.
|
| NullIfExpressionBNF |
The query BNF for a nullif expression.
|
| NumericLiteral |
Exact numeric literals support the use of Java integer literal syntax as well as SQL exact
numeric literal syntax.
|
| NumericLiteralBNF |
The query BNF for a numeric literal.
|
| ObjectExpression |
Stand-alone identification variables in the SELECT clause may optionally be qualified by
the OBJECT operator.
|
| ObjectExpressionBNF |
The query BNF for an object expression.
|
| OrderByClause |
The ORDER BY clause allows the objects or values that are returned by the query to be
ordered.
|
| OrderByClauseBNF |
The query BNF for the order by clause.
|
| OrderByItem |
An orderby_item must be one of the following:
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
A state_field_path_expression that evaluates to the same
state field of the same entity or embeddable abstract schema type as a state_field_path_expression in the SELECT clause
A result_variable that refers to an orderable item in the SELECT
clause for which the same result_variable has been specified. |
| OrderByItemBNF |
The query BNF for the order by item expression.
|
| OrExpression |
BNF:
conditional_expression ::= conditional_expression OR conditional_term |
| PatternValueBNF |
The query BNF for a pattern value.
|
| PreLiteralExpressionBNF |
The query BNF used to access
PreLiteralExpressionFactory. |
| QualifiedIdentificationVariableBNF |
The query BNF for a qualified identification variable expression.
|
| QueryPosition |
This object contains the cursor position within the parsed tree and within each of the
Expression from the root to the deepest leaf. |
| RangeVariableDeclaration |
Range variable declarations allow the developer to designate a "root" for objects which may not
be reachable by navigation.
|
| RangeVariableDeclarationBNF |
The query BNF for a range variable declaration expression.
|
| ResultVariable |
A result variable may be used to name a select item in the query result.
|
| ResultVariableBNF |
The query BNF for a result variable expression.
|
| ScalarExpressionBNF |
The query BNF for a scalar expression.
|
| SelectClause |
The SELECT clause queries data from entities.
|
| SelectClauseBNF |
The query BNF for the select clause.
|
| SelectExpressionBNF |
The query BNF for a select expression.
|
| SelectItemBNF |
The query BNF for a select item expression.
|
| SelectStatement |
A select statement must always have a SELECT and a FROM clause.
|
| SelectStatementBNF |
The query BNF for the select statement.
|
| SimpleArithmeticExpressionBNF |
The query BNF for a simple arithmetic expression.
|
| SimpleCaseExpressionBNF |
The query BNF for a simple case expression.
|
| SimpleConditionalExpressionBNF |
The query BNF for a simple conditional expression.
|
| SimpleEntityExpressionBNF |
The query BNF for a simple entity expression.
|
| SimpleEntityOrValueExpressionBNF |
The query BNF for a simple entity or value expression.
|
| SimpleFromClause |
The FROM clause of a query defines the domain of the query by declaring
identification variables.
|
| SimpleSelectClause |
The SELECT statement queries data from entities.
|
| SimpleSelectClauseBNF |
The query BNF for the simple select clause.
|
| SimpleSelectExpressionBNF |
The query BNF for a simple select expression.
|
| SimpleSelectStatement |
BNFL
subquery ::= simple_select_clause subquery_from_clause [where_clause] [groupby_clause] [having_clause] |
| SingleValuedObjectPathExpressionBNF |
The query BNF for a simple valued object path expression.
|
| SingleValuedPathExpressionBNF |
The query BNF for a single valued path expression.
|
| SizeExpression |
The SIZE function returns an integer value, the number of elements of the collection.
|
| SqrtExpression |
The SQRT function takes a numeric argument and returns a double.
|
| 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. |
| StateFieldPathExpressionBNF |
The query BNF for a state field path expression.
|
| StringExpression |
A
StringExpression is used when retrieving the deepest Expression in the
JPQL parsed tree. |
| StringExpressionBNF |
The query BNF for a string expression.
|
| StringLiteral |
A string literal is enclosed in single quotes.
|
| StringLiteralBNF |
The query BNF for a string literal.
|
| StringPrimaryBNF |
The query BNF for a string primary expression.
|
| SubExpression |
This expression wraps a sub-expression within parenthesis.
|
| SubQueryBNF |
The query BNF for a subquery expression.
|
| SubQueryFromClauseBNF |
The query BNF for the from clause defined in a subquery.
|
| SubSelectIdentificationVariableDeclarationBNF |
The query BNF for an identification variable declaration expression defined
in a sub-select expression.
|
| SubstringExpression |
The second and third arguments of the SUBSTRING function denote the starting position and
length of the substring to be returned.
|
| SubtractionExpression |
BNF:
arithmetic_expression ::= arithmetic_expression - arithmetic_term |
| SumFunction |
One of the aggregate functions.
|
| TreatExpression |
Returns an expression that allows to treat its base as if it were a subclass of the class
returned by the base.
|
| TreatExpressionBNF | |
| TrimExpression |
The TRIM function trims the specified character from a string.
|
| TypeExpression |
An entity type expression can be used to restrict query polymorphism.
|
| TypeExpressionBNF |
The query BNF for a type expression.
|
| UnknownExpression |
This expression contains a portion of the query that is unknown to the parser.
|
| UpdateClause |
This is the update clause of the update statement.
|
| UpdateClauseBNF |
The query BNF for the update clause.
|
| UpdateItem |
The
new_value specified for an update operation must be compatible in type with the
field to which it is assigned. |
| UpdateItemBNF |
The query BNF for the update item expression.
|
| UpdateItemStateFieldPathExpressionBNF |
The query BNF for a state field path expression used in an update item.
|
| UpdateStatement |
The WHERE clause of a query consists of a conditional expression used to select objects or
values that satisfy the expression.
|
| UpdateStatementBNF |
The query BNF for the update statement.
|
| UpperExpression |
The UPPER function converts a string to upper case and it returns a string.
|
| ValueExpression |
This is part of JPA 2.0.
|
| WhenClause |
A WHEN predicate is used to calculate a condition and when it's true, its THEN will
be executed.
|
| WhenClauseBNF |
The query BNF for the when clause of the case expression.
|
| WhereClause |
The WHERE clause of a query consists of a conditional expression used to select objects or
values that satisfy the expression.
|
| WhereClauseBNF |
The query BNF for the where clause.
|
| Enum | Description |
|---|---|
| IdentifierRole |
A role describes the purpose of the JPQL identifier.
|
| OrderByItem.Ordering |
This enumeration lists all the possible choices for ordering an item.
|
| TrimExpression.Specification |
The possible ways to trim the string.
|
EclipseLink 2.3.2, "build v20111125-r10461" API Reference