|
Oracle Fusion Middleware Java API Reference for Oracle TopLink 11g Release 1 (11.1.1) E28847-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
org.eclipse.persistence.jpa.internal.jpql.parser.StringExpression
org.eclipse.persistence.jpa.internal.jpql.parser.AbstractExpression
org.eclipse.persistence.jpa.internal.jpql.parser.AbstractSelectStatement
org.eclipse.persistence.jpa.internal.jpql.parser.SelectStatement
public final class SelectStatement
A select statement must always have a SELECT and a FROM clause.
select_statement ::= select_clause from_clause [where_clause] [groupby_clause] [having_clause] [orderby_clause]
SelectClause
Field Summary | |
---|---|
private boolean |
hasSpaceBeforeOrderBy Determines whether there is a whitespace after the select statement parsed by the superclass and the ORDER BY identifier. |
private AbstractExpression |
orderByClause The ORDER BY expression. |
Fields inherited from class org.eclipse.persistence.jpa.internal.jpql.parser.AbstractExpression |
---|
COMMA, DOT, DOUBLE_QUOTE, LEFT_CURLY_BRACKET, LEFT_PARENTHESIS, NOT_DEFINED, RIGHT_CURLY_BRACKET, RIGHT_PARENTHESIS, SINGLE_QUOTE, SPACE, UNDERSCORE |
Constructor Summary | |
---|---|
SelectStatement(AbstractExpression parent) Creates a new SelectStatement . |
Method Summary | |
---|---|
void |
accept(ExpressionVisitor visitor) Visits this Expression by the given visitor . |
void |
acceptChildren(ExpressionVisitor visitor) Visits the children of this Expression . |
(package private) void |
addChildrenTo(java.util.Collection<Expression> children) Adds the children of this Expression to the given collection. |
FromClause |
addFromClause() Manually adds the FROM clause to this SELECT statement. |
(package private) void |
addOrderedChildrenTo(java.util.List<StringExpression> children) Adds the StringExpressions representing this Expression . |
(package private) FromClause |
buildFromClause() Creates the expression representing the from clause of this select statement. |
(package private) SelectClause |
buildSelectClause() Creates the expression representing the select clause of this select statement. |
Expression |
getOrderByClause() Returns the Expression representing the ORDER BY clause. |
JPQLQueryBNF |
getQueryBNF() Returns the BNF of this Expression . |
SelectClause |
getSelectClause() Returns the AbstractSelectClause representing the SELECT clause. |
boolean |
hasOrderByClause() Determines whether the ORDER BY clause is defined. |
boolean |
hasSpaceBeforeOrderBy() Determines whether a whitespace was parsed before the ORDER BY clause. |
(package private) void |
parse(WordParser wordParser, boolean tolerant) Parses the query by starting at the current position, which is part of the given WordParser . |
(package private) void |
toParsedText(java.lang.StringBuilder writer, boolean includeVirtual) Generates a string representation of this Expression . |
Methods inherited from class org.eclipse.persistence.jpa.internal.jpql.parser.AbstractSelectStatement |
---|
addSelectClause, addWhereClause, getFromClause, getGroupByClause, getHavingClause, getWhereClause, hasFromClause, hasGroupByClause, hasHavingClause, hasSpaceAfterFrom, hasSpaceAfterGroupBy, hasSpaceAfterSelect, hasSpaceAfterWhere, hasWhereClause, shouldManageSpaceAfterClause |
Methods inherited from class org.eclipse.persistence.jpa.internal.jpql.parser.AbstractExpression |
---|
buildExpressionFromFallingBack, buildNullExpression, buildStringExpression, buildStringExpression, buildUnknownExpression, children, expressionFactory, expressionFactoryForIdentifier, findQueryBNF, getChildren, getJPAVersion, getParent, getRoot, getText, handleAggregate, identifierRole, identifiers, identifiers, identifierVersion, isAncestor, isIdentifier, isNull, isParsingComplete, isTolerant, isUnknown, isVirtual, orderedChildren, parse, parseSingleExpression, populatePosition, queryBNF, readdLeadingSpaces, 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 |
Field Detail |
---|
private boolean hasSpaceBeforeOrderBy
private AbstractExpression orderByClause
Constructor Detail |
---|
SelectStatement(AbstractExpression parent)
SelectStatement
.
parent
- The parent of this expressionMethod Detail |
---|
public void accept(ExpressionVisitor visitor)
Expression
by the given visitor
.visitor
- The visitor
to visit this objectpublic void acceptChildren(ExpressionVisitor visitor)
Expression
. This method can be used to optimize traversing the children since a new list is not created every time Expression.children()
or Expression.getChildren()
is called.
This does not traverse the Expression
sub-hierarchy, use an subclass of AbstractTraverseChildrenVisitor
in order to traverse the entire sub-hierarchy.
acceptChildren
in interface Expression
acceptChildren
in class AbstractSelectStatement
visitor
- The visitor
to visit the children of this object.void addChildrenTo(java.util.Collection<Expression> children)
Expression
to the given collection.addChildrenTo
in class AbstractSelectStatement
children
- The collection used to store the childrenpublic FromClause addFromClause()
addFromClause
in class AbstractSelectStatement
FROM clause
void addOrderedChildrenTo(java.util.List<StringExpression> children)
StringExpressions
representing this Expression
.addOrderedChildrenTo
in class AbstractSelectStatement
children
- The list used to store the string representation of this Expression
FromClause buildFromClause()
buildFromClause
in class AbstractSelectStatement
null
can't be returnedSelectClause buildSelectClause()
buildSelectClause
in class AbstractSelectStatement
null
can't be returnedpublic Expression getOrderByClause()
Expression
representing the ORDER BY clause.public JPQLQueryBNF getQueryBNF()
Expression
.getQueryBNF
in class AbstractExpression
JPQLQueryBNF
, which represents the grammar of this Expression
public SelectClause getSelectClause()
AbstractSelectClause
representing the SELECT clause.getSelectClause
in class AbstractSelectStatement
public boolean hasOrderByClause()
true
if the query that got parsed had the ORDER BY clausepublic boolean hasSpaceBeforeOrderBy()
true
if there was a whitespace before the ORDER BY; false
otherwisevoid parse(WordParser wordParser, boolean tolerant)
WordParser
.parse
in class AbstractSelectStatement
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 queriesvoid toParsedText(java.lang.StringBuilder writer, boolean includeVirtual)
Expression
.toParsedText
in class AbstractSelectStatement
writer
- The buffer used to append this Expression
's string representationincludeVirtual
- Determines whether to include any characters that are considered virtual, i.e. that was parsed when the query is incomplete and is needed for functionality like content assist
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |