EclipseLink 2.4.2, build 'v20130514-5956486' API Reference

org.eclipse.persistence.jpa.jpql.parser
Class InExpression

java.lang.Object
  extended by org.eclipse.persistence.jpa.jpql.parser.AbstractExpression
      extended by org.eclipse.persistence.jpa.jpql.parser.InExpression
All Implemented Interfaces:
Expression

public final class InExpression
extends AbstractExpression

The state field path expression must have a string, numeric, or enum value. The literal and/or input parameter values must be like the same abstract schema type of the state field path expression in type.

The results of the subquery must be like the same abstract schema type of the state field path expression in type.

There must be at least one element in the comma separated list that defines the set of values for the IN expression. If the value of a state field path expression in an IN or NOT IN expression is NULL or unknown, the value of the expression is unknown.

JPA 1.0:

BNF: in_expression ::= state_field_path_expression [NOT] IN(in_item {, in_item}* | subquery)

JPA 2.0

BNF: in_expression ::= {state_field_path_expression | type_discriminator} [NOT] IN { ( in_item {, in_item}* ) | (subquery) | collection_valued_input_parameter }

Example: SELECT c FROM Customer c WHERE c.home.city IN :city

Example: SELECT p FROM Project p WHERE TYPE(p) IN(LargeProject, SmallProject)

Version:
2.4.2
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, ASC, AVG, BETWEEN, BIT_LENGTH, BOTH, CASE, CAST, CHAR_LENGTH, CHARACTER_LENGTH, CLASS, COALESCE, COLUMN, CONCAT, 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, 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, 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_FIRST, NULLS_LAST, OBJECT, OF, ON, OPERATOR, OR, ORDER_BY, OUTER, PLUS, POSITION, POSITIONAL_PARAMETER, QUOTE, REGEXP, SELECT, SET, SIZE, SOME, SQL, SQRT, SUBSTRING, SUM, TABLE, THEN, TRAILING, TREAT, TRIM, TRUE, TYPE, UNION, UNKNOWN, UPDATE, UPPER, VALUE, WHEN, WHERE
 
Constructor Summary
InExpression(AbstractExpression parent, AbstractExpression expression)
          Creates a new InExpression.
 
Method Summary
 void accept(ExpressionVisitor visitor)
          Visits this Expression by the given visitor.
 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.
 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 getActualInIdentifier()
          Returns the actual IN found in the string representation of the JPQL query, which has the actual case that was used.
 java.lang.String getActualNotIdentifier()
          Returns the actual NOT found in the string representation of the JPQL query, which has the actual case that was used.
 Expression getExpression()
          Returns the Expression that represents the state field path expression or type discriminator.
 java.lang.String getExpressionExpressionBNF()
          Returns the unique identifier of the query BNF that describes the expression being tested by the IN expression.
 java.lang.String getExpressionItemBNF()
          Returns the unique identifier of the query BNF that describes the items being tested against.
 java.lang.String getIdentifier()
          Returns the identifier for this expression.
 Expression getInItems()
          Returns the Expression that represents the list if items.
 JPQLQueryBNF getQueryBNF()
          Returns the BNF of this Expression.
 boolean hasExpression()
          Determines whether the state field path expression or type discriminator was parsed.
 boolean hasInItems()
          Determines whether the list of items was parsed.
 boolean hasLeftParenthesis()
          Determines whether the open parenthesis was parsed or not.
 boolean hasNot()
          Determines whether the identifier NOT was parsed.
 boolean hasRightParenthesis()
          Determines whether the close parenthesis was parsed or not.
 boolean hasSpaceAfterIn()
          Determines whether there was a whitespace after the IN identifier if the left parenthesis was not parsed.
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.
 boolean isSingleInputParameter()
          Determines whether what was parsed after the IN identifier is a single input parameter:
BNF: in_expression ::= {state_field_path_expression | type_discriminator} [NOT] IN collection_valued_input_parameter
protected  void parse(WordParser wordParser, boolean tolerant)
          Parses the query by starting at the current position, which is part of the given WordParser.
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 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, isTolerant, isUnknown, isVirtual, orderedChildren, parse, parseUsingExpressionFactory, populatePosition, 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
 

Constructor Detail

InExpression

public InExpression(AbstractExpression parent,
                    AbstractExpression expression)
Creates a new InExpression.

Parameters:
parent - The parent of this expression
expression - The state field path expression that was parsed prior of parsing this expression
Method Detail

accept

public void accept(ExpressionVisitor visitor)
Visits this Expression by the given visitor.

Parameters:
visitor - The ExpressionVisitor to visit this object

acceptChildren

public void acceptChildren(ExpressionVisitor visitor)
Visits the children of this 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.

Parameters:
visitor - The visitor to visit the children of this object.

addChildrenTo

