AbstractExpression (EclipseLink 2.3.2, "build v20111125-r10461" API Reference)

java.lang.Object
- org.eclipse.persistence.jpa.internal.jpql.parser.StringExpression
- - org.eclipse.persistence.jpa.internal.jpql.parser.AbstractExpression

All Implemented Interfaces:

Expression

Direct Known Subclasses:

AbstractConditionalClause, AbstractEncapsulatedExpression, AbstractFromClause, AbstractPathExpression, AbstractSchemaName, AbstractSelectClause, AbstractSelectStatement, ArithmeticFactor, BadExpression, BetweenExpression, CaseExpression, CollectionExpression, CollectionMemberDeclaration, CollectionMemberExpression, CompoundExpression, ConstructorExpression, DateTime, DeleteClause, DeleteStatement, EmptyCollectionComparisonExpression, EntityTypeLiteral, GroupByClause, IdentificationVariable, IdentificationVariableDeclaration, InExpression, InputParameter, Join, JoinFetch, JPQLExpression, KeywordExpression, LikeExpression, NotExpression, NullComparisonExpression, NullExpression, NumericLiteral, OrderByClause, OrderByItem, RangeVariableDeclaration, ResultVariable, StringLiteral, UnknownExpression, UpdateClause, UpdateItem, UpdateStatement, WhenClause
```
public abstract class AbstractExpression
extends StringExpression
implements Expression
```
This is the abstract definition of all the parts used to create the tree hierarchy representing the parsed JPQL query. It has the core of the parsing engine and of the content assist behavior (retrieval of the possible expression factories).

Since:

2.3

Version:

2.3

Author:

Pascal Filion

See Also:
ExpressionFactory, StringExpression

Field Summary

Fields
Modifier and Type	Field and Description
`static char`	`COMMA` The constant for ','.
`static char`	`DOT` The constant for '.'.
`static char`	`DOUBLE_QUOTE` The constant for '"'.
`static char`	`LEFT_CURLY_BRACKET` The constant for '{'.
`static char`	`LEFT_PARENTHESIS` The constant for '('.
`static char`	`NOT_DEFINED` The constant for a character that is not defined.
`static char`	`RIGHT_CURLY_BRACKET` The constant for '}'.
`static char`	`RIGHT_PARENTHESIS` The constant for ')'.
`static char`	`SINGLE_QUOTE` The constant for '''.
`static char`	`SPACE` The constant for ' '.
`static char`	`UNDERSCORE` The constant for '_'.

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

Method Summary

Methods
Modifier and Type	Method and Description
`java.util.ListIterator<Expression>`	`children()` Returns the children of this `Expression`.
`JPQLQueryBNF`	`findQueryBNF(AbstractExpression expression)` Retrieves the `JPQLQueryBNF` that was used to parse the given `Expression`.
`Expression[]`	`getChildren()` Returns the children of this `Expression`.
`AbstractExpression`	`getParent()` Returns the parent of this `Expression`.
`abstract JPQLQueryBNF`	`getQueryBNF()` Returns the BNF of this `Expression`.
`JPQLExpression`	`getRoot()` Retrieves the root node of the parsed tree hierarchy.
`static IdentifierRole`	`identifierRole(java.lang.String identifier)` Retrieves the role of the given identifier.
`static java.util.Collection<java.lang.String>`	`identifiers()` Returns the set of identifiers used by the Java Persistence query language.
`static IJPAVersion`	`identifierVersion(java.lang.String identifier)` Retrieves the JPA version in which the identifier was first introduced.
`boolean`	`isAncestor(Expression expression)` Determines whether this `Expression` is a parent of the given `Expression`.
`static boolean`	`isIdentifier(java.lang.String identifier)` Determines if the given word is a JPQL identifier.
`boolean`	`isVirtual()` Determines whether this identification variable is virtual, meaning it's not part of the query but is required for proper navigability.
`java.util.ListIterator<StringExpression>`	`orderedChildren()` Creates a list representing this expression and its children.
`static <T extends JPQLQueryBNF> T`	`queryBNF(java.lang.String queryBNFID)` Retrieves the BNF object that was registered for the given unique identifier.
`java.lang.String`	`toActualText()` Generates a string representation of this `StringExpression`, which needs to include any characters that are considered virtual, i.e.
`java.lang.String`	`toParsedText()` Returns a string representation of this `StringExpression` and its children.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

- Field Detail
  - COMMA
```
public static final char COMMA
```
    The constant for ','.
    
    See Also:
    Constant Field Values
  - DOT
```
public static final char DOT
```
    The constant for '.'.
    
    See Also:
    Constant Field Values
  - DOUBLE_QUOTE
```
public static final char DOUBLE_QUOTE
```
    The constant for '"'.
    
    See Also:
    Constant Field Values
  - LEFT_CURLY_BRACKET
```
public static final char LEFT_CURLY_BRACKET
```
    The constant for '{'.
    
    See Also:
    Constant Field Values
  - LEFT_PARENTHESIS
```
public static final char LEFT_PARENTHESIS
```
    The constant for '('.
    
    See Also:
    Constant Field Values
  - NOT_DEFINED
```
public static final char NOT_DEFINED
```
    The constant for a character that is not defined.
    
    See Also:
    Constant Field Values
  - RIGHT_CURLY_BRACKET
```
public static final char RIGHT_CURLY_BRACKET
```
    The constant for '}'.
    
    See Also:
    Constant Field Values
  - RIGHT_PARENTHESIS
```
public static final char RIGHT_PARENTHESIS
```
    The constant for ')'.
    
    See Also:
    Constant Field Values
  - SINGLE_QUOTE
```
public static final char SINGLE_QUOTE
```
    The constant for '''.
    
    See Also:
    Constant Field Values
  - SPACE
