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

Class CollectionMemberDeclarationStateObject

java.lang.Object

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

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

All Implemented Interfaces:

StateObject, VariableDeclarationStateObject

public class CollectionMemberDeclarationStateObject
extends AbstractStateObject
implements VariableDeclarationStateObject

An identification variable declared by a collection_member_declaration ranges over values of a collection obtained by navigation using a path expression. Such a path expression represents a navigation involving the association-fields of an entity abstract schema type. Because a path expression can be based on another path expression, the navigation can use the association-fields of related entities. An identification variable of a collection member declaration is declared using a special operator, the reserved identifier IN. The argument to the IN operator is a collection-valued path expression. The path expression evaluates to a collection type specified as a result of navigation to a collection-valued association-field of an entity abstract schema type. The syntax for declaring a collection member identification variable is as follows:

BNF: collection_member_declaration ::= IN(collection_valued_path_expression) [AS] identification_variable

or

BNF: derived_collection_member_declaration ::= IN superquery_identification_variable.{single_valued_object_field.}*collection_valued_field

Version:

2.5

See Also:

FromClauseStateObject, CollectionMemberDeclaration

Author:

Pascal Filion

Since:

2.4

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AS_PROPERTY Notifies the visibility of the AS identifier has changed.

Constructor Summary

Constructors

Constructor and Description
CollectionMemberDeclarationStateObject(AbstractFromClauseStateObject parent) Creates a new CollectionMemberDeclarationStateObject.
CollectionMemberDeclarationStateObject(AbstractFromClauseStateObject parent, java.util.ListIterator<java.lang.String> paths, boolean as, java.lang.String identificationVariable) Creates a new CollectionMemberDeclarationStateObject.
CollectionMemberDeclarationStateObject(AbstractFromClauseStateObject parent, java.util.ListIterator<java.lang.String> paths, java.lang.String identificationVariable) Creates a new CollectionMemberDeclarationStateObject.
CollectionMemberDeclarationStateObject(SimpleFromClauseStateObject parent, java.lang.String collectionValuedPath) Creates a new CollectionMemberDeclarationStateObject.

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(StateObjectVisitor visitor) Visits this StateObject by the given visitor.
CollectionMemberDeclarationStateObject	addAs() Makes sure the AS identifier is specified.
protected void	addChildren(java.util.List<StateObject> children) Adds the children of this StateObject to the given list.
CollectionValuedPathExpressionStateObject	getCollectionValuedPath() Returns the model object representing the collection-valued association-field of an entity abstract schema type.
CollectionMemberDeclaration	getExpression() Returns the actual parsed object if this StateObject representation of the JPQL query was created by parsing an existing JPQL query.
IdentificationVariableStateObject	getIdentificationVariable() Returns the model object representing an identification variable evaluating to a collection-valued association-field of an entity abstract schema type.
IManagedType	getManagedType(StateObject stateObject) Returns the IManagedType for the given identification variable.
AbstractFromClauseStateObject	getParent() Returns the parent of this StateObject.
boolean	hasAs() Determines whether the AS identifier is used or not.
boolean	hasIdentificationVariable() Determines whether an identification variable was defined.
ListIterable<IdentificationVariableStateObject>	identificationVariables() Returns the IdentificationVariableStateObject that are used by this state object.
protected void	initialize() Initializes this state object.
boolean	isDerived() Determines whether this collection member declaration is used as a derived collection-valued path expression.
boolean	isEquivalent(StateObject stateObject) Determines whether the given StateObject is equivalent to this one, i.e. the information of both StateObject is the same.
void	removeAs() Makes sure the AS identifier is not specified.
void	setAs(boolean as) Sets whether the AS identifier is used or not.
void	setDerived(boolean derived) Sets whether this collection member declaration is used as a derived collection-valued path expression.
void	setExpression(CollectionMemberDeclaration 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.
void	setIdentificationVariable(java.lang.String identificationVariable) Sets the new identification variable that will range over the collection-valued path.
void	setPath(java.lang.String path) Changes the path expression with the list of segments, the identification variable will also be updated with the first segment.
void	setPaths(java.util.List<java.lang.String> paths) Changes the path expression with the list of segments, the identification variable will also be updated with the first segment.
void	setPaths(java.util.ListIterator<java.lang.String> paths) Changes the path expression with the list of segments, the identification variable will also be updated with the first segment.
void	setPaths(java.lang.String... paths) Changes the path expression with the list of segments, the identification variable will also be updated with the first segment.
void	toggleAs() Toggles the usage of the AS identifier.
protected void	toTextInternal(java.lang.Appendable writer) Prints out a string representation of this StateObject, which should not be used to define a true string representation of a JPQL query but should be used for debugging purposes.

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, 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, getQueryBuilder, getRoot, isDecorated, removePropertyChangeListener, setParent, toString, toText

Field Detail

AS_PROPERTY

public static final java.lang.String AS_PROPERTY

Notifies the visibility of the AS identifier has changed.

See Also:

Constant Field Values

Constructor Detail

CollectionMemberDeclarationStateObject

public CollectionMemberDeclarationStateObject(AbstractFromClauseStateObject parent)

Creates a new CollectionMemberDeclarationStateObject.

Parameters:

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

Throws:

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

CollectionMemberDeclarationStateObject

public CollectionMemberDeclarationStateObject(AbstractFromClauseStateObject parent,
                                      java.util.ListIterator<java.lang.String> paths,
                                      boolean as,
                                      java.lang.String identificationVariable)

Creates a new CollectionMemberDeclarationStateObject.

Parameters:

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

paths - The segments that represent the collection-valued path

as - Determine whether the AS identifier is used or not

identificationVariable - The identification variable declaring the collection-valued path

Throws:

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

CollectionMemberDeclarationStateObject

public CollectionMemberDeclarationStateObject(AbstractFromClauseStateObject parent,
                                      java.util.ListIterator<java.lang.String> paths,
                                      java.lang.String identificationVariable)

Creates a new CollectionMemberDeclarationStateObject.

Parameters:

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

paths - The segments that represent the collection-valued path

identificationVariable - The identification variable declaring the collection-valued path

Throws:

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

CollectionMemberDeclarationStateObject

public CollectionMemberDeclarationStateObject(SimpleFromClauseStateObject parent,
                                      java.lang.String collectionValuedPath)

Creates a new CollectionMemberDeclarationStateObject.

Parameters:

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

collectionValuedPath - The derived 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.

Specified by:

accept in interface StateObject

Parameters:

visitor - The visitor to visit this object

addAs

public CollectionMemberDeclarationStateObject addAs()

Makes sure the AS identifier is specified.

Returns:

This object

addChildren

protected void addChildren(java.util.List<StateObject> children)

Adds the children of this StateObject to the given list.

Overrides:

addChildren in class AbstractStateObject

Parameters:

children - The list used to store the children

getCollectionValuedPath

public CollectionValuedPathExpressionStateObject getCollectionValuedPath()

Returns the model object representing the collection-valued association-field of an entity abstract schema type.

Returns:

The collection-valued association-field of an entity abstract schema type

getExpression

public CollectionMemberDeclaration 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)

