Skip navigation links

org.eclipse.persistence.jpa.internal.jpql.parser
Class AbstractPathExpression

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.AbstractPathExpression

All Implemented Interfaces:

Expression

Direct Known Subclasses:

CollectionValuedPathExpression, StateFieldPathExpression

public abstract class AbstractPathExpression

extends AbstractExpression

An identification variable followed by the navigation operator (.) and a state field or association field is a path expression. The type of the path expression is the type computed as the result of navigation; that is, the type of the state field or association field to which the expression navigates.

Since:

2.3

Version:

2.3

Author:

Pascal Filion

See Also:

CollectionValuedPathExpression, IdentificationVariable

Field Summary

private java.lang.Boolean	endsWithDot Determines whether the path ends with a dot or not.
private AbstractExpression	identificationVariable The identification variable that starts the path expression, which can be a sample identification variable, an entry expression, a value expression or a key expression.
private java.util.List<java.lang.String>	paths The state field path in a ordered list of string segments.
private boolean	startsWithDot Determines whether the path starts with a dot or not.
private boolean	virtualIdentificationVariable Determines whether the identification variable is virtual, meaning it's not part of the query but is required for proper navigability.

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

Fields inherited from interface org.eclipse.persistence.jpa.internal.jpql.parser.Expression

ABS, ALL, AND, ANY, AS, ASC, AVG, BETWEEN, BIT_LENGTH, BOTH, CASE, CHAR_LENGTH, CHARACTER_LENGTH, CLASS, COALESCE, CONCAT, COUNT, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, DELETE, DELETE_FROM, DESC, DIFFERENT, DISTINCT, DIVISION, ELSE, EMPTY, END, ENTRY, EQUAL, ESCAPE, EXISTS, FALSE, FETCH, FROM, FUNC, GREATER_THAN, GREATER_THAN_OR_EQUAL, GROUP_BY, HAVING, IN, INDEX, INNER, INNER_JOIN, INNER_JOIN_FETCH, 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_EXISTS, NOT_IN, NOT_LIKE, NOT_MEMBER, NOT_MEMBER_OF, NULL, NULLIF, OBJECT, OF, OR, ORDER_BY, OUTER, PLUS, POSITION, POSITIONAL_PARAMETER, QUOTE, SELECT, SET, SIZE, SOME, SQRT, SUBSTRING, SUM, THEN, TRAILING, TREAT, TRIM, TRUE, TYPE, UNKNOWN, UPDATE, UPPER, VALUE, WHEN, WHERE

Constructor Summary

AbstractPathExpression(AbstractExpression parent, AbstractExpression expression)
Creates a new AbstractPathExpression.

AbstractPathExpression(AbstractExpression parent, java.lang.String paths)
Creates a new AbstractPathExpression.

