Package org.eclipse.persistence.jpa.jpql.tools.model.query

Class CollectionValuedPathExpressionStateObject

java.lang.Object

org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject

org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractPathExpressionStateObject

org.eclipse.persistence.jpa.jpql.tools.model.query.CollectionValuedPathExpressionStateObject

All Implemented Interfaces:

ListHolderStateObject<java.lang.String>, StateObject

public class CollectionValuedPathExpressionStateObject
extends AbstractPathExpressionStateObject

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

See Also:

CollectionValuedPathExpression

Author:

Pascal Filion

Since:

2.4

Field Summary

Fields inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractPathExpressionStateObject

IDENTIFICATION_VARIABLE_PROPERTY, PATHS_LIST

Constructor Summary

Constructors

Constructor	Description
CollectionValuedPathExpressionStateObject(StateObject parent)	Creates a new CollectionValuedPathExpressionStateObject.
CollectionValuedPathExpressionStateObject(StateObject parent, java.lang.String path)	Creates a new CollectionValuedPathExpressionStateObject.

Method Summary

Modifier and Type	Method	Description
void	accept(StateObjectVisitor visitor)	Visits this StateObject by the given visitor.
CollectionValuedPathExpression	getExpression()	Returns the actual parsed object if this StateObject representation of the JPQL query was created by parsing an existing JPQL query.
protected IManagedType	resolveManagedType()	Resolves
protected IType	resolveType()	Resolves the IType of the property handled by this object.
void	setExpression(CollectionValuedPathExpression expression)	Keeps a reference of the parsed object object, which should only be done when this object is instantiated during the conversion of a parsed JPQL query into StateObjects.

Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractPathExpressionStateObject

addChildren, addItem, addItems, addListChangeListener, append, canMoveDown, canMoveUp, clearResolvedObjects, getIdentificationVariable, getItem, getManagedType, getMapping, getMapping, getPath, getType, getTypeDeclaration, hasIdentificationVariable, hasItems, initialize, isEquivalent, items, itemsSize, moveDown, moveUp, removeItem, removeItem, removeItems, removeListChangeListener, resolveMappings, resolveTypeDeclaration, setIdentificationVariable, setIdentificationVariableInternally, setPath, setPath, setPaths, setPaths, setPaths, toTextInternal

Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject

acceptUnknownVisitor, acceptUnknownVisitor, addProblems, addPropertyChangeListener, areEquivalent, buildProblem, buildProblem, buildStateObject, buildStateObjects, checkParent, children, decorate, equals, findIdentificationVariable, firePropertyChanged, getChangeSupport, getDeclaration, getDecorator, getGrammar, getManagedTypeProvider, getParent, getQueryBuilder, getRoot, getType, getType, getTypeHelper, getTypeRepository, hashCode, isDecorated, parent, parent, parent, removePropertyChangeListener, setExpression, setParent, toString, toString, toStringInternal, toStringItems, toText

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject

addPropertyChangeListener, children, decorate, findIdentificationVariable, getDeclaration, getDecorator, getGrammar, getManagedTypeProvider, getParent, getQueryBuilder, getRoot, isDecorated, removePropertyChangeListener, setParent, toString, toText

Constructor Detail

CollectionValuedPathExpressionStateObject

public CollectionValuedPathExpressionStateObject(StateObject parent)

Creates a new CollectionValuedPathExpressionStateObject.

Parameters:

parent - The parent of this state object, which cannot be null

Throws:

java.lang.NullPointerException - The given parent cannot be null

CollectionValuedPathExpressionStateObject

public CollectionValuedPathExpressionStateObject(StateObject parent,
                                                 java.lang.String path)

Creates a new CollectionValuedPathExpressionStateObject.

Parameters:

parent - The parent of this state object, which cannot be null

path - The collection-valued path expression

Throws:

java.lang.NullPointerException - The given parent cannot be null

Method Detail

accept

public void accept(StateObjectVisitor visitor)

Visits this StateObject by the given visitor.

Parameters:

visitor - The visitor to visit this object

getExpression

public CollectionValuedPathExpression getExpression()

Returns the actual parsed object if this StateObject representation of the JPQL query was created by parsing an existing JPQL query.

Specified by:

getExpression in interface StateObject

Overrides:

getExpression in class AbstractPathExpressionStateObject

Returns:

The parsed object when a JPQL query is parsed and converted into a StateObject or null when the JPQL query is manually created (i.e. not from a string)

resolveManagedType

protected IManagedType resolveManagedType()

Resolves

Specified by:

resolveManagedType in class AbstractPathExpressionStateObject

Returns:

resolveType

protected IType resolveType()

Resolves the IType of the property handled by this object.

Specified by:

resolveType in class AbstractPathExpressionStateObject

Returns:

Either the IType that was resolved by this object or the IType for IType.UNRESOLVABLE_TYPE if it could not be resolved

setExpression

public void setExpression(CollectionValuedPathExpression expression)

Keeps a reference of the parsed object object, which should only be done when this object is instantiated during the conversion of a parsed JPQL query into StateObjects.

Parameters:

expression - The parsed object representing a collection-valued path expression