public abstract class AbstractFromClause extends AbstractExpression
FromClause,
SimpleFromClauseCOMMA, DOT, DOUBLE_QUOTE, LEFT_CURLY_BRACKET, LEFT_PARENTHESIS, NOT_DEFINED, RIGHT_CURLY_BRACKET, RIGHT_PARENTHESIS, SINGLE_QUOTE, SPACE, UNDERSCOREABS, 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| Modifier | Constructor and Description |
|---|---|
protected |
AbstractFromClause(AbstractExpression parent)
Creates a new
AbstractFromClause. |
| Modifier and Type | Method and Description |
|---|---|
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. |
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, shouldSkipLiteral, toActualText, toParsedText, toStringclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitaccept, getQueryBNFprotected AbstractFromClause(AbstractExpression parent)
AbstractFromClause.parent - The parent of this expressionpublic 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 oneJPQLQueryBNF 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 otherwiseprotected 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 parsedtrue if the text no longer can't be parsed by the current expression;
false if more can be parsedprotected 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 backprotected 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