protected void addChildrenTo(java.util.Collection<Expression> children)
Adds the children of this AbstractExpression to the given collection.

Overrides:
addChildrenTo in class AbstractExpression
Parameters:
children - The collection used to store the children

addOrderedChildrenTo

protected void addOrderedChildrenTo(java.util.List<Expression> children)
Adds the children of this AbstractExpression to the given list.

Overrides:
addOrderedChildrenTo in class AbstractExpression
Parameters:
children - The list used to store the string representation of this AbstractExpression

findQueryBNF

public JPQLQueryBNF findQueryBNF(Expression expression)
Retrieves the JPQLQueryBNF that represents the fragment of this Expression that was used when parsing the given Expression.

Specified by:
findQueryBNF in interface Expression
Overrides:
findQueryBNF in class AbstractExpression
Parameters:
expression - The Expression that is a descendant of this one
Returns:
The JPQLQueryBNF that was used to parse the given expression

getActualInIdentifier

public java.lang.String getActualInIdentifier()
Returns the actual IN found in the string representation of the JPQL query, which has the actual case that was used.

Returns:
The IN identifier that was actually parsed

getActualNotIdentifier

public java.lang.String getActualNotIdentifier()
Returns the actual NOT found in the string representation of the JPQL query, which has the actual case that was used.

Returns:
The NOT identifier that was actually parsed, or an empty string if it was not parsed

getExpression

public Expression getExpression()
Returns the Expression that represents the state field path expression or type discriminator.

Returns:
The expression that was parsed representing the state field path expression or the type discriminator

getExpressionExpressionBNF

public java.lang.String getExpressionExpressionBNF()
Returns the unique identifier of the query BNF that describes the expression being tested by the IN expression.

Returns:
InExpressionExpressionBNF.ID

getExpressionItemBNF

public java.lang.String getExpressionItemBNF()
Returns the unique identifier of the query BNF that describes the items being tested against.

Returns:
InExpressionItemBNF.ID

getIdentifier

public java.lang.String getIdentifier()
Returns the identifier for this expression.

Returns:
Either IS IN or IN

getInItems

public Expression getInItems()
Returns the Expression that represents the list if items.

Returns:
The expression that was parsed representing the list of items

getQueryBNF

public JPQLQueryBNF getQueryBNF()
Returns the BNF of this Expression.

Returns:
The JPQLQueryBNF, which represents the grammar of this Expression

hasExpression

public boolean hasExpression()
Determines whether the state field path expression or type discriminator was parsed.

Returns:
true if the state field path expression or type discriminator was parsed; false if it was not parsed

hasInItems

public boolean hasInItems()
Determines whether the list of items was parsed.

Returns:
true if at least one item was parsed; false otherwise

hasLeftParenthesis

public boolean hasLeftParenthesis()
Determines whether the open parenthesis was parsed or not.

Returns:
true if the open parenthesis was present in the string version of the query; false otherwise

hasNot

public boolean hasNot()
Determines whether the identifier NOT was parsed.

Returns:
true if the identifier NOT was parsed; false otherwise

hasRightParenthesis

public boolean hasRightParenthesis()
Determines whether the close parenthesis was parsed or not.

Returns:
true if the close parenthesis was present in the string version of the query; false otherwise

hasSpaceAfterIn

public boolean hasSpaceAfterIn()
Determines whether there was a whitespace after the IN identifier if the left parenthesis was not parsed.

Returns:
true if a whitespace was parsed after IN in the string version of the query; false otherwise
Since:
2.4

isParsingComplete

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. The text is never empty.

Overrides:
isParsingComplete in class AbstractExpression
Parameters:
wordParser - The text to parse based on the current position of the cursor
word - The word that was retrieved from the given text, which is the first word in the text
expression - The Expression that has already been parsed
Returns:
true if the text no longer can't be parsed by the current expression; false if more can be parsed

isSingleInputParameter

public boolean isSingleInputParameter()
Determines whether what was parsed after the IN identifier is a single input parameter:
BNF: in_expression ::= {state_field_path_expression | type_discriminator} [NOT] IN collection_valued_input_parameter

Returns:
true if what is following the IN identifier is a single input parameter (without the left or right parenthesis); false otherwise
Since:
2.4

parse

protected void parse(WordParser wordParser,
                     boolean tolerant)
Parses the query by starting at the current position, which is part of the given WordParser.

Specified by:
parse in class AbstractExpression
Parameters:
wordParser - The text to parse based on the current position of the cursor
tolerant - Determines whether the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries

toParsedText

protected void toParsedText(java.lang.StringBuilder writer,
                            boolean actual)
Generates a string representation of this Expression, including its children, if it has any.

Specified by:
toParsedText in class AbstractExpression
Parameters:
writer - The buffer used to append this Expression's string representation
actual - 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.4.2, build 'v20130514-5956486' API Reference