Class CollectionExpression
- java.lang.Object
-
- org.eclipse.persistence.jpa.jpql.parser.AbstractExpression
-
- org.eclipse.persistence.jpa.jpql.parser.CollectionExpression
-
- All Implemented Interfaces:
Expression
public final class CollectionExpression extends AbstractExpression
ACollectionExpressionwraps many expression which they are separated by spaces and/or commas.BNF:expression ::= child_item {, child_item }*
or
BNF:expression ::= child_item { child_item }*- Version:
- 2.5
- Author:
- Pascal Filion
- Since:
- 2.3
-
-
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
-
Fields inherited from interface org.eclipse.persistence.jpa.jpql.parser.Expression
ABS, 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
-
-
Constructor Summary
Constructors Constructor Description CollectionExpression(AbstractExpression parent, java.util.List<AbstractExpression> children, java.util.List<java.lang.Boolean> commas, java.util.List<java.lang.Boolean> spaces)Creates a newCollectionExpression.CollectionExpression(AbstractExpression parent, java.util.List<AbstractExpression> children, java.util.List<java.lang.Boolean> commas, java.util.List<java.lang.Boolean> spaces, boolean temporary)Creates a newCollectionExpression.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(int index, ExpressionVisitor visitor)Visits the childExpressionat the given position by the givenvisitor.voidaccept(ExpressionVisitor visitor)Visits thisExpressionby the givenvisitor.voidacceptChildren(ExpressionVisitor visitor)Visits the children of thisExpression.protected voidaddChildrenTo(java.util.Collection<Expression> children)Adds the children of thisAbstractExpressionto the given collection.protected voidaddOrderedChildrenTo(java.util.List<Expression> children)Adds the children of thisAbstractExpressionto the given list.intchildrenSize()Returns the count of childexpressions.booleanendsWithComma()Determines whether thisCollectionExpressionends with a comma, which means the lastExpressionis a "null" expression.booleanendsWithSpace()Determines whether thisCollectionExpressionends with a space, which means the lastExpressionis a "null" expression.JPQLQueryBNFfindQueryBNF(Expression expression)Retrieves theJPQLQueryBNFthat represents the fragment of thisExpressionthat was used when parsing the givenExpression.ExpressiongetChild(int index)Retrieves the childExpressionat the given position.JPQLQueryBNFgetQueryBNF()Returns the BNF of thisExpression.booleanhasComma(int index)Determines whether a comma was parsed at the given position.booleanhasSpace(int index)Determines whether a space was parsed at the given position.intindexOf(Expression expression)Retrieves the index of the givenExpression.protected voidparse(WordParser wordParser, boolean tolerant)Parses the query by starting at the current position, which is part of the givenWordParser.java.lang.StringtoActualText(int endIndex)Returns a string representation of thisExpressionand its children.java.lang.StringtoParsedText(int endIndex)Generates a string representation of thisCollectionExpression.protected voidtoParsedText(java.lang.StringBuilder writer, boolean actual)Generates a string representation of thisExpression, including its children, if it has any.-
Methods inherited from class org.eclipse.persistence.jpa.jpql.parser.AbstractExpression
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, isParsingComplete, isTolerant, isUnknown, isVirtual, orderedChildren, parse, parseUsingExpressionFactory, populatePosition, rebuildActualText, rebuildParsedText, setParent, setText, shouldParseWithFactoryFirst, shouldSkipLiteral, toActualText, toParsedText, toString
-
-
-
-
Constructor Detail
-
CollectionExpression
public CollectionExpression(AbstractExpression parent, java.util.List<AbstractExpression> children, java.util.List<java.lang.Boolean> commas, java.util.List<java.lang.Boolean> spaces)
Creates a newCollectionExpression.- Parameters:
parent- The parent of this expressionchildren- The list of children that are regrouped togetherspaces- The list of flags used to determine when to add a space after anExpressioncommas- The list of flags used to determine when to add a comma after anExpression
-
CollectionExpression
public CollectionExpression(AbstractExpression parent, java.util.List<AbstractExpression> children, java.util.List<java.lang.Boolean> commas, java.util.List<java.lang.Boolean> spaces, boolean temporary)
Creates a newCollectionExpression.- Parameters:
parent- The parent of this expressionchildren- The list of children that are regrouped togethercommas- The list of flags used to determine when to add a comma after anExpressionspaces- The list of flags used to determine when to add a space after anExpressiontemporary- Flag used to determine if this expression is temporarily used, which means the children will not be parented to this object
-
-
Method Detail
-
accept
public void accept(ExpressionVisitor visitor)
Visits thisExpressionby the givenvisitor.- Parameters:
visitor- TheExpressionVisitorto visit this object
-
accept
public void accept(int index, ExpressionVisitor visitor)Visits the childExpressionat the given position by the givenvisitor.- Parameters:
index- The index of the child to visitvisitor- TheExpressionVisitorto visit a specific child- Since:
- 2.4
-
acceptChildren
public void acceptChildren(ExpressionVisitor visitor)
Visits the children of thisExpression. This method can be used to optimize traversing the children since a new list is not created every timeExpression.children()is called.This does not traverse the
Expressionsub-hierarchy, use a subclass ofAbstractTraverseChildrenVisitorin order to traverse the entire sub-hierarchy.- Parameters:
visitor- Thevisitorto visit the children of this object.
-
addChildrenTo
protected void addChildrenTo(java.util.Collection<Expression> children)
Adds the children of thisAbstractExpressionto the given collection.- Overrides:
addChildrenToin classAbstractExpression- Parameters:
children- The collection used to store the children
-
addOrderedChildrenTo
protected void addOrderedChildrenTo(java.util.List<Expression> children)
Adds the children of thisAbstractExpressionto the given list.- Overrides:
addOrderedChildrenToin classAbstractExpression- Parameters:
children- The list used to store the string representation of thisAbstractExpression
-
childrenSize
public int childrenSize()
Returns the count of childexpressions.- Returns:
- The total count of
expressionsaggregated with spaces and/or commas
-
endsWithComma
public boolean endsWithComma()
Determines whether thisCollectionExpressionends with a comma, which means the lastExpressionis a "null" expression.- Returns:
trueif the string representation of thisCollectionExpressionends with a comma (the ending space is not checked)
-
endsWithSpace
public boolean endsWithSpace()
Determines whether thisCollectionExpressionends with a space, which means the lastExpressionis a "null" expression.- Returns:
trueif the string representation of thisCollectionExpressionends with a space (the ending comma is not checked)
-
findQueryBNF
public JPQLQueryBNF findQueryBNF(Expression expression)
Retrieves theJPQLQueryBNFthat represents the fragment of thisExpressionthat was used when parsing the givenExpression.- Specified by:
findQueryBNFin interfaceExpression- Overrides:
findQueryBNFin classAbstractExpression- Parameters:
expression- TheExpressionthat is a descendant of this one- Returns:
- The
JPQLQueryBNFthat was used to parse the given expression
-
getChild
public Expression getChild(int index)
Retrieves the childExpressionat the given position.- Parameters:
index- The position of the childExpressionto retrieve- Returns:
- The child
Expressionat the given position
-
getQueryBNF
public JPQLQueryBNF getQueryBNF()
Returns the BNF of thisExpression.- Returns:
- The
JPQLQueryBNF, which represents the grammar of thisExpression
-
hasComma
public boolean hasComma(int index)
Determines whether a comma was parsed at the given position. The index is the position of the comma that is following the child at the same position.- Parameters:
index- The index of the childExpressionto verify if there is a comma following it- Returns:
trueif a comma is following the childExpressionat the given index;falseotherwise
-
hasSpace
public boolean hasSpace(int index)
Determines whether a space was parsed at the given position. The index is the position of the space that is following the child at the same position, which is after a comma, if one was also parsed at that location.- Parameters:
index- The index of the childExpressionto verify if there is a space following it, which could be after a comma, if one was parsed- Returns:
trueif a space is following the childExpressionat the given index;falseotherwise
-
indexOf
public int indexOf(Expression expression)
Retrieves the index of the givenExpression.- Parameters:
expression- TheExpressionthat might be a child of this expression- Returns:
- The index in the collection of the given
Expressionor -1 if it is not a child
-
parse
protected void parse(WordParser wordParser, boolean tolerant)
Parses the query by starting at the current position, which is part of the givenWordParser.- Specified by:
parsein classAbstractExpression- Parameters:
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 queries
-
toActualText
public java.lang.String toActualText(int endIndex)
Returns a string representation of thisExpressionand its children. The expression should contain whitespace even if the beautified version would not have any. For instance, "SELECT e " should be returned whereExpression.toParsedText()would return "SELECT e".- Parameters:
endIndex- The index used to determine when to create the string representation, which is exclusive- Returns:
- The string representation of this
Expression
-
toParsedText
public java.lang.String toParsedText(int endIndex)
Generates a string representation of thisCollectionExpression.- Parameters:
endIndex- The index used to determine when to create the string representation, which is exclusive- Returns:
- The string representation of this
Expression
-
toParsedText
protected void toParsedText(java.lang.StringBuilder writer, boolean actual)Generates a string representation of thisExpression, including its children, if it has any.- Specified by:
toParsedTextin classAbstractExpression- Parameters:
writer- The buffer used to append thisExpression'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
-
-