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

Class ValueExpressionStateObject

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.ValueExpressionStateObject

All Implemented Interfaces:

StateObject

public class ValueExpressionStateObject
extends EncapsulatedIdentificationVariableExpressionStateObject

This object represents an identification variable that maps the values of a Map.

This is part of JPA 2.0.

BNF: VALUE(identification_variable)

Since:

2.4

Version:

2.4

Author:

Pascal Filion

See Also:

ValueExpression

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
ValueExpressionStateObject(StateObject parent)	Creates a new ValueExpressionStateObject.
ValueExpressionStateObject(StateObject parent, String identificationVariable)	Creates a new ValueExpressionStateObject.

Method Summary

Modifier and Type	Method	Description
void	accept(StateObjectVisitor visitor)	Visits this StateObject by the given visitor.
ValueExpression	getExpression()	Returns the actual parsed object if this StateObject representation of the JPQL query was created by parsing an existing JPQL query.
String	getIdentifier()	Returns the JPQL identifier of the expression represented by this AbstractSingleEncapsulatedExpressionStateObject.
protected IType	resolveType()	Resolves the IType of the property handled by this object.
void	setExpression(ValueExpression 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, 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, 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

Constructor Detail

ValueExpressionStateObject

public ValueExpressionStateObject(StateObject parent)

Creates a new ValueExpressionStateObject.

Parameters:

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

Throws:

NullPointerException - The given parent cannot be null

ValueExpressionStateObject

public ValueExpressionStateObject(StateObject parent,
                                  String identificationVariable)

Creates a new ValueExpressionStateObject.

Parameters:

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

identificationVariable - The identification variable

Throws:

NullPointerException - The given parent cannot be null

Method Detail

accept

public void accept(StateObjectVisitor visitor)

Description copied from interface: StateObject

Visits this StateObject by the given visitor.

Parameters:

visitor - The visitor to visit this object

getExpression

public ValueExpression getExpression()

Description copied from interface: StateObject

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 String getIdentifier()

Description copied from class: AbstractEncapsulatedExpressionStateObject

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

resolveType

protected IType resolveType()

Description copied from class: EncapsulatedIdentificationVariableExpressionStateObject

Resolves the IType of the property handled by this object.

Overrides:

resolveType in class EncapsulatedIdentificationVariableExpressionStateObject

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(ValueExpression 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 VALUE expression