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

Class ObjectExpressionStateObject

java.lang.Object

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

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

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

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

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

All Implemented Interfaces:

StateObject

public class ObjectExpressionStateObject
extends EncapsulatedIdentificationVariableExpressionStateObject

Stand-alone identification variables in the SELECT clause may optionally be qualified by the OBJECT operator. The SELECT clause must not use the OBJECT operator to qualify path expressions.

BNF: expression ::= OBJECT(identification_variable)

Version:

2.4

See Also:

ObjectExpression

Author:

Pascal Filion

Since:

2.4

Field Summary

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

IDENTIFICATION_VARIABLE_PROPERTY

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

STATE_OBJECT_PROPERTY

Constructor Summary

Constructors

Constructor	Description
ObjectExpressionStateObject(StateObject parent)	Creates a new ObjectExpressionStateObject.
ObjectExpressionStateObject(StateObject parent, java.lang.String identificationVariable)	Creates a new ObjectExpressionStateObject.

Method Summary

Modifier and Type	Method	Description
void	accept(StateObjectVisitor visitor)	Visits this StateObject by the given visitor.
protected void	addProblems(java.util.List<Problem> problems)	Adds to the given list the problems that were found with the current state of this StateObject, which means there are validation issues.
ObjectExpression	getExpression()	Returns the actual parsed object if this StateObject representation of the JPQL query was created by parsing an existing JPQL query.
java.lang.String	getIdentifier()	Returns the JPQL identifier of the expression represented by this AbstractSingleEncapsulatedExpressionStateObject.
void	setExpression(ObjectExpression 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.EncapsulatedIdentificationVariableExpressionStateObject

checkIntegrity, clearResolvedObjects, getIdentificationVariable, getManagedType, getQueryBNFId, getStateObject, getType, getTypeDeclaration, hasIdentificationVariable, initialize, resolveManagedType, resolveType, resolveTypeDeclaration, setIdentificationVariable

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

addChildren, hasStateObject, isEquivalent, parse, setStateObject, toTextEncapsulatedExpression

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

toTextInternal

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

acceptUnknownVisitor, acceptUnknownVisitor, 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

Constructor Detail

ObjectExpressionStateObject

public ObjectExpressionStateObject(StateObject parent)

Creates a new ObjectExpressionStateObject.

Parameters:

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

Throws:

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

ObjectExpressionStateObject

public ObjectExpressionStateObject(StateObject parent,
                                   java.lang.String identificationVariable)

Creates a new ObjectExpressionStateObject.

Parameters:

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

identificationVariable - The name of the identification variable

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

addProblems

protected void addProblems(java.util.List<Problem> problems)

Adds to the given list the problems that were found with the current state of this StateObject, which means there are validation issues.

Overrides:

addProblems in class AbstractStateObject

Parameters:

problems - The list to which the problems are added

getExpression

public ObjectExpression 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 EncapsulatedIdentificationVariableExpressionStateObject

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)

getIdentifier

public java.lang.String getIdentifier()

Returns the JPQL identifier of the expression represented by this AbstractSingleEncapsulatedExpressionStateObject.

Specified by:

getIdentifier in class AbstractEncapsulatedExpressionStateObject

Returns:

The JPQL identifier that is shown before the left parenthesis

setExpression

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