EclipseLink Hermes Parser 4.0.2 · org.eclipse.persistence.jpa.jpql.tools.model.query

Modifier and Type	Interface and Description
public interface	DeclarationStateObject This defines the declaration portion of a query, which is the `FROM` clause of a query.
public interface	EclipseLinkStateObjectVisitor The interface is used to traverse the `StateObject` hierarchy that represents a JPQL query as well as what EclipseLink adds on top of the basic grammar.
public interface	ListHolderStateObject<T> A `ListHolderStateObject` is a `StateObject` having a list of children and this gives access to some operation over the list.
public interface	StateObject A `StateObject` is an editable representation of a JPQL query.
public interface	StateObjectProblem
public interface	StateObjectVisitor The visitor is used to traverse the `StateObject` hierarchy that represents a JPQL query.
public interface	VariableDeclarationStateObject This defines a variable declaration, which has a "root" object and an identification variable.

Class Summary

Modifier and Type	Class and Description
public class	AbsExpressionStateObject 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 abstract class	AbstractConditionalClauseStateObject 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	AbstractDoubleEncapsulatedExpressionStateObject This `StateObject` represents a JPQL expression that has a JPQL identifier followed by two an encapsulated expression with parenthesis, the two expression are separated by a comma.
public abstract class	AbstractEclipseLinkStateObjectVisitor The abstract definition of `EclipseLinkStateObjectVisitor`, which implements all the methods but does nothing.
public abstract class	AbstractEclipseLinkTraverseChildrenVisitor This `StateObjectVisitor` traverses the entire hierarchy of the JPQL parsed tree by going down into each of the children of any given `StateObject`.
public abstract class	AbstractEclipseLinkTraverseParentVisitor This `StateObjectVisitor` traverses up the hierarchy.
public abstract class	AbstractEncapsulatedExpressionStateObject This expression handles parsing the identifier followed by an expression encapsulated within parenthesis.
public abstract class	AbstractFromClauseStateObject This state object represents the abstract definition of a `FROM` clause, which is either the `FROM` clause of the query or of a sub-query expression.
public abstract class	AbstractIdentificationVariableDeclarationStateObject
public abstract class	AbstractListHolderStateObject<T extends StateObject> The abstraction definition of a `StateObject` that holds onto a list of children, the methods defined in `ListHolderStateObject` are automatically handled here.
public abstract class	AbstractModifyClauseStateObject
public abstract class	AbstractModifyStatementStateObject The abstract definition of a modify statement.
public abstract class	AbstractPathExpressionStateObject An identification variable followed by the navigation operator (.) and a state field or association field is a path expression.
public abstract class	AbstractRangeVariableDeclarationStateObject
public class	AbstractSchemaNameStateObject An abstract schema name designates the abstract schema type over which the query ranges.
public abstract class	AbstractSelectClauseStateObject This state object represents the abstract definition of a `SELECT` clause, which is either the `SELECT` clause of the top-level query or of a subquery.
public abstract class	AbstractSelectStatementStateObject This state object represents the select statement, which has at least a `SELECT` clause and a `FROM` clause.
public abstract class	AbstractSingleEncapsulatedExpressionStateObject This `StateObject` represents a JPQL expression that has a JPQL identifier followed by an encapsulated expression with parenthesis.
public abstract class	AbstractStateObject The abstract definition of a `StateObject`.
public abstract class	AbstractStateObjectVisitor The abstract definition of `StateObjectVisitor`, which implements all the methods but does nothing.
public abstract class	AbstractTraverseChildrenVisitor This `StateObjectVisitor` traverses the entire hierarchy of the JPQL parsed tree by going down into each of the children of any given `StateObject`.
public abstract class	AbstractTraverseParentVisitor This `StateObjectVisitor` traverses up the hierarchy.
public abstract class	AbstractTripleEncapsulatedExpressionStateObject This state object takes care of parsing an expression that encapsulates three expressions separated by a comma.
public class	AdditionExpressionStateObject BNF: `arithmetic_expression ::= arithmetic_expression + arithmetic_term` .
public abstract class	AggregateFunctionStateObject In the `SELECT` clause the result of a query may be the result of an aggregate function applied to a path expression.
public class	AllOrAnyExpressionStateObject 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	AndExpressionStateObject The `AND` logical operator chains multiple criteria together.
public abstract class	AnonymousStateObjectVisitor This visitor allows a subclass to simply override `visit(StateObject)` and perform the same task for all visited `ItateObjects`.
public abstract class	AnonynousEclipseLinkStateObjectVisitor This visitor allows a subclass to simply override `visit(StateObject)` and perform the same task for all visited `ItateObjects`.
public abstract class	ArithmeticExpressionStateObject This expression represents an arithmetic expression, which means the first and second expressions are aggregated with an arithmetic sign.
public class	ArithmeticFactorStateObject This state object simply adds a plus or minus sign to the arithmetic primary expression.
public class	AvgFunctionStateObject One of the aggregate functions.
public class	BadExpressionStateObject This wraps an invalid portion of the JPQL query that could not be parsed.
public class	BetweenExpressionStateObject Used in conditional expression to determine whether the result of an expression falls within an inclusive range of values.
public class	CaseExpressionStateObject A `CASE` predicate is used to calculate a condition and when it's `true`, its `THEN` expression will be executed.
public class	ChangeSupport This `ChangeSupport` is responsible to notifies registered listeners upon changes made to a `StateObject`, those changes are either a property has changed (`IPropertyChangeListener`) or the content of a list has changed (`IListChangeListener`).
public class	CoalesceExpressionStateObject A `COALESCE` expression returns `null` if all its arguments evaluate to `null`, and the value of the first non-`null` argument otherwise.
public class	CollectionExpressionStateObject This `StateObject` is a temporary object used to store a list of `StateObjects`.
public class	CollectionMemberDeclarationStateObject An identification variable declared by a `collection_member_declaration` ranges over values of a collection obtained by navigation using a path expression.
public class	CollectionMemberExpressionStateObject This expression tests whether the designated value is a member of the collection specified by the collection-valued path expression.
public class	CollectionValuedPathExpressionStateObject 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	ComparisonExpressionStateObject Only the values of like types are permitted to be compared.
public abstract class	CompoundExpressionStateObject A compound `StateObject` has a left and right expressions combined by an identifier.
public class	ConcatExpressionStateObject The `CONCAT` function returns a string that is a concatenation of its arguments.
public class	ConstructorExpressionStateObject In the `SELECT` clause a constructor may be used in the `SELECT` list to return one or more Java instances.
public class	CountFunctionStateObject One of the aggregate functions.
public class	DateTimeStateObject This `DateTimeStateObject` represents a date or time.
public class	DeleteClauseStateObject This is the `DELETE` clause of the `DELETE` statement.
public class	DeleteStatementStateObject Bulk delete operation apply to entities of a single entity class (together with its subclasses, if any).
public class	DerivedPathIdentificationVariableDeclarationStateObject
public class	DerivedPathVariableDeclarationStateObject BNF: `subselect_identification_variable_declaration ::= derived_path_expression [AS] identification_variable {join}*`
public class	DivisionExpressionStateObject BNF: `arithmetic_expression ::= arithmetic_expression / arithmetic_term` .
public class	EmptyCollectionComparisonExpressionStateObject This expression tests whether or not the collection designated by the collection-valued path expression is empty (i.e, has no elements).
public abstract class	EncapsulatedIdentificationVariableExpressionStateObject This object represents an identification variable that is wrapped by a function.
public class	EntityTypeLiteralStateObject This `StateObject` wraps the name of an entity type.
public class	EntryExpressionStateObject This object represents an identification variable that maps the `Map.Entry`) of a `java.util.Map`.
public class	EnumTypeStateObject This `StateObject` wraps the name of an `Enum` constant.
public class	ExistsExpressionStateObject 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	FromClauseStateObject The `FROM` clause of a query defines the domain of the query by declaring identification variables.
public class	FunctionExpressionStateObject
public class	GroupByClauseStateObject The `GROUP BY` construct enables the aggregation of values according to the properties of an entity class.
public class	HavingClauseStateObject The `HAVING` construct enables conditions to be specified that further restrict the query result as restrictions upon the groups.
public class	IdentificationVariableDeclarationStateObject An identification variable is a valid identifier declared in the `FROM` clause of a query.
public class	IdentificationVariableStateObject This state object represents a single identification variable, which is identifying TODO.
public class	IndexExpressionStateObject The `INDEX` function returns an integer value corresponding to the position of its argument in an ordered list.
public class	InExpressionStateObject The state field path expression must have a string, numeric, or enum value.
public class	InputParameterStateObject Either positional or named parameters may be used.
public class	JoinStateObject A `JOIN` enables the fetching of an association as a side effect of the execution of a query.
public class	JPQLQueryStateObject This is the root of the `StateObject` hierarchy that represents a JPQL query.
public class	KeyExpressionStateObject This object represents an identification variable that maps the keys of a `java.util.Map`.
public class	KeywordExpressionStateObject The expression representing some keywords: `TRUE`, `FALSE` or `NULL`.
public class	LengthExpressionStateObject The `LENGTH` function returns the length of the string in characters as an integer.
public class	LikeExpressionStateObject The `LIKE` condition is used to specify a search for a pattern.
public class	LocateExpressionStateObject The `LOCATE` function returns the position of a given string within a string, starting the search at a specified position.
public abstract class	LogicalExpressionStateObject This expression represents a logical expression, which means the first and second expressions are aggregated with either the `AND` or the `OR` operator.
public class	LowerExpressionStateObject The `LOWER` function converts a string to lower case and it returns a string.
public class	MaxFunctionStateObject One of the aggregate functions.
public class	MinFunctionStateObject One of the aggregate functions.
public class	ModExpressionStateObject The modulo operation finds the remainder of division of one number by another.
public class	MultiplicationExpressionStateObject BNF: `arithmetic_expression ::= arithmetic_expression * arithmetic_term` .
public class	NotExpressionStateObject BNF: `expression ::= NOT conditional_primary`
public class	NullComparisonExpressionStateObject A null comparison tests whether or not the single-valued path expression or input parameter is a `NULL` value.
public class	NullIfExpressionStateObject `NULLIF` returns the first expression if the two expressions are not equal.
public class	NumericLiteralStateObject Exact numeric literals support the use of Java integer literal syntax as well as SQL exact numeric literal syntax.
public class	ObjectExpressionStateObject Stand-alone identification variables in the `SELECT` clause may optionally be qualified by the `OBJECT` operator.
public class	OrderByClauseStateObject The `ORDER BY` clause allows the objects or values that are returned by the query to be ordered.
public class	OrderByItemStateObject An `ORDER BY` 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
public class	OrExpressionStateObject The `OR` logical operator chains multiple criteria together.
public class	RangeVariableDeclarationStateObject Range variable declarations allow the developer to designate a "root" for objects which may not be reachable by navigation.
public class	ResultVariableStateObject A result variable may be used to name a select item in the query result.
public class	SelectClauseStateObject The `SELECT` statement queries data from entities, which determines the type of the objects or values to be selected.
public class	SelectStatementStateObject This state object represents a select statement, which has at least a `SELECT` clause and a `FROM` clause.
public class	SimpleFromClauseStateObject The `FROM` clause of a sub-query defines the domain of the sub-query by declaring identification variables.
public class	SimpleSelectClauseStateObject The SELECT statement queries data from entities.
public class	SimpleSelectStatementStateObject This state object represents a subquery, which has at least a `SELECT` clause and a `FROM` clause.
public abstract class	SimpleStateObject This `StateObject` simply holds onto a string.
public class	SizeExpressionStateObject The `SIZE` function returns an integer value, the number of elements of the collection.
public class	SqrtExpressionStateObject The `SQRT` function takes a numeric argument and returns a `Double`.
public class	StateFieldPathExpressionStateObject 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	StringLiteralStateObject A string literal is enclosed in single quotes.
public class	SubExpressionStateObject This expression wraps a sub-expression within parenthesis.
public class	SubstringExpressionStateObject The second and third arguments of the `SUBSTRING` function denote the starting position and length of the substring to be returned.
public class	SubtractionExpressionStateObject BNF: `arithmetic_expression ::= arithmetic_expression - arithmetic_term` .
public class	SumFunctionStateObject One of the aggregate functions.
public class	TreatExpressionStateObject Returns an expression that allows to treat its base as if it were a subclass of the class returned by the base.
public class	TrimExpressionStateObject The `TRIM` function trims the specified character from a string.
public class	TypeExpressionStateObject An entity type expression can be used to restrict query polymorphism.
public class	UnknownExpressionStateObject This `StateObject` holds onto an unknown portion of a JPQL query that could not be parsed.
public class	UpdateClauseStateObject This is the `UPDATE` clause of the `UPDATE` statement.
public class	UpdateItemStateObject The `new_value` specified for an update operation must be compatible in type with the field to which it is assigned.
public class	UpdateStatementStateObject The `UPDATE` clause of a query consists of a conditional expression used to select objects or values that satisfy the expression.
public class	UpperExpressionStateObject The `UPPER` function converts a string to upper case and it returns a string.
public class	ValueExpressionStateObject This object represents an identification variable that maps the values of a `java.util.Map`.
public class	WhenClauseStateObject A `WHEN` predicate is used to calculate a condition and when it's true, its `THEN` will be executed.
public class	WhereClauseStateObject The `WHERE` clause of a query consists of a conditional expression used to select objects or values that satisfy the expression.

Package org.eclipse.persistence.jpa.jpql.tools.model.query

Interface Summary

Class Summary