getIdentificationVariable

public IdentificationVariableStateObject getIdentificationVariable()

Returns the model object representing an identification variable evaluating to a collection-valued association-field of an entity abstract schema type.

Returns:

The identification variable portion of this declaration

getManagedType

public IManagedType getManagedType(StateObject stateObject)

Returns the IManagedType for the given identification variable. The search does not traverse up the query hierarchy if this declaration is for a subquery.

SELECT e FROM Department d JOIN KEY(d.employees).addresses a

In the above query, the managed type associated with the identification variable:

• d is "Department"
• a is "Address"

Specified by:

getManagedType in interface VariableDeclarationStateObject

Parameters:

stateObject - The StateObject that should be an simple identification variable or an encapsulated identification variable with the identifier KEY or VALUE

Returns:

The IManagedType representing the domain object declared by the given identification variable

getParent

public AbstractFromClauseStateObject getParent()

Returns the parent of this StateObject.

Specified by:

getParent in interface StateObject

Overrides:

getParent in class AbstractStateObject

Returns:

Returns the parent of this StateObject, which is null only when this is the root of the hierarchy

hasAs

public boolean hasAs()

Determines whether the AS identifier is used or not.

Returns:

true if the AS identifier is part of the expression; false otherwise

hasIdentificationVariable

public boolean hasIdentificationVariable()

Determines whether an identification variable was defined.

Returns:

true if an identification variable is defined; false otherwise

identificationVariables

public ListIterable<IdentificationVariableStateObject> identificationVariables()

Returns the IdentificationVariableStateObject that are used by this state object. It is possible more than one declaration exists, like a range variable declaration has also joins and join fetches.

Specified by:

identificationVariables in interface VariableDeclarationStateObject

Returns:

The list of IdentificationVariableStateObject

initialize

protected void initialize()

Initializes this state object.

Overrides:

initialize in class AbstractStateObject

isDerived

public boolean isDerived()

Determines whether this collection member declaration is used as a derived collection-valued path expression.

Returns:

true if this collection member declaration is used as this form: "IN collection_valued_path_expression" in a subquery; false if it's used as this form: IN(collection_valued_path_expression) [AS] identification_variable" in a top-level or subquery queries

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

removeAs

public void removeAs()

Makes sure the AS identifier is not specified.

setAs

public void setAs(boolean as)

Sets whether the AS identifier is used or not.

Parameters:

as - true if the AS identifier is part of the expression; false otherwise

setDerived

public void setDerived(boolean derived)

Sets whether this collection member declaration is used as a derived collection-valued path expression.

Parameters:

derived - true if this collection member declaration is used as this form: "IN collection_valued_path_expression" in a subquery; false if it's used as this form: IN(collection_valued_path_expression) [AS] identification_variable" in a top-level or subquery queries

setExpression

public void setExpression(CollectionMemberDeclaration 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 an IN expression

setIdentificationVariable

public void setIdentificationVariable(java.lang.String identificationVariable)

Sets the new identification variable that will range over the collection-valued path.

Parameters:

identificationVariable - The new identification variable

setPath

public void setPath(java.lang.String path)

Changes the path expression with the list of segments, the identification variable will also be updated with the first segment.

Parameters:

path - The new path expression

setPaths

public void setPaths(java.util.List<java.lang.String> paths)

Changes the path expression with the list of segments, the identification variable will also be updated with the first segment.

Parameters:

paths - The new path expression

setPaths

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

Changes the path expression with the list of segments, the identification variable will also be updated with the first segment.

Parameters:

paths - The new path expression

setPaths

public void setPaths(java.lang.String... paths)

Changes the path expression with the list of segments, the identification variable will also be updated with the first segment.

Parameters:

paths - The new path expression

toggleAs

public void toggleAs()

Toggles the usage of the AS identifier.

toTextInternal

protected void toTextInternal(java.lang.Appendable writer)
                       throws java.io.IOException

Prints out a string representation of this StateObject, which should not be used to define a true string representation of a JPQL query but should be used for debugging purposes.

Specified by:

toTextInternal in class AbstractStateObject

Parameters:

writer - The writer used to print out the string representation

Throws:

java.io.IOException - This should never happens, it is only required because Appendable is used instead of any concrete class