```
public static final char SPACE
```
    The constant for ' '.
    
    See Also:
    Constant Field Values
  - UNDERSCORE
```
public static final char UNDERSCORE
```
    The constant for '_'.
    
    See Also:
    Constant Field Values
- Method Detail
  - identifierRole
```
public static IdentifierRole identifierRole(java.lang.String identifier)
```
    Retrieves the role of the given identifier. A role helps to describe the purpose of the identifier in a query.
    
    Parameters:
    identifier - The identifier for which its role is requested
    
    Returns:
    The role of the given identifier
  - identifiers
```
public static java.util.Collection<java.lang.String> identifiers()
```
    Returns the set of identifiers used by the Java Persistence query language.
    
    Returns:
    The identifiers used by JPQL
  - identifierVersion
```
public static IJPAVersion identifierVersion(java.lang.String identifier)
```
    Retrieves the JPA version in which the identifier was first introduced.
    
    Returns:
    The version in which the identifier was introduced
  - isIdentifier
```
public static boolean isIdentifier(java.lang.String identifier)
```
    Determines if the given word is a JPQL identifier. The check is case insensitive.
    
    Parameters:
    word - The word to test
    
    Returns:
    true if the word is an identifier, false otherwise
  - queryBNF
```
public static <T extends JPQLQueryBNF> T queryBNF(java.lang.String queryBNFID)
```
    Retrieves the BNF object that was registered for the given unique identifier.
    
    Parameters:
    queryBNFID - The unique identifier of the JPQLQueryBNF to retrieve
    
    Returns:
    The JPQLQueryBNF representing a section of the grammar
  - children
```
public final java.util.ListIterator<Expression> children()
```
    Returns the children of this Expression.
    
    Specified by:
    
    children in interface Expression
    
    Returns:
    The children of this Expression or an empty list if this Expression does not have children
  - findQueryBNF
```
public JPQLQueryBNF findQueryBNF(AbstractExpression expression)
```
    Retrieves the JPQLQueryBNF that was used to parse the given Expression.
    
    Parameters:
    expression - The expression for which its BNF is needed
    
    Returns:
    The JPQLQueryBNF that was used to parse the given expression
  - getChildren
```
public final Expression[] getChildren()
```
    Returns the children of this Expression.
    
    Specified by:
    
    getChildren in interface Expression
    
    Returns:
    The children of this Expression or an empty list if this Expression does not have children
  - getParent
```
public final AbstractExpression getParent()
```
    Returns the parent of this Expression.
    
    Specified by:
    
    getParent in interface Expression
    
    Returns:
    The parent of this {@link Expression, which is never null except for the root of the tree
  - getQueryBNF
```
public abstract JPQLQueryBNF getQueryBNF()
```
    Returns the BNF of this Expression.
    
    Returns:
    The JPQLQueryBNF, which represents the grammar of this Expression
  - getRoot
```
public final JPQLExpression getRoot()
```
    Retrieves the root node of the parsed tree hierarchy.
    
    Specified by:
    
    getRoot in interface Expression
    
    Returns:
    The root of the Expression tree
  - isAncestor
```
public boolean isAncestor(Expression expression)
```
    Determines whether this Expression is a parent of the given Expression.
    
    Specified by:
    
    isAncestor in interface Expression
    
    Parameters:
    expression - The Expression to verify its paternity with this Expression
    
    Returns:
    true if this Expression is the same as the given Expression or one of its parent; false otherwise
  - isVirtual
```
public boolean isVirtual()
```
    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
  - orderedChildren
```
public final java.util.ListIterator<StringExpression> orderedChildren()
```
    Creates a list representing this expression and its children. In order to add every piece of the expression, #addChildrenTo(Collection) is called.
    
    Specified by:
    
    orderedChildren in class StringExpression
    
    Returns:
    The StringExpressions representing this Expression
  - toActualText
```
public java.lang.String toActualText()
```
    Generates a string representation of this StringExpression, which needs 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.
    
    Specified by:
    
    toActualText in interface Expression
    
    Specified by:
    
    toActualText in class StringExpression
    
    Returns:
    The string representation of this StringExpression
  - toParsedText
```
public java.lang.String toParsedText()
```
    Returns a string representation of this StringExpression and its children. The expression should contain whitespace even if the beautified version would not have any. For instance, "SELECT e " should be returned where Expression#toText() would return "SELECT e".
    
    Specified by:
    
    toParsedText in interface Expression
    
    Specified by:
    
    toParsedText in class StringExpression
    
    Returns:
    The string representation of this StringExpression
  - toString
```
public final java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class AbstractExpression

Field Summary

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

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

COMMA

DOT

DOUBLE_QUOTE

LEFT_CURLY_BRACKET

LEFT_PARENTHESIS

NOT_DEFINED

RIGHT_CURLY_BRACKET

RIGHT_PARENTHESIS

SINGLE_QUOTE

SPACE

UNDERSCORE

Method Detail

identifierRole

identifiers

identifierVersion

isIdentifier

queryBNF

children

findQueryBNF

getChildren

getParent

getQueryBNF

getRoot

isAncestor

isVirtual

orderedChildren

toActualText

toParsedText

toString