Package org.eclipse.persistence.jpa.jpql.tools.model.query
This package contains the
StateObject classes that represents a JPQL query.-
Interface Summary Interface Description DeclarationStateObject This defines the declaration portion of a query, which is theFROMclause of a query.EclipseLinkStateObjectVisitor The interface is used to traverse theStateObjecthierarchy that represents a JPQL query as well as what EclipseLink adds on top of the basic grammar.ListHolderStateObject<T> AListHolderStateObjectis aStateObjecthaving a list of children and this gives access to some operation over the list.StateObject AStateObjectis an editable representation of a JPQL query.StateObjectProblem StateObjectVisitor The visitor is used to traverse theStateObjecthierarchy that represents a JPQL query.VariableDeclarationStateObject This defines a variable declaration, which has a "root" object and an identification variable. -
Class Summary Class Description AbsExpressionStateObject TheABSfunction removes the minus sign from a specified argument and returns the absolute value, which is always a positive number or zero.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.AbstractDoubleEncapsulatedExpressionStateObject ThisStateObjectrepresents a JPQL expression that has a JPQL identifier followed by two an encapsulated expression with parenthesis, the two expression are separated by a comma.AbstractEclipseLinkStateObjectVisitor The abstract definition ofEclipseLinkStateObjectVisitor, which implements all the methods but does nothing.AbstractEclipseLinkTraverseChildrenVisitor ThisStateObjectVisitortraverses the entire hierarchy of the JPQL parsed tree by going down into each of the children of any givenStateObject.AbstractEclipseLinkTraverseParentVisitor ThisStateObjectVisitortraverses up the hierarchy.AbstractEncapsulatedExpressionStateObject This expression handles parsing the identifier followed by an expression encapsulated within parenthesis.AbstractFromClauseStateObject This state object represents the abstract definition of aFROMclause, which is either theFROMclause of the query or of a sub-query expression.AbstractIdentificationVariableDeclarationStateObject AbstractListHolderStateObject<T extends StateObject> The abstraction definition of aStateObjectthat holds onto a list of children, the methods defined inListHolderStateObjectare automatically handled here.AbstractModifyClauseStateObject AbstractModifyStatementStateObject The abstract definition of a modify statement.AbstractPathExpressionStateObject An identification variable followed by the navigation operator (.) and a state field or association field is a path expression.AbstractRangeVariableDeclarationStateObject AbstractSchemaNameStateObject An abstract schema name designates the abstract schema type over which the query ranges.AbstractSelectClauseStateObject This state object represents the abstract definition of aSELECTclause, which is either theSELECTclause of the top-level query or of a subquery.AbstractSelectStatementStateObject This state object represents the select statement, which has at least aSELECTclause and aFROMclause.AbstractSingleEncapsulatedExpressionStateObject ThisStateObjectrepresents a JPQL expression that has a JPQL identifier followed by an encapsulated expression with parenthesis.AbstractStateObject The abstract definition of aStateObject.AbstractStateObjectVisitor The abstract definition ofStateObjectVisitor, which implements all the methods but does nothing.AbstractTraverseChildrenVisitor ThisStateObjectVisitortraverses the entire hierarchy of the JPQL parsed tree by going down into each of the children of any givenStateObject.AbstractTraverseParentVisitor ThisStateObjectVisitortraverses up the hierarchy.AbstractTripleEncapsulatedExpressionStateObject This state object takes care of parsing an expression that encapsulates three expressions separated by a comma.AdditionExpressionStateObject TODO: BNF:arithmetic_expression ::= arithmetic_expression + arithmetic_termAggregateFunctionStateObject In theSELECTclause the result of a query may be the result of an aggregate function applied to a path expression.AllOrAnyExpressionStateObject AnALLconditional expression is a predicate that istrueif the comparison operation istruefor all values in the result of the subquery or the result of the subquery is empty.AndExpressionStateObject TheANDlogical operator chains multiple criteria together.AnonymousStateObjectVisitor This visitor allows a subclass to simply overrideAnonymousStateObjectVisitor.visit(StateObject)and perform the same task for all visitedItateObjects.AnonynousEclipseLinkStateObjectVisitor This visitor allows a subclass to simply overrideAnonymousStateObjectVisitor.visit(StateObject)and perform the same task for all visitedItateObjects.ArithmeticExpressionStateObject This expression represents an arithmetic expression, which means the first and second expressions are aggregated with an arithmetic sign.ArithmeticFactorStateObject This state object simply adds a plus or minus sign to the arithmetic primary expression.AvgFunctionStateObject One of the aggregate functions.BadExpressionStateObject This wraps an invalid portion of the JPQL query that could not be parsed.BetweenExpressionStateObject Used in conditional expression to determine whether the result of an expression falls within an inclusive range of values.CaseExpressionStateObject ACASEpredicate is used to calculate a condition and when it'strue, itsTHENexpression will be executed.ChangeSupport ThisChangeSupportis responsible to notifies registered listeners upon changes made to aStateObject, those changes are either a property has changed (IPropertyChangeListener) or the content of a list has changed (IListChangeListener).CoalesceExpressionStateObject ACOALESCEexpression returnsnullif all its arguments evaluate tonull, and the value of the first non-nullargument otherwise.CollectionExpressionStateObject ThisStateObjectis a temporary object used to store a list ofStateObjects.CollectionMemberDeclarationStateObject An identification variable declared by acollection_member_declarationranges over values of a collection obtained by navigation using a path expression.CollectionMemberExpressionStateObject This expression tests whether the designated value is a member of the collection specified by the collection-valued path expression.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.ComparisonExpressionStateObject Only the values of like types are permitted to be compared.CompoundExpressionStateObject A compoundStateObjecthas a left and right expressions combined by an identifier.ConcatExpressionStateObject TheCONCATfunction returns a string that is a concatenation of its arguments.ConstructorExpressionStateObject In theSELECTclause a constructor may be used in theSELECTlist to return one or more Java instances.CountFunctionStateObject One of the aggregate functions.DateTimeStateObject ThisDateTimeStateObjectrepresents a date or time.DeleteClauseStateObject This is theDELETEclause of theDELETEstatement.DeleteStatementStateObject Bulk delete operation apply to entities of a single entity class (together with its subclasses, if any).DerivedPathIdentificationVariableDeclarationStateObject DerivedPathVariableDeclarationStateObject BNF:subselect_identification_variable_declaration ::= derived_path_expression [AS] identification_variable {join}*DivisionExpressionStateObject TODO: BNF:arithmetic_expression ::= arithmetic_expression / arithmetic_termEmptyCollectionComparisonExpressionStateObject This expression tests whether or not the collection designated by the collection-valued path expression is empty (i.e, has no elements).EncapsulatedIdentificationVariableExpressionStateObject This object represents an identification variable that is wrapped by a function.EntityTypeLiteralStateObject ThisStateObjectwraps the name of an entity type.EntryExpressionStateObject This object represents an identification variable that maps theMap.Entry) of aMap.EnumTypeStateObject ThisStateObjectwraps the name of anEnumconstant.ExistsExpressionStateObject AnEXISTSexpression is a predicate that istrueonly if the result of the subquery consists of one or more values and that isfalseotherwise.FromClauseStateObject TheFROMclause of a query defines the domain of the query by declaring identification variables.FunctionExpressionStateObject GroupByClauseStateObject TheGROUP BYconstruct enables the aggregation of values according to the properties of an entity class.HavingClauseStateObject TheHAVINGconstruct enables conditions to be specified that further restrict the query result as restrictions upon the groups.IdentificationVariableDeclarationStateObject An identification variable is a valid identifier declared in theFROMclause of a query.IdentificationVariableStateObject This state object represents a single identification variable, which is identifying TODO.IndexExpressionStateObject TheINDEXfunction returns an integer value corresponding to the position of its argument in an ordered list.InExpressionStateObject The state field path expression must have a string, numeric, or enum value.InputParameterStateObject Either positional or named parameters may be used.JoinStateObject AJOINenables the fetching of an association as a side effect of the execution of a query.JPQLQueryStateObject This is the root of theStateObjecthierarchy that represents a JPQL query.KeyExpressionStateObject This object represents an identification variable that maps the keys of aMap.KeywordExpressionStateObject The expression representing some keywords:TRUE,FALSEorNULL.LengthExpressionStateObject TheLENGTHfunction returns the length of the string in characters as an integer.LikeExpressionStateObject TheLIKEcondition is used to specify a search for a pattern.LocateExpressionStateObject TheLOCATEfunction returns the position of a given string within a string, starting the search at a specified position.LogicalExpressionStateObject This expression represents a logical expression, which means the first and second expressions are aggregated with either theANDor theORoperator.LowerExpressionStateObject TheLOWERfunction converts a string to lower case and it returns a string.MaxFunctionStateObject One of the aggregate functions.MinFunctionStateObject One of the aggregate functions.ModExpressionStateObject The modulo operation finds the remainder of division of one number by another.MultiplicationExpressionStateObject TODO: BNF:arithmetic_expression ::= arithmetic_expression * arithmetic_termNotExpressionStateObject BNF:expression ::= NOT conditional_primaryNullComparisonExpressionStateObject A null comparison tests whether or not the single-valued path expression or input parameter is aNULLvalue.NullIfExpressionStateObject NULLIFreturns the first expression if the two expressions are not equal.NumericLiteralStateObject Exact numeric literals support the use of Java integer literal syntax as well as SQL exact numeric literal syntax.ObjectExpressionStateObject Stand-alone identification variables in theSELECTclause may optionally be qualified by theOBJECToperator.OrderByClauseStateObject TheORDER BYclause allows the objects or values that are returned by the query to be ordered.OrderByItemStateObject AnORDER BYitem must be one of the following: Astate_field_path_expressionthat evaluates to an orderable state field of an entity or embeddable class abstract schema type designated in theSELECTclause by one of the following: A general_identification_variable A single_valued_object_path_expression Astate_field_path_expressionthat evaluates to the same state field of the same entity or embeddable abstract schema type as astate_field_path_expressionin the SELECT clause Aresult_variablethat refers to an orderable item in theSELECTclause for which the sameresult_variablehas been specified.OrExpressionStateObject TheORlogical operator chains multiple criteria together.RangeVariableDeclarationStateObject Range variable declarations allow the developer to designate a "root" for objects which may not be reachable by navigation.ResultVariableStateObject A result variable may be used to name a select item in the query result.SelectClauseStateObject TheSELECTstatement queries data from entities, which determines the type of the objects or values to be selected.SelectStatementStateObject This state object represents a select statement, which has at least aSELECTclause and aFROMclause.SimpleFromClauseStateObject TheFROMclause of a sub-query defines the domain of the sub-query by declaring identification variables.SimpleSelectClauseStateObject The SELECT statement queries data from entities.SimpleSelectStatementStateObject This state object represents a subquery, which has at least aSELECTclause and aFROMclause.SimpleStateObject ThisStateObjectsimply holds onto a string.SizeExpressionStateObject TheSIZEfunction returns an integer value, the number of elements of the collection.SqrtExpressionStateObject TheSQRTfunction takes a numeric argument and returns aDouble.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.StateFieldPathExpressionStateObject.MapManagedType StringLiteralStateObject A string literal is enclosed in single quotes.SubExpressionStateObject This expression wraps a sub-expression within parenthesis.SubstringExpressionStateObject The second and third arguments of theSUBSTRINGfunction denote the starting position and length of the substring to be returned.SubtractionExpressionStateObject TODO: BNF:arithmetic_expression ::= arithmetic_expression - arithmetic_termSumFunctionStateObject One of the aggregate functions.TreatExpressionStateObject Returns an expression that allows to treat its base as if it were a subclass of the class returned by the base.TrimExpressionStateObject TheTRIMfunction trims the specified character from a string.TypeExpressionStateObject An entity type expression can be used to restrict query polymorphism.UnknownExpressionStateObject ThisStateObjectholds onto an unknown portion of a JPQL query that could not be parsed.UpdateClauseStateObject This is theUPDATEclause of theUPDATEstatement.UpdateItemStateObject Thenew_valuespecified for an update operation must be compatible in type with the field to which it is assigned.UpdateStatementStateObject TheUPDATEclause of a query consists of a conditional expression used to select objects or values that satisfy the expression.UpperExpressionStateObject TheUPPERfunction converts a string to upper case and it returns a string.ValueExpressionStateObject This object represents an identification variable that maps the values of aMap.WhenClauseStateObject AWHENpredicate is used to calculate a condition and when it's true, itsTHENwill be executed.WhereClauseStateObject TheWHEREclause of a query consists of a conditional expression used to select objects or values that satisfy the expression.