EclipseLink Hermes Parser 4.0.2 · org.eclipse.persistence.jpa.jpql.parser.CollectionMemberExpression

Modifier and Type	Field and Description
private AbstractExpression	collectionValuedPathExpression The `Expression` representing the collection-valued path expression.
private AbstractExpression	entityExpression The `Expression` representing the entity expression.
private boolean	hasSpaceAfterMember Determines whether a whitespace was parsed after MEMBER.
private boolean	hasSpaceAfterOf Determines whether a whitespace was parsed after OF.
private String	memberIdentifier The actual MEMBER identifier found in the string representation of the JPQL query.
private String	notIdentifier The actual NOT identifier found in the string representation of the JPQL query.
private String	ofIdentifier The actual OF identifier found in the string representation of the JPQL query.

Access	Constructor and Description
public	CollectionMemberExpression(AbstractExpression The parent of this expression parent, AbstractExpression The entity expression that was parsed before parsing this one expression) Creates a new `CollectionMemberExpression`.

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.
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 MEMBER identifier that was actually parsed getActualMemberIdentifier() Returns the actual MEMBER identifier 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 identifier found in the string representation of the JPQL query, which has the actual case that was used.
public String	Returns: The OF identifier that was actually parsed, or an empty string if it was not parsed getActualOfIdentifier() Returns the actual OF identifier 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 getCollectionValuedPathExpression() Returns the `Expression` representing the collection-valued path expression.
public Expression	Returns: The expression that was parsed representing the entity expression getEntityExpression() Returns the `Expression` representing the entity expression.
public String	Returns: Either MEMBER, NOT MEMBER, NOT MEMBER OF or MEMBER OF getIdentifier() Returns the identifier for this expression that may include NOT and OF 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 collection-valued path expression was parsed; `false` otherwise hasCollectionValuedPathExpression() Determines whether the collection-valued path expression was parsed.
public boolean	Returns: `true` if the entity expression was parsed; `false` otherwise hasEntityExpression() Determines whether the entity expression was parsed.
public boolean	Returns: `true` if the identifier NOT was parsed; `false` otherwise hasNot() Determines whether the identifier NOT was parsed.
public boolean	Returns: `true` if the identifier OF was parsed; `false` otherwise hasOf() Determines whether the identifier OF was parsed.
public boolean	Returns: `true` if there was a whitespace after MEMBER; `false` otherwise hasSpaceAfterMember() Determines whether a whitespace was found after MEMBER.
public boolean	Returns: `true` if there was a whitespace after OF; `false` otherwise hasSpaceAfterOf() Determines whether a whitespace was found after OF.
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.

collectionValuedPathExpression	back to summary
private AbstractExpression collectionValuedPathExpression The `Expression` representing the collection-valued path expression.

entityExpression	back to summary
private AbstractExpression entityExpression The `Expression` representing the entity expression.

hasSpaceAfterMember	back to summary
private boolean hasSpaceAfterMember Determines whether a whitespace was parsed after MEMBER.

hasSpaceAfterOf	back to summary
private boolean hasSpaceAfterOf Determines whether a whitespace was parsed after OF.

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

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

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

CollectionMemberExpression	back to summary
public CollectionMemberExpression(AbstractExpression parent, AbstractExpression expression) Creates a new `CollectionMemberExpression`. Parameters parent:AbstractExpression The parent of this expression expression:AbstractExpression The entity expression that was parsed before parsing this one

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

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

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

getActualMemberIdentifier

back to summary

public String getActualMemberIdentifier()

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

Returns:String: The MEMBER identifier that was actually parsed

getActualNotIdentifier	back to summary
public String getActualNotIdentifier() Returns the actual NOT identifier 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 identifier 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

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

getActualOfIdentifier

back to summary

public String getActualOfIdentifier()

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

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

getCollectionValuedPathExpression back to summary

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

public Expression getCollectionValuedPathExpression()

Returns the Expression representing the collection-valued path expression.

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

getEntityExpression back to summary

getEntityExpression	back to summary
public Expression getEntityExpression() Returns the `Expression` representing the entity expression. Returns:Expression The expression that was parsed representing the entity expression

public Expression getEntityExpression()

Returns the Expression representing the entity expression.

Returns:Expression: The expression that was parsed representing the entity expression

getIdentifier	back to summary
public String getIdentifier() Returns the identifier for this expression that may include NOT and OF if it was parsed. Returns:String Either MEMBER, NOT MEMBER, NOT MEMBER OF or MEMBER OF

getIdentifier

back to summary

public String getIdentifier()

Returns the identifier for this expression that may include NOT and OF if it was parsed.

Returns:String: Either MEMBER, NOT MEMBER, NOT MEMBER OF or MEMBER OF

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

hasCollectionValuedPathExpression back to summary

hasCollectionValuedPathExpression	back to summary
public boolean hasCollectionValuedPathExpression() Determines whether the collection-valued path expression was parsed. Returns:boolean `true` if the collection-valued path expression was parsed; `false` otherwise

public boolean hasCollectionValuedPathExpression()

Determines whether the collection-valued path expression was parsed.

Returns:boolean: true if the collection-valued path expression was parsed; false otherwise

hasEntityExpression back to summary

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

public boolean hasEntityExpression()

Determines whether the entity expression was parsed.

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

hasNot back to summary

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

public boolean hasNot()

Determines whether the identifier NOT was parsed.

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

hasOf back to summary

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

public boolean hasOf()

Determines whether the identifier OF was parsed.

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

hasSpaceAfterMember back to summary

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

public boolean hasSpaceAfterMember()

Determines whether a whitespace was found after MEMBER.

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

hasSpaceAfterOf back to summary

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

public boolean hasSpaceAfterOf()

Determines whether a whitespace was found after OF.

Returns:boolean: true if there was a whitespace after OF; 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

public final Class CollectionMemberExpression

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail