Modifier and Type	Class and Description
private static class	EmptyCollectionComparisonExpression.StateFieldPathToCollectionValuedPathConverter This visitor converts a `StateFieldPathExpression` into a `CollectionValuedPathExpression`.

Modifier and Type	Field and Description
private String	emptyIdentifier The actual EMPTY identifier found in the string representation of the JPQL query.
private AbstractExpression	expression The `Expression` that represents the collection-valued path expression.
private boolean	hasSpaceAfterIs Determines whether a whitespace was parsed after IS.
private String	isIdentifier The actual IS identifier found in the string representation of the JPQL query.
private String	notIdentifier The actual IS identifier found in the string representation of the JPQL query.

Access	Constructor and Description
public	EmptyCollectionComparisonExpression(AbstractExpression The parent of this expression parent, AbstractExpression The `Expression` that represents the collection-valued path expression expression) Creates a new `NullComparisonExpression`.
pack-priv	EmptyCollectionComparisonExpression(AbstractExpression The parent of this expression parent, String The actual identifier, which is either `IS_EMPTY` or `IS_NOT_EMPTY` identifier, AbstractExpression The `Expression` that represents the collection-valued path expression expression) Creates a new `NullComparisonExpression`.

Method Summary

Modifier and Type	Method and Description
public void	accept(ExpressionVisitor The `ExpressionVisitor` to visit this object visitor) Implements org.eclipse.persistence.jpa.jpql.parser.Expression.accept. Visits this `Expression` by the given `visitor`.
public void	acceptChildren(ExpressionVisitor The `visitor` to visit the children of this object. visitor) Implements org.eclipse.persistence.jpa.jpql.parser.Expression.acceptChildren. Visits the children of this `Expression`.
protected void	addChildrenTo(Collection<Expression> The collection used to store the children children) Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.addChildrenTo. Adds the children of this `AbstractExpression` to the given collection.
protected void	addOrderedChildrenTo(List<Expression> The list used to store the string representation of this `AbstractExpression` children) Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.addOrderedChildrenTo. Adds the children of this `AbstractExpression` to the given list.
private EmptyCollectionComparisonExpression.StateFieldPathToCollectionValuedPathConverter	buildConverter(AbstractExpression expression)
public JPQLQueryBNF	findQueryBNF(Expression The `Expression` that is a descendant of this one expression) Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.findQueryBNF. Implements org.eclipse.persistence.jpa.jpql.parser.Expression.findQueryBNF. Retrieves the `JPQLQueryBNF` that represents the fragment of this `Expression` that was used when parsing the given `Expression`.
public String	Returns: The EMPTY identifier that was actually parsed getActualEmptyIdentifier() Returns the actual EMPTY found in the string representation of the JPQL query, which has the actual case that was used.
public String	Returns: The IS identifier that was actually parsed, or an empty string if it was not parsed getActualIsIdentifier() Returns the actual IS found in the string representation of the JPQL query, which has the actual case that was used.
public String	Returns: The NOT identifier that was actually parsed, or an empty string if it was not parsed getActualNotIdentifier() Returns the actual NOT found in the string representation of the JPQL query, which has the actual case that was used.
public Expression	Returns: The expression that was parsed representing the collection valued path expression getExpression() Returns the `Expression` that represents the collection-valued path expression if it was parsed.
public String	Returns: Either IS NOT EMPTY, NOT EMPTY, IS EMPTY or EMPTY getIdentifier() Returns the identifier for this expression that may include NOT if it was parsed.
public JPQLQueryBNF	getQueryBNF() Implements org.eclipse.persistence.jpa.jpql.parser.Expression.getQueryBNF. Returns the BNF of this `Expression`.
public boolean	Returns: `true` if the expression was parsed; `false` otherwise hasExpression() Determines whether the expression was parsed.
public boolean	Returns: `true` if the identifier NOT was parsed; `false` otherwise hasNot() Determines whether the identifier NOT was part of the query.
public boolean	Returns: `true` if there was a whitespace after IS; `false` otherwise hasSpaceAfterIs() Determines whether a whitespace was found after IS.
protected void	parse(WordParser The text to parse based on the current position of the cursor wordParser, boolean Determines whether the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries tolerant) Implements abstract org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.parse. Parses the query by starting at the current position, which is part of the given `WordParser`.
protected void	toParsedText(StringBuilder The buffer used to append this `Expression`'s string representation writer, boolean 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 actual) Implements abstract org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.toParsedText. Generates a string representation of this `Expression`, including its children, if it has any.
private void	updateExpression(AbstractExpression expression)

Field Detail

emptyIdentifier	back to summary
private String emptyIdentifier The actual EMPTY identifier found in the string representation of the JPQL query.

expression	back to summary
private AbstractExpression expression The `Expression` that represents the collection-valued path expression.

hasSpaceAfterIs	back to summary
private boolean hasSpaceAfterIs Determines whether a whitespace was parsed after IS.

isIdentifier	back to summary
private String isIdentifier The actual IS identifier found in the string representation of the JPQL query.

notIdentifier	back to summary
private String notIdentifier The actual IS identifier found in the string representation of the JPQL query.

Constructor Detail

EmptyCollectionComparisonExpression back to summary

EmptyCollectionComparisonExpression	back to summary
public EmptyCollectionComparisonExpression(AbstractExpression parent, AbstractExpression expression) Creates a new `NullComparisonExpression`. Parameters parent:AbstractExpression The parent of this expression expression:AbstractExpression The `Expression` that represents the collection-valued path expression

public EmptyCollectionComparisonExpression(AbstractExpression parent, AbstractExpression expression)

Creates a new NullComparisonExpression.

Parameters

parent:AbstractExpression: The parent of this expression
expression:AbstractExpression: The Expression that represents the collection-valued path expression

EmptyCollectionComparisonExpression back to summary

EmptyCollectionComparisonExpression	back to summary
pack-priv EmptyCollectionComparisonExpression(AbstractExpression parent, String identifier, AbstractExpression expression) Creates a new `NullComparisonExpression`. Parameters parent:AbstractExpression The parent of this expression identifier:String The actual identifier, which is either `IS_EMPTY` or `IS_NOT_EMPTY` expression:AbstractExpression The `Expression` that represents the collection-valued path expression

pack-priv EmptyCollectionComparisonExpression(AbstractExpression parent, String identifier, AbstractExpression expression)

Creates a new NullComparisonExpression.

Parameters

parent:AbstractExpression: The parent of this expression
identifier:String: The actual identifier, which is either IS_EMPTY or IS_NOT_EMPTY
expression:AbstractExpression: The Expression that represents the collection-valued path expression

Method Detail

accept back to summary

accept	back to summary
public void accept(ExpressionVisitor visitor) Implements org.eclipse.persistence.jpa.jpql.parser.Expression.accept. Doc from org.eclipse.persistence.jpa.jpql.parser.Expression.accept. Visits this `Expression` by the given `visitor`. Parameters visitor:ExpressionVisitor The `ExpressionVisitor` to visit this object Annotations @Override

public void accept(ExpressionVisitor visitor)

Implements org.eclipse.persistence.jpa.jpql.parser.Expression.accept.

Doc from org.eclipse.persistence.jpa.jpql.parser.Expression.accept.

Visits this Expression by the given visitor.

Parameters

visitor:ExpressionVisitor: The ExpressionVisitor to visit this object

Annotations

@Override

acceptChildren back to summary

acceptChildren	back to summary
public void acceptChildren(ExpressionVisitor visitor) Implements org.eclipse.persistence.jpa.jpql.parser.Expression.acceptChildren. Doc from org.eclipse.persistence.jpa.jpql.parser.Expression.acceptChildren. 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 `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:ExpressionVisitor The `visitor` to visit the children of this object. Annotations @Override

public void acceptChildren(ExpressionVisitor visitor)

Implements org.eclipse.persistence.jpa.jpql.parser.Expression.acceptChildren.

Doc from org.eclipse.persistence.jpa.jpql.parser.Expression.acceptChildren.

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 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:ExpressionVisitor: The visitor to visit the children of this object.

Annotations

@Override

addChildrenTo back to summary

addChildrenTo	back to summary
protected void addChildrenTo(Collection<Expression> children) Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.addChildrenTo. Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.addChildrenTo. Adds the children of this `AbstractExpression` to the given collection. Parameters children:Collection<Expression> The collection used to store the children Annotations @Override

protected void addChildrenTo(Collection<Expression> children)

Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.addChildrenTo.

Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.addChildrenTo.

Adds the children of this AbstractExpression to the given collection.

Parameters

children:Collection<Expression>: The collection used to store the children

Annotations

@Override

addOrderedChildrenTo back to summary

addOrderedChildrenTo	back to summary
protected void addOrderedChildrenTo(List<Expression> children) Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.addOrderedChildrenTo. Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.addOrderedChildrenTo. Adds the children of this `AbstractExpression` to the given list. Parameters children:List<Expression> The list used to store the string representation of this `AbstractExpression` Annotations @Override

protected void addOrderedChildrenTo(List<Expression> children)

Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.addOrderedChildrenTo.

Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.addOrderedChildrenTo.

Adds the children of this AbstractExpression to the given list.

Parameters

children:List<Expression>: The list used to store the string representation of this AbstractExpression

Annotations

@Override

buildConverter	back to summary
private EmptyCollectionComparisonExpression.StateFieldPathToCollectionValuedPathConverter buildConverter(AbstractExpression expression)

findQueryBNF back to summary

findQueryBNF	back to summary
public JPQLQueryBNF findQueryBNF(Expression expression) Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.findQueryBNF. Implements org.eclipse.persistence.jpa.jpql.parser.Expression.findQueryBNF. Doc from org.eclipse.persistence.jpa.jpql.parser.Expression.findQueryBNF. Retrieves the `JPQLQueryBNF` that represents the fragment of this `Expression` that was used when parsing the given `Expression`. Parameters expression:Expression The `Expression` that is a descendant of this one Returns:JPQLQueryBNF The `JPQLQueryBNF` that was used to parse the given expression Annotations @Override

public JPQLQueryBNF findQueryBNF(Expression expression)

Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.findQueryBNF.

Implements org.eclipse.persistence.jpa.jpql.parser.Expression.findQueryBNF.

Doc from org.eclipse.persistence.jpa.jpql.parser.Expression.findQueryBNF.

Retrieves the JPQLQueryBNF that represents the fragment of this Expression that was used when parsing the given Expression.

Parameters

expression:Expression: The Expression that is a descendant of this one

Returns:JPQLQueryBNF

The JPQLQueryBNF that was used to parse the given expression

Annotations

@Override

getActualEmptyIdentifier	back to summary
public String getActualEmptyIdentifier() Returns the actual EMPTY found in the string representation of the JPQL query, which has the actual case that was used. Returns:String The EMPTY identifier that was actually parsed

getActualEmptyIdentifier

back to summary

public String getActualEmptyIdentifier()

Returns the actual EMPTY found in the string representation of the JPQL query, which has the actual case that was used.

Returns:String: The EMPTY identifier that was actually parsed

getActualIsIdentifier	back to summary
public String getActualIsIdentifier() Returns the actual IS found in the string representation of the JPQL query, which has the actual case that was used. Returns:String The IS identifier that was actually parsed, or an empty string if it was not parsed

getActualIsIdentifier

back to summary

public String getActualIsIdentifier()

Returns the actual IS found in the string representation of the JPQL query, which has the actual case that was used.

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

getActualNotIdentifier	back to summary
public String getActualNotIdentifier() Returns the actual NOT found in the string representation of the JPQL query, which has the actual case that was used. Returns:String The NOT identifier that was actually parsed, or an empty string if it was not parsed

getActualNotIdentifier

back to summary

public String getActualNotIdentifier()

Returns the actual NOT found in the string representation of the JPQL query, which has the actual case that was used.

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

getExpression back to summary

getExpression	back to summary
public Expression getExpression() Returns the `Expression` that represents the collection-valued path expression if it was parsed. Returns:Expression The expression that was parsed representing the collection valued path expression

public Expression getExpression()

Returns the Expression that represents the collection-valued path expression if it was parsed.

Returns:Expression: The expression that was parsed representing the collection valued path expression

getIdentifier	back to summary
public String getIdentifier() Returns the identifier for this expression that may include NOT if it was parsed. The identifier IS should always be part of the identifier but it is possible it is not present when this expression is invalid. Returns:String Either IS NOT EMPTY, NOT EMPTY, IS EMPTY or EMPTY

getIdentifier

back to summary

public String getIdentifier()

Returns the identifier for this expression that may include NOT if it was parsed. The identifier IS should always be part of the identifier but it is possible it is not present when this expression is invalid.

Returns:String: Either IS NOT EMPTY, NOT EMPTY, IS EMPTY or EMPTY

getQueryBNF back to summary

getQueryBNF	back to summary
public JPQLQueryBNF getQueryBNF() Implements org.eclipse.persistence.jpa.jpql.parser.Expression.getQueryBNF. Doc from org.eclipse.persistence.jpa.jpql.parser.Expression.getQueryBNF. Returns the BNF of this `Expression`. Returns:JPQLQueryBNF The `JPQLQueryBNF`, which represents the grammar of this `Expression` Annotations @Override

public JPQLQueryBNF getQueryBNF()

Implements org.eclipse.persistence.jpa.jpql.parser.Expression.getQueryBNF.

Doc from org.eclipse.persistence.jpa.jpql.parser.Expression.getQueryBNF.

Returns the BNF of this Expression.

Returns:JPQLQueryBNF

The JPQLQueryBNF, which represents the grammar of this Expression

Annotations

@Override

hasExpression back to summary

hasExpression	back to summary
public boolean hasExpression() Determines whether the expression was parsed. Returns:boolean `true` if the expression was parsed; `false` otherwise

public boolean hasExpression()

Determines whether the expression was parsed.

Returns:boolean: true if the expression was parsed; false otherwise

hasNot back to summary

hasNot	back to summary
public boolean hasNot() Determines whether the identifier NOT was part of the query. Returns:boolean `true` if the identifier NOT was parsed; `false` otherwise

public boolean hasNot()

Determines whether the identifier NOT was part of the query.

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

hasSpaceAfterIs back to summary

hasSpaceAfterIs	back to summary
public boolean hasSpaceAfterIs() Determines whether a whitespace was found after IS. Returns:boolean `true` if there was a whitespace after IS; `false` otherwise

public boolean hasSpaceAfterIs()

Determines whether a whitespace was found after IS.

Returns:boolean: true if there was a whitespace after IS; false otherwise

parse back to summary

parse	back to summary
protected void parse(WordParser wordParser, boolean tolerant) Implements abstract org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.parse. Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.parse. Parses the query by starting at the current position, which is part of the given `WordParser`. Parameters wordParser:WordParser The text to parse based on the current position of the cursor tolerant:boolean Determines whether the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries Annotations @Override

protected void parse(WordParser wordParser, boolean tolerant)

Implements abstract org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.parse.

Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.parse.

Parses the query by starting at the current position, which is part of the given WordParser.

Parameters

wordParser:WordParser: The text to parse based on the current position of the cursor
tolerant:boolean: Determines whether the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries

Annotations

@Override

toParsedText back to summary

toParsedText	back to summary
protected void toParsedText(StringBuilder writer, boolean actual) Implements abstract org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.toParsedText. Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.toParsedText. Generates a string representation of this `Expression`, including its children, if it has any. Parameters writer:StringBuilder The buffer used to append this `Expression`'s string representation actual:boolean 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 Annotations @Override

protected void toParsedText(StringBuilder writer, boolean actual)

Implements abstract org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.toParsedText.

Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.toParsedText.

Generates a string representation of this Expression, including its children, if it has any.

Parameters

writer:StringBuilder: The buffer used to append this Expression's string representation
actual:boolean: 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

Annotations

@Override

updateExpression	back to summary
private void updateExpression(AbstractExpression expression)

org.eclipse.persistence.jpa.jpql.parser back to summary

private Class EmptyCollectionComparisonExpression.StateFieldPathToCollectionValuedPathConverter

Class Inheritance

extends AbstractExpressionVisitor

java.lang.Object
org.eclipse.persistence.jpa.jpql.parser.AbstractExpressionVisitor
org.eclipse.persistence.jpa.jpql.parser.EmptyCollectionComparisonExpression.StateFieldPathToCollectionValuedPathConverter

This visitor converts a StateFieldPathExpression into a CollectionValuedPathExpression. The parser only creates state field path expressions but this expression only supports a collection valued path expression.

Field Summary

Modifier and Type	Field and Description
private AbstractExpression	expression
private AbstractExpression	parent

Constructor Summary

Access	Constructor and Description
pack-priv	StateFieldPathToCollectionValuedPathConverter(AbstractExpression The parent of the expression parent, AbstractExpression The expression that might need to be converted expression) Creates a new `StateFieldPathToCollectionValuedPathConverter`.

Method Summary

Modifier and Type	Method and Description
public void	visit(StateFieldPathExpression The `Expression` to visit expression) Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpressionVisitor.visit. Implements org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit. Visits the `StateFieldPathExpression` expression.

Field Detail

expression	back to summary
private AbstractExpression expression

parent	back to summary
private AbstractExpression parent

Constructor Detail

StateFieldPathToCollectionValuedPathConverter back to summary

StateFieldPathToCollectionValuedPathConverter	back to summary
pack-priv StateFieldPathToCollectionValuedPathConverter(AbstractExpression parent, AbstractExpression expression) Creates a new `StateFieldPathToCollectionValuedPathConverter`. Parameters parent:AbstractExpression The parent of the expression expression:AbstractExpression The expression that might need to be converted

pack-priv StateFieldPathToCollectionValuedPathConverter(AbstractExpression parent, AbstractExpression expression)

Creates a new StateFieldPathToCollectionValuedPathConverter.

Parameters

parent:AbstractExpression: The parent of the expression
expression:AbstractExpression: The expression that might need to be converted

Method Detail

visit back to summary

visit	back to summary
public void visit(StateFieldPathExpression expression) Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpressionVisitor.visit. Implements org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit. Doc from org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit. Visits the `StateFieldPathExpression` expression. Parameters expression:StateFieldPathExpression The `Expression` to visit Annotations @Override

public void visit(StateFieldPathExpression expression)

Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpressionVisitor.visit.

Implements org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit.

Doc from org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit.

Visits the StateFieldPathExpression expression.

Parameters