Class SelectStatement
- java.lang.Object
-
- org.eclipse.persistence.jpa.jpql.parser.AbstractExpression
-
- org.eclipse.persistence.jpa.jpql.parser.AbstractSelectStatement
-
- org.eclipse.persistence.jpa.jpql.parser.SelectStatement
-
- All Implemented Interfaces:
Expression
public final class SelectStatement extends AbstractSelectStatement
ASELECTquery is an operation that retrieves data from one or more tables or views.JPA:
BNF:select_statement ::= select_clause from_clause [where_clause] [groupby_clause] [having_clause] [orderby_clause]EclipseLink 2.4:
BNF:select_statement ::= select_clause from_clause [where_clause] [groupby_clause] [having_clause] [orderby_clause] {union_clause}*HQL query (EclipseLink 2.5):
BNF:select_statement ::= [select_clause] from_clause [where_clause] [groupby_clause] [having_clause] [orderby_clause] {union_clause}*- Version:
- 2.5
- See Also:
FromClause,GroupByClause,HavingClause,HierarchicalQueryClause,OrderByClause,SelectClause,UnionClause,WhereClause- Author:
- Pascal Filion
- Since:
- 2.3
-
-
Field Summary
-
Fields inherited from class org.eclipse.persistence.jpa.jpql.parser.AbstractExpression
COMMA, DOT, DOUBLE_QUOTE, LEFT_CURLY_BRACKET, LEFT_PARENTHESIS, NOT_DEFINED, RIGHT_CURLY_BRACKET, RIGHT_PARENTHESIS, SINGLE_QUOTE, SPACE, UNDERSCORE
-
Fields inherited from interface org.eclipse.persistence.jpa.jpql.parser.Expression
ABS, ALL, AND, ANY, AS, AS_OF, ASC, AVG, BETWEEN, BIT_LENGTH, BOTH, CASE, CAST, CHAR_LENGTH, CHARACTER_LENGTH, CLASS, COALESCE, COLUMN, CONCAT, CONNECT_BY, COUNT, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, DELETE, DELETE_FROM, DESC, DIFFERENT, DISTINCT, DIVISION, ELSE, EMPTY, END, ENTRY, EQUAL, ESCAPE, EXCEPT, EXISTS, EXTRACT, FALSE, FETCH, FIRST, FROM, FUNC, FUNCTION, GREATER_THAN, GREATER_THAN_OR_EQUAL, GROUP_BY, HAVING, IN, INDEX, INNER, INNER_JOIN, INNER_JOIN_FETCH, INTERSECT, IS, IS_EMPTY, IS_NOT_EMPTY, IS_NOT_NULL, IS_NULL, JOIN, JOIN_FETCH, KEY, LAST, LEADING, LEFT, LEFT_JOIN, LEFT_JOIN_FETCH, LEFT_OUTER_JOIN, LEFT_OUTER_JOIN_FETCH, LENGTH, LIKE, LOCATE, LOWER, LOWER_THAN, LOWER_THAN_OR_EQUAL, MAX, MEMBER, MEMBER_OF, MIN, MINUS, MOD, MULTIPLICATION, NAMED_PARAMETER, NEW, NOT, NOT_BETWEEN, NOT_EQUAL, NOT_EXISTS, NOT_IN, NOT_LIKE, NOT_MEMBER, NOT_MEMBER_OF, NULL, NULLIF, NULLS, NULLS_FIRST, NULLS_LAST, OBJECT, OF, ON, OPERATOR, OR, ORDER_BY, ORDER_SIBLINGS_BY, OUTER, PLUS, POSITION, POSITIONAL_PARAMETER, QUOTE, REGEXP, SCN, SELECT, SET, SIZE, SOME, SQL, SQRT, START_WITH, SUBSTRING, SUM, TABLE, THEN, TIMESTAMP, TRAILING, TREAT, TRIM, TRUE, TYPE, UNION, UNKNOWN, UPDATE, UPPER, VALUE, WHEN, WHERE
-
-
Constructor Summary
Constructors Constructor Description SelectStatement(AbstractExpression parent)Creates a newSelectStatement.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(ExpressionVisitor visitor)Visits thisExpressionby the givenvisitor.voidacceptChildren(ExpressionVisitor visitor)Visits the children of thisExpression.protected voidaddChildrenTo(java.util.Collection<Expression> children)Adds the children of thisAbstractExpressionto the given collection.protected voidaddOrderedChildrenTo(java.util.List<Expression> children)Adds the children of thisAbstractExpressionto the given list.protected FromClausebuildFromClause()Creates the expression representing the from clause of this select statement.protected SelectClausebuildSelectClause()Creates the expression representing the select clause of this select statement.JPQLQueryBNFfindQueryBNF(Expression expression)Retrieves theJPQLQueryBNFthat represents the fragment of thisExpressionthat was used when parsing the givenExpression.ExpressiongetOrderByClause()Returns theExpressionrepresenting the ORDER BY clause.JPQLQueryBNFgetQueryBNF()Returns the BNF of thisExpression.ExpressiongetUnionClauses()Returns theExpressionrepresenting the UNION clauses.booleanhasOrderByClause()Determines whether the ORDER BY clause is defined or not.booleanhasSpaceBeforeOrderBy()Determines whether a whitespace was parsed before the ORDER BY clause.booleanhasSpaceBeforeUnion()Determines whether a whitespace was parsed before the UNION clause.booleanhasUnionClauses()Determines whether at least one UNION clause was defined.protected booleanisParsingComplete(WordParser wordParser, java.lang.String word, Expression expression)Determines whether the parsing is complete based on what is left in the given text.protected voidparse(WordParser wordParser, boolean tolerant)Parses the query by starting at the current position, which is part of the givenWordParser.protected voidtoParsedText(java.lang.StringBuilder writer, boolean actual)Generates a string representation of thisExpression, including its children, if it has any.-
Methods inherited from class org.eclipse.persistence.jpa.jpql.parser.AbstractSelectStatement
getFromClause, getGroupByClause, getHavingClause, getSelectClause, getWhereClause, hasFromClause, hasGroupByClause, hasHavingClause, hasSelectClause, hasSpaceAfterFrom, hasSpaceAfterGroupBy, hasSpaceAfterSelect, hasSpaceAfterWhere, hasWhereClause, shouldManageSpaceAfterClause
-
Methods inherited from class org.eclipse.persistence.jpa.jpql.parser.AbstractExpression
acceptUnknownVisitor, acceptUnknownVisitor, buildExpressionFromFallingBack, buildNullExpression, buildStringExpression, buildStringExpression, buildUnknownExpression, calculatePosition, children, findFallBackExpressionFactory, getExpressionFactory, getExpressionRegistry, getGrammar, getIdentifierVersion, getJPAVersion, getLength, getOffset, getParent, getQueryBNF, getRoot, getText, handleAggregate, handleCollection, isAncestor, isIdentifier, isNull, isTolerant, isUnknown, isVirtual, orderedChildren, parse, parseUsingExpressionFactory, populatePosition, rebuildActualText, rebuildParsedText, setParent, setText, shouldParseWithFactoryFirst, shouldSkipLiteral, toActualText, toParsedText, toString
-
-
-
-
Constructor Detail
-
SelectStatement
public SelectStatement(AbstractExpression parent)
Creates a newSelectStatement.- Parameters:
parent- The parent of this expression
-
-
Method Detail
-
accept
public void accept(ExpressionVisitor visitor)
Visits thisExpressionby the givenvisitor.- Parameters:
visitor- TheExpressionVisitorto visit this object
-
acceptChildren
public void acceptChildren(ExpressionVisitor visitor)
Visits the children of thisExpression. This method can be used to optimize traversing the children since a new list is not created every timeExpression.children()is called.This does not traverse the
Expressionsub-hierarchy, use a subclass ofAbstractTraverseChildrenVisitorin order to traverse the entire sub-hierarchy.- Specified by:
acceptChildrenin interfaceExpression- Overrides:
acceptChildrenin classAbstractSelectStatement- Parameters:
visitor- Thevisitorto visit the children of this object.
-
addChildrenTo
protected void addChildrenTo(java.util.Collection<Expression> children)
Adds the children of thisAbstractExpressionto the given collection.- Overrides:
addChildrenToin classAbstractSelectStatement- Parameters:
children- The collection used to store the children
-
addOrderedChildrenTo
protected void addOrderedChildrenTo(java.util.List<Expression> children)
Adds the children of thisAbstractExpressionto the given list.- Overrides:
addOrderedChildrenToin classAbstractSelectStatement- Parameters:
children- The list used to store the string representation of thisAbstractExpression
-
buildFromClause
protected FromClause buildFromClause()
Creates the expression representing the from clause of this select statement.- Specified by:
buildFromClausein classAbstractSelectStatement- Returns:
- A new from clause,
nullcan't be returned
-
buildSelectClause
protected SelectClause buildSelectClause()
Creates the expression representing the select clause of this select statement.- Specified by:
buildSelectClausein classAbstractSelectStatement- Returns:
- A new from clause,
nullcan't be returned
-
findQueryBNF
public JPQLQueryBNF findQueryBNF(Expression expression)
Retrieves theJPQLQueryBNFthat represents the fragment of thisExpressionthat was used when parsing the givenExpression.- Specified by:
findQueryBNFin interfaceExpression- Overrides:
findQueryBNFin classAbstractSelectStatement- Parameters:
expression- TheExpressionthat is a descendant of this one- Returns:
- The
JPQLQueryBNFthat was used to parse the given expression
-
getOrderByClause
public Expression getOrderByClause()
Returns theExpressionrepresenting the ORDER BY clause.- Returns:
- The expression representing the ORDER BY clause
-
getQueryBNF
public JPQLQueryBNF getQueryBNF()
Returns the BNF of thisExpression.- Returns:
- The
JPQLQueryBNF, which represents the grammar of thisExpression
-
getUnionClauses
public Expression getUnionClauses()
Returns theExpressionrepresenting the UNION clauses.- Returns:
- The
Expressionrepresenting the UNION clauses
-
hasOrderByClause
public boolean hasOrderByClause()
Determines whether the ORDER BY clause is defined or not.- Returns:
trueif the query that got parsed had the ORDER BY clause
-
hasSpaceBeforeOrderBy
public boolean hasSpaceBeforeOrderBy()
Determines whether a whitespace was parsed before the ORDER BY clause. In some cases, the space could be owned by a child of the previous clause.- Returns:
trueif there was a whitespace before the ORDER BY;falseotherwise
-
hasSpaceBeforeUnion
public boolean hasSpaceBeforeUnion()
Determines whether a whitespace was parsed before the UNION clause. In some cases, the space could be owned by a child of the previous clause.- Returns:
trueif there was a whitespace before the UNION;falseotherwise
-
hasUnionClauses
public boolean hasUnionClauses()
Determines whether at least one UNION clause was defined.- Returns:
trueif the query that got parsed had the UNION clauses
-
isParsingComplete
protected boolean isParsingComplete(WordParser wordParser, java.lang.String word, Expression expression)
Determines whether the parsing is complete based on what is left in the given text. The text is never empty.- Overrides:
isParsingCompletein classAbstractExpression- Parameters:
wordParser- The text to parse based on the current position of the cursorword- The word that was retrieved from the given text, which is the first word in the textexpression- TheExpressionthat has already been parsed- Returns:
trueif the text no longer can't be parsed by the current expression;falseif more can be parsed
-
parse
protected void parse(WordParser wordParser, boolean tolerant)
Parses the query by starting at the current position, which is part of the givenWordParser.- Overrides:
parsein classAbstractSelectStatement- Parameters:
wordParser- The text to parse based on the current position of the cursortolerant- Determines whether the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries
-
toParsedText
protected void toParsedText(java.lang.StringBuilder writer, boolean actual)Generates a string representation of thisExpression, including its children, if it has any.- Overrides:
toParsedTextin classAbstractSelectStatement- Parameters:
writer- The buffer used to append thisExpression's string representationactual- Determines whether the string representation should represent what was parsed, i.e. include any "virtual" whitespace (such as ending whitespace) and the actual case of the JPQL identifiers
-
-