Class AbstractSelectStatement
- java.lang.Object
-
- org.eclipse.persistence.jpa.jpql.parser.AbstractExpression
-
- org.eclipse.persistence.jpa.jpql.parser.AbstractSelectStatement
-
- All Implemented Interfaces:
Expression
- Direct Known Subclasses:
SelectStatement,SimpleSelectStatement
public abstract class AbstractSelectStatement extends AbstractExpression
A query is an operation that retrieves data from one or more tables or views. In this reference, a top-levelSELECTstatement is called a query, and a query nested within another SQL statement is called a subquery.- Version:
- 2.5
- See Also:
SelectStatement,SimpleSelectStatement- 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 Modifier Constructor Description protectedAbstractSelectStatement(AbstractExpression parent)Creates a newAbstractSelectStatement.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description 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 abstract AbstractFromClausebuildFromClause()Creates the expression representing the from clause of this select statement.protected abstract AbstractSelectClausebuildSelectClause()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.ExpressiongetFromClause()Returns theExpressionrepresenting the FROM clause.ExpressiongetGroupByClause()Returns theExpressionrepresenting the GROUP BY clause.ExpressiongetHavingClause()Returns theExpressionrepresenting the HAVING clause.ExpressiongetSelectClause()Returns theAbstractSelectClauserepresenting the SELECT clause.ExpressiongetWhereClause()Returns theExpressionrepresenting the WHERE clause.booleanhasFromClause()Determines whether the FROM clause was parsed or not.booleanhasGroupByClause()Determines whether the GROUP BY clause was parsed or not.booleanhasHavingClause()Determines whether the HAVING clause was parsed or not.booleanhasSelectClause()Determines whether the SELECT clause was parsed or not.booleanhasSpaceAfterFrom()Determines whether a whitespace was found after the FROM clause.booleanhasSpaceAfterGroupBy()Determines whether a whitespace was found after the GROUP BY clause.booleanhasSpaceAfterSelect()Determines whether a whitespace was found after the SELECT clause.booleanhasSpaceAfterWhere()Determines whether a whitespace was found after the WHERE clause.booleanhasWhereClause()Determines whether the WHERE clause is defined.protected voidparse(WordParser wordParser, boolean tolerant)Parses the query by starting at the current position, which is part of the givenWordParser.protected booleanshouldManageSpaceAfterClause()Determines whether the whitespace following theHAVINGclause should be managed by this expression or not.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.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, isParsingComplete, isTolerant, isUnknown, isVirtual, orderedChildren, parse, parseUsingExpressionFactory, populatePosition, rebuildActualText, rebuildParsedText, setParent, setText, shouldParseWithFactoryFirst, shouldSkipLiteral, toActualText, toParsedText, toString
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.eclipse.persistence.jpa.jpql.parser.Expression
accept, getQueryBNF
-
-
-
-
Constructor Detail
-
AbstractSelectStatement
protected AbstractSelectStatement(AbstractExpression parent)
Creates a newAbstractSelectStatement.- Parameters:
parent- The parent of this expression
-
-
Method Detail
-
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.- 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 classAbstractExpression- 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 classAbstractExpression- Parameters:
children- The list used to store the string representation of thisAbstractExpression
-
buildFromClause
protected abstract AbstractFromClause buildFromClause()
Creates the expression representing the from clause of this select statement.- Returns:
- A new from clause,
nullcan't be returned
-
buildSelectClause
protected abstract AbstractSelectClause buildSelectClause()
Creates the expression representing the select clause of this select statement.- 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 classAbstractExpression- Parameters:
expression- TheExpressionthat is a descendant of this one- Returns:
- The
JPQLQueryBNFthat was used to parse the given expression
-
getFromClause
public final Expression getFromClause()
Returns theExpressionrepresenting the FROM clause.- Returns:
- The expression representing the FROM clause
-
getGroupByClause
public final Expression getGroupByClause()
Returns theExpressionrepresenting the GROUP BY clause.- Returns:
- The expression representing the GROUP BY clause
-
getHavingClause
public final Expression getHavingClause()
Returns theExpressionrepresenting the HAVING clause.- Returns:
- The expression representing the HAVING clause
-
getSelectClause
public final Expression getSelectClause()
Returns theAbstractSelectClauserepresenting the SELECT clause.- Returns:
- The expression representing the SELECT clause
-
getWhereClause
public final Expression getWhereClause()
Returns theExpressionrepresenting the WHERE clause.- Returns:
- The expression representing the WHERE clause
-
hasFromClause
public final boolean hasFromClause()
Determines whether the FROM clause was parsed or not.- Returns:
trueif the query that got parsed had the FROM clause
-
hasGroupByClause
public final boolean hasGroupByClause()
Determines whether the GROUP BY clause was parsed or not.- Returns:
trueif the query that got parsed had the GROUP BY clause
-
hasHavingClause
public final boolean hasHavingClause()
Determines whether the HAVING clause was parsed or not.- Returns:
trueif the query that got parsed had the HAVING clause
-
hasSelectClause
public final boolean hasSelectClause()
Determines whether the SELECT clause was parsed or not.- Returns:
trueif the query that got parsed had the HAVING clause- Since:
- 2.5
-
hasSpaceAfterFrom
public final boolean hasSpaceAfterFrom()
Determines whether a whitespace was found after the FROM clause. In some cases, the space is owned by a child of the FROM clause.- Returns:
trueif there was a whitespace after the FROM clause and owned by this expression;falseotherwise
-
hasSpaceAfterGroupBy
public final boolean hasSpaceAfterGroupBy()
Determines whether a whitespace was found after the GROUP BY clause. In some cases, the space is owned by a child of the GROUP BY clause.- Returns:
trueif there was a whitespace after the GROUP BY clause and owned by this expression;falseotherwise
-
hasSpaceAfterSelect
public final boolean hasSpaceAfterSelect()
Determines whether a whitespace was found after the SELECT clause. In some cases, the space is owned by a child of the SELECT clause.- Returns:
trueif there was a whitespace after the SELECT clause and owned by this expression;falseotherwise
-
hasSpaceAfterWhere
public final boolean hasSpaceAfterWhere()
Determines whether a whitespace was found after the WHERE clause. In some cases, the space is owned by a child of the WHERE clause.- Returns:
trueif there was a whitespace after the WHERE clause and owned by this expression;falseotherwise
-
hasWhereClause
public final boolean hasWhereClause()
Determines whether the WHERE clause is defined.- Returns:
trueif the query that got parsed had the WHERE clause
-
parse
protected void parse(WordParser wordParser, boolean tolerant)
Parses the query by starting at the current position, which is part of the givenWordParser.- Specified by:
parsein classAbstractExpression- 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
-
shouldManageSpaceAfterClause
protected boolean shouldManageSpaceAfterClause()
Determines whether the whitespace following theHAVINGclause should be managed by this expression or not.- Returns:
trueby default to keep the whitespace part of this expression;falseto let the parent handle it
-
toParsedText
protected void toParsedText(java.lang.StringBuilder writer, boolean actual)Generates a string representation of thisExpression, including its children, if it has any.- Specified by:
toParsedTextin classAbstractExpression- 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
-
-