Method Summary

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.
private void	checkPaths()
boolean	endsWithDot() Determines whether the path ends with a dot or not.
Expression	getIdentificationVariable() Returns the identification variable that starts the path expression, which can be a sample identification variable, a map value, map key or map entry expression.
java.lang.String	getPath(int index) Returns the specified segment of the state field path.
boolean	hasIdentificationVariable() Determines whether the identification variable was parsed.
boolean	hasVirtualIdentificationVariable() Determines whether this identification variable is virtual, meaning it's not part of the query but is required for proper navigability.
(package private) void	parse(WordParser wordParser, boolean tolerant) Parses the query by starting at the current position, which is part of the given WordParser.
java.util.ListIterator<java.lang.String>	paths() Returns the segments in the state field path in order.
int	pathSize() Returns the number of segments in the state field path.
(package private) void	setVirtualIdentificationVariable(java.lang.String variableName) Sets a virtual identification variable because the abstract schema name was parsed without one.
boolean	startsWithDot() Determines whether the path starts with a dot or not.
(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, getQueryBNF, getRoot, getText, handleAggregate, identifierRole, identifiers, identifiers, identifierVersion, isAncestor, isIdentifier, isNull, isParsingComplete, 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

Methods inherited from interface org.eclipse.persistence.jpa.internal.jpql.parser.Expression

accept

Field Detail

endsWithDot

private java.lang.Boolean endsWithDot

Determines whether the path ends with a dot or not.

identificationVariable

private AbstractExpression identificationVariable

The identification variable that starts the path expression, which can be a sample identification variable, an entry expression, a value expression or a key expression.

paths

private java.util.List<java.lang.String> paths

The state field path in a ordered list of string segments.

startsWithDot

private boolean startsWithDot

Determines whether the path starts with a dot or not.

virtualIdentificationVariable

private boolean virtualIdentificationVariable

Determines whether the identification variable is virtual, meaning it's not part of the query but is required for proper navigability.

Constructor Detail

AbstractPathExpression

AbstractPathExpression(AbstractExpression parent,
                       AbstractExpression expression)

Creates a new AbstractPathExpression.

Parameters:

parent - The parent of this expression

expression - The identification variable that was already parsed, which means the beginning of the parsing should start with a dot

AbstractPathExpression

AbstractPathExpression(AbstractExpression parent,
                       java.lang.String paths)

Creates a new AbstractPathExpression.

Parameters:

parent - The parent of this expression

paths - The path expression

Method Detail

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() 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.

Parameters:

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

addChildrenTo

void addChildrenTo(java.util.Collection<Expression> children)

Adds the children of this Expression to the given collection.

Overrides:

addChildrenTo in class AbstractExpression

Parameters:

children - The collection used to store the children

addOrderedChildrenTo

final void addOrderedChildrenTo(java.util.List<StringExpression> children)

Adds the StringExpressions representing this Expression.

Overrides:

addOrderedChildrenTo in class AbstractExpression

Parameters:

children - The list used to store the string representation of this Expression

checkPaths

private void checkPaths()

endsWithDot

public final boolean endsWithDot()

Determines whether the path ends with a dot or not.

Returns:

true if the path ends with a dot; false otherwise

getIdentificationVariable

public final Expression getIdentificationVariable()

Returns the identification variable that starts the path expression, which can be a sample identification variable, a map value, map key or map entry expression.

Returns:

The root of the path expression

getPath

public final java.lang.String getPath(int index)

Returns the specified segment of the state field path.

Parameters:

index - The 0-based segment index

Returns:

The specified segment

hasIdentificationVariable

public final boolean hasIdentificationVariable()

Determines whether the identification variable was parsed.

Returns:

true the identification variable was parsed; false otherwise

hasVirtualIdentificationVariable

public final boolean hasVirtualIdentificationVariable()

Determines whether this identification variable is virtual, meaning it's not part of the query but is required for proper navigability.

Returns:

true if this identification variable was virtually created to fully qualify path expression; false if it was parsed

parse

final 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

paths

public final java.util.ListIterator<java.lang.String> paths()

Returns the segments in the state field path in order.

Returns:

An Iterator over the segments of the state field path

pathSize

public final int pathSize()

Returns the number of segments in the state field path.

Returns:

The number of segments

setVirtualIdentificationVariable

final void setVirtualIdentificationVariable(java.lang.String variableName)

Sets a virtual identification variable because the abstract schema name was parsed without one. This is valid in an UPDATE and DELETE queries.

Parameters:

variableName - The identification variable that was generated to identify the abstract schema name

startsWithDot

public final boolean startsWithDot()

Determines whether the path starts with a dot or not.

Returns:

true if the path starts with a dot; false otherwise

toParsedText

final void toParsedText(java.lang.StringBuilder writer,
                        boolean includeVirtual)

Generates a string representation of this Expression.

Specified by:

toParsedText in class AbstractExpression

Parameters:

writer - The buffer used to append this Expression's string representation

includeVirtual - 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

Skip navigation links