EclipseLink 2.4.2, build 'v20130514-5956486' API Reference

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

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

public final class CollectionValuedPathExpression
extends AbstractPathExpression

A collection_valued_field is designated by the name of an association field in a one-to-many or a many-to-many relationship or by the name of an element collection field. The type of a collection_valued_field is a collection of values of the abstract schema type of the related entity or element type.

BNF: collection_valued_path_expression ::= general_identification_variable.{single_valued_object_field.}*collection_valued_field

Version:
2.4
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
CollectionValuedPathExpression(AbstractExpression parent, AbstractExpression expression)
          Creates a new CollectionValuedPathExpression.
CollectionValuedPathExpression(AbstractExpression parent, AbstractExpression expression, java.lang.String paths)
          Creates a new CollectionValuedPathExpression.
CollectionValuedPathExpression(AbstractExpression parent, java.lang.String paths)
          Creates a new CollectionValuedPathExpression.
 
Method Summary
 void accept(ExpressionVisitor visitor)
          Visits this Expression by the given visitor.
 JPQLQueryBNF getQueryBNF()
          Returns the BNF of this Expression.
 
Methods inherited from class org.eclipse.persistence.jpa.jpql.parser.AbstractPathExpression
acceptChildren, addChildrenTo, addOrderedChildrenTo, endsWithDot, findQueryBNF, getIdentificationVariable, getPath, hasIdentificationVariable, hasVirtualIdentificationVariable, parse, paths, pathSize, setVirtualIdentificationVariable, startsWithDot, toParsedText, toParsedText
 
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, isParsingComplete, 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

CollectionValuedPathExpression

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

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

CollectionValuedPathExpression

public CollectionValuedPathExpression(AbstractExpression parent,
                                      AbstractExpression expression,
                                      java.lang.String paths)
Creates a new CollectionValuedPathExpression.

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
paths - The path expression that is following the identification variable

CollectionValuedPathExpression

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

Parameters:
parent - The parent of this expression
paths - The path expression
Method Detail

accept

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

Parameters:
visitor - The ExpressionVisitor to visit this object

getQueryBNF

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

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

EclipseLink 2.4.2, build 'v20130514-5956486' API Reference