|
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.ConstructorExpression
public final class ConstructorExpression
In the SELECT clause a constructor may be used in the SELECT list to return one or more Java instances. The specified class is not required to be an entity or to be mapped to the database. The constructor name must be fully qualified.
constructor_expression ::= NEW constructor_name(constructor_item {, constructor_item}*)
Field Summary | |
---|---|
private java.lang.String |
className The fully qualified class name of this expression. |
private AbstractExpression |
constructorItems The list of constructor items. |
private boolean |
hasLeftParenthesis Flag used to determine if the closing parenthesis is present in the query. |
private boolean |
hasRightParenthesis Flag used to determine if the opening parenthesis is present in the query. |
private boolean |
hasSpaceAfterConstructorName When the expression is not valid and the left parenthesis is missing, then a space might have been parsed. |
private boolean |
hasSpaceAfterNew Determines whether there is a whitespace after the identifier NEW. |
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 | |
---|---|
ConstructorExpression(AbstractExpression parent) Creates a new ConstructorExpression . |
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. |
(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 constructor item. |
java.lang.String |
getClassName() Returns the fully qualified class name that will be used to retrieve the constructor. |
Expression |
getConstructorItems() Returns the constructor items aggregated into a single expression and separated by commas or a single expression. |
JPQLQueryBNF |
getQueryBNF() Returns the BNF of this Expression . |
boolean |
hasConstructorItems() Determines whether the constructor items were parsed. |
boolean |
hasLeftParenthesis() Determines whether the open parenthesis was parsed or not. |
boolean |
hasRightParenthesis() Determines whether the close parenthesis was parsed or not. |
boolean |
hasSpaceAfterNew() Determines whether a whitespace was parsed after NEW. |
(package private) 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. |
(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.AbstractExpression |
---|
buildExpressionFromFallingBack, buildNullExpression, buildStringExpression, buildStringExpression, buildUnknownExpression, children, expressionFactory, expressionFactoryForIdentifier, findQueryBNF, getChildren, getJPAVersion, getParent, getRoot, getText, handleAggregate, identifierRole, identifiers, identifiers, identifierVersion, isAncestor, isIdentifier, isNull, 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 java.lang.String className
private AbstractExpression constructorItems
private boolean hasLeftParenthesis
private boolean hasRightParenthesis
private boolean hasSpaceAfterConstructorName
private boolean hasSpaceAfterNew
Constructor Detail |
---|
ConstructorExpression(AbstractExpression parent)
ConstructorExpression
.
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.
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 AbstractExpression
children
- The collection used to store the childrenvoid 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 CollectionExpression buildCollectionExpression()
CollectionExpression
that will wrap the single constructor item.public java.lang.String getClassName()
public Expression getConstructorItems()
null
" expressionpublic JPQLQueryBNF getQueryBNF()
Expression
.getQueryBNF
in class AbstractExpression
JPQLQueryBNF
, which represents the grammar of this Expression
public boolean hasConstructorItems()
true
if the query had at least one constructor item; false
otherwisepublic boolean hasLeftParenthesis()
true
if the open parenthesis was present in the string version of the query; false
otherwisepublic boolean hasRightParenthesis()
true
if the close parenthesis was present in the string version of the query; false
otherwisepublic boolean hasSpaceAfterNew()
true
if there was a whitespace after NEW; false
otherwiseboolean isParsingComplete(WordParser wordParser, java.lang.String word, Expression expression)
isParsingComplete
in class AbstractExpression
wordParser
- 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 parsedvoid 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 queriesvoid 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 |