public interface JpqlSyntax extends JpqlConstants
statements
against
persistent entities independent of the mechanism used to store those entities. It is part of the Java
Persistence API (JPA).JPQL_STATEMENT
ABS, ALL, AND, ANY, AS, AVG, BETWEEN, BOTH, CONCAT, COUNT, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, DELETE, DISTINCT, EMPTY, EQUAL, ESCAPE, EXISTS, FETCH, FROM, GREATER, GREATER_OR_EQUAL, GROUP_BY, HAVING, IN, INNER, INNER_JOIN, IS, IS_EMPTY, IS_MEMBER, IS_NOT_EMPTY, IS_NOT_MEMBER, IS_NOT_NULL, IS_NULL, JPQL_IN_END, JPQL_IN_START, LEADING, LEFT, LEFT_JOIN, LEFT_OUTER_JOIN, LENGTH, LESS, LESS_OR_EQUAL, LIKE, LOCATE, LOWER, MAX, MEMBER, MIN, MOD, NEW, NOT, NOT_EQUAL, NOT_LIKE, NULL, OBJECT, OF, OPERATOR_NOT_BETWEEN, OR, ORDER_BY, OUTER, PARAMETER, SELECT, SET, SIZE, SOME, SQRT, SUBSTRING, SUM, TRAILING, TRIM, UPDATE, UPPER, WHERE
static final JpqlSyntax JPQL_STATEMENT
JpqlSyntax
and represents any statement. JPQL_STATEMENT
::= SELECT_STATEMENT
| UPDATE_STATEMENT
|
DELETE_STATEMENT
static final JpqlSyntax SELECT_STATEMENT
JPQL_STATEMENT
used to search on persistent entities. It will
result in a query object and will only read from the store without causing modifications. JpqlConstants.SELECT
::= SELECT_CLAUSE
FROM_CLAUSE
[ WHERE_CLAUSE
] [
GROUP_BY_CLAUSE
] [HAVING_CLAUSE
] [ ORDER_BY_CLAUSE
]static final JpqlSyntax SELECT_CLAUSE
SELECT_STATEMENT
. SELECT_CLAUSE
::= SELECT
[JpqlConstants.DISTINCT
] SELECT_EXPRESSION
{,
SELECT_EXPRESSION
} *static final JpqlSyntax FROM_CLAUSE
JPQL_STATEMENT
. FROM_CLAUSE
::= JpqlConstants.FROM
IDENTIFICATION_VARIABLE_DECLARATION
{, {
IDENTIFICATION_VARIABLE_DECLARATION
| COLLECTION_MEMBER_DECLARATION
}}
*static final JpqlSyntax SELECT_EXPRESSION
SELECT_CLAUSE
that specifies what to select. SELECT_EXPRESSION
::= SINGLE_VALUED_PATH_EXPRESSION
| AGGREGATE_EXPRESSION
|
IDENTIFICATION_VARIABLE
| OBJECT
(IDENTIFICATION_VARIABLE
)|
CONSTRUCTOR_EXPRESSION
static final JpqlSyntax CONSTRUCTOR_EXPRESSION
SELECT_CLAUSE
that creates new transient objects using the specified
constructor. CONSTRUCTOR_EXPRESSION
::= NEW
CONSTRUCTOR_NAME
( CONSTRUCTOR_ITEM
{, CONSTRUCTOR_ITEM
*)static final JpqlSyntax CONSTRUCTOR_ITEM
static final JpqlSyntax CONSTRUCTOR_NAME
name of the constructor
to invoke for creating
transient result objects in a constructor query.CONSTRUCTOR_EXPRESSION
static final JpqlSyntax AGGREGATE_EXPRESSION
AGGREGATE_EXPRESSION
::= {JpqlConstants.AVG
|JpqlConstants.MAX
| JpqlConstants.MIN
| JpqlConstants.SUM
([
JpqlConstants.DISTINCT
] STATE_FIELD_PATH_EXPRESSION
) | JpqlConstants.COUNT
([JpqlConstants.DISTINCT
]
IDENTIFICATION_VARIABLE
| STATE_FIELD_PATH_EXPRESSION
|
SINGLE_VALUED_ASSOCIATION_PATH_EXPRESSION
)static final JpqlSyntax RANGE_VARIABLE_DECLARATION
static final JpqlSyntax IDENTIFICATION_VARIABLE_DECLARATION
static final JpqlSyntax IDENTIFICATION_VARIABLE
entity
(see
PersistenceEntity
) or an expression in statements like FROM, JOIN, IN,
etc. Magazine
articles
of alias1
static final JpqlSyntax JOIN
static final JpqlSyntax FETCH_JOIN
static final JpqlSyntax JOIN_SPEC
static final JpqlSyntax JOIN_ASSOCIATION_PATH_EXPRESSION
static final JpqlSyntax JOIN_COLLECTION_VALUED_PATH_EXPRESSION
static final JpqlSyntax JOIN_SINGLE_VALUED_ASSOCIATION_PATH_EXPRESSION
static final JpqlSyntax SINGLE_VALUED_PATH_EXPRESSION
static final JpqlSyntax ASSOCIATION_PATH_EXPRESSION
static final JpqlSyntax COLLECTION_VALUED_PATH_EXPRESSION
static final JpqlSyntax COLLECTION_VALUED_ASSOCIATION_FIELD
COLLECTION_VALUED_ASSOCIATION_FIELD
is designated by the name of an association-field in a
one-to-many or a many-to-many relationship. The type of a COLLECTION_VALUED_ASSOCIATION_FIELD
is
a collection of values of the abstract schema type of the related entity. name of a field
/property to identify.static final JpqlSyntax SINGLE_VALUED_ASSOCIATION_PATH_EXPRESSION
static final JpqlSyntax WHERE_CLAUSE
static final JpqlSyntax GROUP_BY_CLAUSE
static final JpqlSyntax GROUP_BY_ITEM
static final JpqlSyntax HAVING_CLAUSE
static final JpqlSyntax ORDER_BY_CLAUSE
static final JpqlSyntax ORDER_BY_ITEM
static final JpqlSyntax STATE_FIELD_PATH_EXPRESSION
static final JpqlSyntax CONDITIONAL_EXPRESSION
static final JpqlSyntax SIMPLE_CONDITIONAL_EXPRESSION
static final JpqlSyntax COMPARISON_EXPRESSION
COMPARISON_EXPRESSION
::= STRING_EXPRESSION_COMPARISON_OPERATOR
{
STRING_EXPRESSION
| ALL_OR_ANY_EXPRESSION
}| BOOLEAN_EXPRESSION
{=|
<> {BOOLEAN_EXPRESSION
| ALL_OR_ANY_EXPRESSION
} |
ENUM_EXPRESSION
{=|<>} {ENUM_EXPRESSION
|
ALL_OR_ANY_EXPRESSION
} | DATETIME_EXPRESSION
COMPARISON_OPERATOR
{
DATETIME_EXPRESSION
| ALL_OR_ANY_EXPRESSION
} | ENTITY_EXPRESSION
{= |<>
} {ENTITY_EXPRESSION
| ALL_OR_ANY_EXPRESSION
} |
ARITHMETIC_EXPRESSION
COMPARISON_OPERATOR
{ARITHMETIC_EXPRESSION
|
ALL_OR_ANY_EXPRESSION
static final JpqlSyntax COMPARISON_OPERATOR
COMPARISON_OPERATOR
::== |> |>= |< |<= |<>static final JpqlSyntax STRING_EXPRESSION_COMPARISON_OPERATOR
static final JpqlSyntax ALL_OR_ANY_EXPRESSION
static final JpqlSyntax ENTITY_EXPRESSION
static final JpqlSyntax SIMPLE_ENTITY_EXPRESSION
static final JpqlSyntax ENUM_EXPRESSION
static final JpqlSyntax ENUM_PRIMARY
static final JpqlSyntax ENUM_LITERAL
static final JpqlSyntax BOOLEAN_EXPRESSION
static final JpqlSyntax BOOLEAN_PRIMARY
static final JpqlSyntax BOOLEAN_LITERAL
static final JpqlSyntax NULL_COMPARISON_EXPRESSION
static final JpqlSyntax EMPTY_COLLECTION_COMPARISON_EXPRESSION
static final JpqlSyntax COLLECTION_MEMBER_EXPRESSION
static final JpqlSyntax COLLECTION_MEMBER_DECLARATION
static final JpqlSyntax EXISTS_EXPRESSION
static final JpqlSyntax IN_EXPRESSION
IN_EXPRESSION
::= STATE_FIELD_PATH_EXPRESSION
[JpqlConstants.NOT
] IN
(
IN_ITEM
{, IN_ITEM
}* | SUBQUERY
)static final JpqlSyntax IN_ITEM
static final JpqlSyntax LITERAL
static final JpqlSyntax LIKE_EXPRESSION
LIKE_EXPRESSION
::= STRING_EXPRESSION
[JpqlConstants.NOT
] LIKE
PATTERN_VALUE
[ESCAPE
#escape_character]static final JpqlSyntax PATTERN_VALUE
LIKE_EXPRESSION
, e.g. '%foo%'
to match any string that
contains
"foo". Wildcard | Glob | SQL |
---|---|---|
Any substring (zero or more characters). | * | % |
A single character. | ? | _ |
Any single character out of the given list. | <not supported> | [<characters>] |
Any single character NOT in the given list. | <not supported> | [^<characters>] or [!<characters>] |
static final JpqlSyntax BETWEEN_EXPRESSION
JpqlConstants.BETWEEN
expression to test value Range
s.
BETWEEN_EXPRESSION
::= ARITHMETIC_EXPRESSION
[JpqlConstants.NOT
] BETWEEN
ARITHMETIC_EXPRESSION
JpqlConstants.AND
ARITHMETIC_EXPRESSION
| STRING_EXPRESSION
[
JpqlConstants.NOT
] JpqlConstants.BETWEEN
STRING_EXPRESSION
JpqlConstants.AND
STRING_EXPRESSION
|
DATETIME_EXPRESSION
[ JpqlConstants.NOT
] JpqlConstants.BETWEEN
DATETIME_EXPRESSION
JpqlConstants.AND
DATETIME_EXPRESSION
static final JpqlSyntax ARITHMETIC_EXPRESSION
static final JpqlSyntax SIMPLE_ARITHMETIC_EXPRESSION
static final JpqlSyntax ARITHMETIC_TERM
static final JpqlSyntax ARITHMETIC_FACTORY
ARITHMETIC_FACTORY
::= [{+ |-}] #arithmetic_primarystatic final JpqlSyntax ARITHMETIC_PRIMARY
static final JpqlSyntax NUMERIC_LITERAL
42
or 1.5
.static final JpqlSyntax FUNCTIONS_RETURNING_NUMERICS
FUNCTIONS_RETURNING_NUMERICS
::= JpqlConstants.LENGTH
(STRING_PRIMARY
)| JpqlConstants.LOCATE
(
STRING_PRIMARY
,STRING_PRIMARY
[, SIMPLE_ARITHMETIC_EXPRESSION
]) | JpqlConstants.ABS
(SIMPLE_ARITHMETIC_EXPRESSION
) | JpqlConstants.SQRT
(SIMPLE_ARITHMETIC_EXPRESSION
) |
JpqlConstants.MOD
(SIMPLE_ARITHMETIC_EXPRESSION
, SIMPLE_ARITHMETIC_EXPRESSION
) |
JpqlConstants.SIZE
(COLLECTION_VALUED_PATH_EXPRESSION
)static final JpqlSyntax STRING_EXPRESSION
static final JpqlSyntax STRING_PRIMARY
static final JpqlSyntax STRING_LITERAL
String
literal enclosed with single quotes, e.g. 'foo'
.static final JpqlSyntax FUNCTIONS_RETURNING_STRINGS
FUNCTIONS_RETURNING_STRINGS
::= JpqlConstants.CONCAT
(STRING_PRIMARY
, STRING_PRIMARY
) | JpqlConstants.SUBSTRING
(STRING_PRIMARY
, SIMPLE_ARITHMETIC_EXPRESSION
,
SIMPLE_ARITHMETIC_EXPRESSION
)| JpqlConstants.TRIM
([[TRIM_SPECIFICATION
] [
TRIM_CHARACTER
] JpqlConstants.FROM
] STRING_PRIMARY
) | JpqlConstants.LOWER
(STRING_PRIMARY
) | JpqlConstants.UPPER
( STRING_PRIMARY
)static final JpqlSyntax TRIM_SPECIFICATION
static final JpqlSyntax TRIM_CHARACTER
static final JpqlSyntax DATETIME_EXPRESSION
static final JpqlSyntax DATETIME_PRIMARY
static final JpqlSyntax FUNCTIONS_RETURNING_DATETIME
static final JpqlSyntax INPUT_PARAMETER
:foo
).Query.setParameter(int, Object)
,
Query.setParameter(String, Object)
static final JpqlSyntax CONDITIONAL_TERM
static final JpqlSyntax CONDITIONAL_FACTOR
static final JpqlSyntax CONDITIONAL_PRIMARY
static final JpqlSyntax DELETE_STATEMENT
JPQL_STATEMENT
used to delete persistent entities. It is similar
to a SELECT_STATEMENT
but will delete the results
instead of returning them. DELETE_STATEMENT
::= DELETE_CLAUSE
[ WHERE_CLAUSE
]static final JpqlSyntax DELETE_CLAUSE
DELETE_STATEMENT
. DELETE_CLAUSE
::= DELETE
JpqlConstants.FROM
ABSTRACT_SCHEMA_NAME
[[
JpqlConstants.AS
] IDENTIFICATION_VARIABLE
]static final JpqlSyntax ABSTRACT_SCHEMA_NAME
static final JpqlSyntax UPDATE_STATEMENT
JPQL_STATEMENT
used to delete persistent entities. It is
similar to a SELECT_STATEMENT
but will update the
results
instead of returning them. UPDATE_STATEMENT
::= UPDATE_CLAUSE
[WHERE_CLAUSE
]static final JpqlSyntax UPDATE_CLAUSE
UPDATE_STATEMENT
. UPDATE_CLAUSE
::= JpqlConstants.UPDATE
ABSTRACT_SCHEMA_NAME
[[JpqlConstants.AS
]
IDENTIFICATION_VARIABLE
] JpqlConstants.SET
UPDATE_ITEM
{, UPDATE_ITEM
}
*static final JpqlSyntax UPDATE_ITEM
UPDATE_CLAUSE
. UPDATE_ITEM
::= [IDENTIFICATION_VARIABLE
.]{STATE_FIELD
|
SINGLE_VALUED_ASSOCIATION_FIELD
= NEW_VALUE
static final JpqlSyntax STATE_FIELD
field
or property of an entity.
STATE_FIELD
::= {EMBEDDED_CLASS_STATE_FIELD
.}*
SIMPLE_STATE_FIELD
static final JpqlSyntax SINGLE_VALUED_ASSOCIATION_FIELD
SINGLE_VALUED_ASSOCIATION_FIELD
is designated by the name of an association-field in a
one-to-one or many-to-one relationship. The type of a SINGLE_VALUED_ASSOCIATION_FIELD
and thus a
SINGLE_VALUED_ASSOCIATION_PATH_EXPRESSION
is the abstract schema type of the related entity. name of a field
/property to identify.static final JpqlSyntax SIMPLE_STATE_FIELD
static final JpqlSyntax EMBEDDED_CLASS_STATE_FIELD
EMBEDDED_CLASS_STATE_FIELD
is designated by the name of an entity-state field that
corresponds to an embedded class. Navigation to a related entity results in a value of the related
entity's abstract schema type.Embeddable
static final JpqlSyntax NEW_VALUE
static final JpqlSyntax SUBQUERY
static final JpqlSyntax SUBQUERY_FROM_CLAUSE
static final JpqlSyntax SIMPLE_SELECT_CLAUSE
static final JpqlSyntax SIMPLE_SELECT_EXPRESSION
static final JpqlSyntax SUBSELECT_IDENTIFICATION_VARIABLE_DECLARATION
Copyright © 2001–2014 mmm-Team. All rights reserved.