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

Class CollectionExpressionStateObject

java.lang.Object

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

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

All Implemented Interfaces:

StateObject

public final class CollectionExpressionStateObject
extends AbstractStateObject

This StateObject is a temporary object used to store a list of StateObjects. Those objects are not parented. StateObjectVisitor is not aware of this object either, to visit it, the visitor will be notified via reflection, see AbstractStateObject.acceptUnknownVisitor(StateObjectVisitor).

Since:

2.4

Version:

2.4

Author:

Pascal Filion

See Also:

CollectionExpression

Constructor Summary

Constructors

Constructor and Description
CollectionExpressionStateObject(StateObject parent, java.util.List<? extends StateObject> items) Creates a new CollectionExpressionStateObject.

Method Summary

Modifier and Type	Method and Description
void	accept(StateObjectVisitor visitor) Visits this StateObject by the given visitor.
CollectionExpression	getExpression() Returns the actual parsed object if this StateObject representation of the JPQL query was created by parsing an existing JPQL query.
boolean	isEquivalent(StateObject stateObject) Determines whether the given StateObject is equivalent to this one, i.e.
void	setExpression(CollectionExpression 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.AbstractStateObject

addPropertyChangeListener, children, decorate, equals, findIdentificationVariable, getDeclaration, getDecorator, getGrammar, getManagedTypeProvider, getParent, getQueryBuilder, getRoot, getType, getType, getTypeHelper, getTypeRepository, hashCode, isDecorated, removePropertyChangeListener, setExpression, setParent, toString, toString, toText

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CollectionExpressionStateObject

public CollectionExpressionStateObject(StateObject parent,
                                       java.util.List<? extends StateObject> items)

Creates a new CollectionExpressionStateObject.

Parameters:

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

items - The list of children owned by this state object

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 CollectionExpression 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 AbstractStateObject

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)

isEquivalent

public boolean isEquivalent(StateObject stateObject)

Determines whether the given StateObject is equivalent to this one, i.e. the information of both StateObject is the same.

Specified by:

isEquivalent in interface StateObject

Overrides:

isEquivalent in class AbstractStateObject

Parameters:

stateObject - The StateObject to compare its content to this one

Returns:

true if both object are equivalent; false otherwise

setExpression

public void setExpression(CollectionExpression 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 expression