|
EclipseLink 2.5.0, build 'v20130507-3faac2b' API Reference | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.eclipse.persistence.jpa.jpql.parser.AbstractExpression
org.eclipse.persistence.jpa.jpql.parser.AbstractFromClause
public abstract class AbstractFromClause
The FROM clause of a query defines the domain of the query by declaring identification variables. An identification variable is an identifier declared in the FROM clause of a query. The domain of the query may be constrained by path expressions. Identification variables designate instances of a particular entity abstract schema type. The FROM clause can contain multiple identification variable declarations separated by a comma (,).
FromClause,
SimpleFromClause| 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 |
| Constructor Summary | |
|---|---|
protected |
AbstractFromClause(AbstractExpression parent)
Creates a new AbstractFromClause. |
| Method Summary | |
|---|---|
void |
acceptChildren(ExpressionVisitor visitor)
Visits the children of this Expression. |
protected void |
addChildrenTo(java.util.Collection<Expression> children)
Adds the children of this AbstractExpression to the given collection. |
protected void |
addOrderedChildrenTo(java.util.List<Expression> children)
Adds the children of this AbstractExpression to the given list. |
CollectionExpression |
buildCollectionExpression()
Creates a new CollectionExpression that will wrap the single declaration. |
JPQLQueryBNF |
findQueryBNF(Expression expression)
Retrieves the JPQLQueryBNF that represents the fragment of this Expression
that was used when parsing the given Expression. |
java.lang.String |
getActualIdentifier()
Returns the actual FROM identifier found in the string representation of the JPQL query, which has the actual case that was used. |
Expression |
getAsOfClause()
Returns the Expression representing the AS OF clause. |
Expression |
getDeclaration()
Returns the Expression that represents the declaration of this clause. |
abstract java.lang.String |
getDeclarationQueryBNFId()
Returns the BNF of the declaration part of this clause. |
Expression |
getHierarchicalQueryClause()
Returns the Expression representing the hierarchical query clause. |
boolean |
hasAsOfClause()
Determines whether the AS OF clause is defined. |
boolean |
hasDeclaration()
Determines whether the declaration of this clause was parsed. |
boolean |
hasHierarchicalQueryClause()
Determines whether the hierarchical query clause was parsed or not. |
boolean |
hasSpaceAfterDeclaration()
Determines whether a whitespace was found after the declaration query clause, which will be true if it's followed by either the hierarchical query clause or the AS
OF clause. |
boolean |
hasSpaceAfterFrom()
Determines whether a whitespace was parsed after the FROM identifier. |
boolean |
hasSpaceAfterHierarchicalQueryClause()
Determines whether a whitespace was found after the hierarchical query clause. |
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. |
protected void |
parse(WordParser wordParser,
boolean tolerant)
Parses the query by starting at the current position, which is part of the given WordParser. |
protected boolean |
shouldParseWithFactoryFirst()
Determines whether the parsing of the query should be performed using the factories first or it should automatically fallback to the fallback factory. |
protected void |
toParsedText(java.lang.StringBuilder writer,
boolean actual)
Generates a string representation of this Expression, including its children,
if it has any. |
| 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 |
|---|
protected AbstractFromClause(AbstractExpression parent)
AbstractFromClause.
parent - The parent of this expression| Method Detail |
|---|
public 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() is called.
This does not traverse the Expression sub-hierarchy, use a subclass of
AbstractTraverseChildrenVisitor in order to traverse the entire sub-hierarchy.
visitor - The visitor to visit the children of this object.protected void addChildrenTo(java.util.Collection<Expression> children)
AbstractExpression to the given collection.
addChildrenTo in class AbstractExpressionchildren - The collection used to store the childrenprotected void addOrderedChildrenTo(java.util.List<Expression> children)
AbstractExpression to the given list.
addOrderedChildrenTo in class AbstractExpressionchildren - The list used to store the string representation of this AbstractExpressionpublic final CollectionExpression buildCollectionExpression()
CollectionExpression that will wrap the single declaration.
public final JPQLQueryBNF findQueryBNF(Expression expression)
JPQLQueryBNF that represents the fragment of this Expression
that was used when parsing the given Expression.
findQueryBNF in interface ExpressionfindQueryBNF in class AbstractExpressionexpression - The Expression that is a descendant of this one
JPQLQueryBNF that was used to parse the given expressionpublic final java.lang.String getActualIdentifier()
public final Expression getAsOfClause()
Expression representing the AS OF clause.
public final Expression getDeclaration()
Expression that represents the declaration of this clause.
public abstract java.lang.String getDeclarationQueryBNFId()
public final Expression getHierarchicalQueryClause()
Expression representing the hierarchical query clause.
public final boolean hasAsOfClause()
true if the query that got parsed had the AS OF clausepublic final boolean hasDeclaration()
true if the declaration of this clause was parsed; false if
it was not parsedpublic final boolean hasHierarchicalQueryClause()
true if the query that got parsed had the hierarchical query clausepublic final boolean hasSpaceAfterDeclaration()
true if it's followed by either the hierarchical query clause or the AS
OF clause.
true if there was a whitespace after the declaration; false otherwisepublic final boolean hasSpaceAfterFrom()
true if a whitespace was parsed after the FROM identifier;
false otherwisepublic final boolean hasSpaceAfterHierarchicalQueryClause()
true if there was a whitespace after the hierarchical query clause and
owned by this expression; false otherwise
protected boolean isParsingComplete(WordParser wordParser,
java.lang.String word,
Expression expression)
isParsingComplete in class AbstractExpressionwordParser - 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 - The Expression that has already been parsed
true if the text no longer can't be parsed by the current expression;
false if more can be parsed
protected void parse(WordParser wordParser,
boolean tolerant)
WordParser.
parse in class AbstractExpressionwordParser - 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 queriesprotected boolean shouldParseWithFactoryFirst()
factories first or it should automatically fallback to the fallback factory.
shouldParseWithFactoryFirst in class AbstractExpressiontrue is returned by default so the factories are used before falling back
protected void toParsedText(java.lang.StringBuilder writer,
boolean actual)
Expression, including its children,
if it has any.
toParsedText in class AbstractExpressionwriter - The buffer used to append this Expression'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
|
EclipseLink 2.5.0, build 'v20130507-3faac2b' API Reference | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||