|
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.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 | |
---|---|
private AbstractExpression |
declaration The declaration portion of this FROM clause. |
private boolean |
hasSpace Determines whether a whitespace was parsed after the identifier FROM. |
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 | |
---|---|
AbstractFromClause(AbstractExpression parent) Creates a new AbstractFromClause . |
Method Summary | |
---|---|
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. |
(package private) void |
addOrderedChildrenTo(java.util.List<StringExpression> children) Adds the StringExpressions representing this Expression . |
CollectionExpression |
buildCollectionExpression() Creates a new CollectionExpression that will wrap the single declaration. |
abstract JPQLQueryBNF |
declarationBNF() Returns the BNF of the declaration part of this clause. |
Expression |
getDeclaration() Returns the Expression that represents the declaration of this clause. |
boolean |
hasDeclaration() Determines whether the declaration of this clause was parsed. |
boolean |
hasSpaceAfterFrom() Determines whether a whitespace was parsed after the FROM identifier. |
(package private) void |
parse(WordParser wordParser, boolean tolerant) Parses the query by starting at the current position, which is part of the given WordParser . |
private AbstractExpression |
parseDeclaration(WordParser wordParser) Parses the declaration in the most optimized way possible. |
void |
setIdentificationVariableDeclaration(java.lang.String abstractSchemaName, java.lang.String identificationVariable) Manually sets the identification variable declaration. |
(package private) boolean |
shouldParseWithFactoryFirst() TODO |
(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.AbstractExpression |
---|
buildExpressionFromFallingBack, buildNullExpression, buildStringExpression, buildStringExpression, buildUnknownExpression, children, expressionFactory, expressionFactoryForIdentifier, findQueryBNF, getChildren, getJPAVersion, getParent, getQueryBNF, getRoot, getText, handleAggregate, identifierRole, identifiers, identifiers, identifierVersion, isAncestor, isIdentifier, isNull, isParsingComplete, isTolerant, isUnknown, isVirtual, orderedChildren, parse, parseSingleExpression, populatePosition, queryBNF, readdLeadingSpaces, rebuildActualText, rebuildParsedText, setParent, setText, 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.internal.jpql.parser.Expression |
---|
accept |
Field Detail |
---|
private AbstractExpression declaration
private boolean hasSpace
Constructor Detail |
---|
AbstractFromClause(AbstractExpression parent)
AbstractFromClause
.
parent
- The parent of this expressionMethod 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()
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.
visitor
- The visitor
to visit the children of this object.final void addChildrenTo(java.util.Collection<Expression> children)
Expression
to the given collection.addChildrenTo
in class AbstractExpression
children
- The collection used to store the childrenfinal void addOrderedChildrenTo(java.util.List<StringExpression> children)
StringExpressions
representing this Expression
.addOrderedChildrenTo
in class AbstractExpression
children
- The list used to store the string representation of this Expression
public final CollectionExpression buildCollectionExpression()
CollectionExpression
that will wrap the single declaration.public abstract JPQLQueryBNF declarationBNF()
public final Expression getDeclaration()
Expression
that represents the declaration of this clause.public final boolean hasDeclaration()
true
if the declaration of this clause was parsed; false
if it was not parsedpublic final boolean hasSpaceAfterFrom()
true
if a whitespace was parsed after the FROM identifier; false
otherwisefinal void parse(WordParser wordParser, boolean tolerant)
WordParser
.parse
in class AbstractExpression
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 queriesprivate AbstractExpression parseDeclaration(WordParser wordParser)
wordParser
- The text to parse based on the current position of the cursorpublic final void setIdentificationVariableDeclaration(java.lang.String abstractSchemaName, java.lang.String identificationVariable)
abstractSchemaName
- The abstract schema name to be mapped to the given variableidentificationVariable
- The identification variable mapping the given schema nameboolean shouldParseWithFactoryFirst()
shouldParseWithFactoryFirst
in class AbstractExpression
final void toParsedText(java.lang.StringBuilder writer, boolean includeVirtual)
Expression
.toParsedText
in class AbstractExpression
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 |