org.eclipse.persistence.jpa.jpql.model.query
Class EntryExpressionStateObject

java.lang.Object
  org.eclipse.persistence.jpa.jpql.model.query.AbstractStateObject
      org.eclipse.persistence.jpa.jpql.model.query.AbstractEncapsulatedExpressionStateObject
          org.eclipse.persistence.jpa.jpql.model.query.AbstractSingleEncapsulatedExpressionStateObject
              org.eclipse.persistence.jpa.jpql.model.query.EncapsulatedIdentificationVariableExpressionStateObject
                  org.eclipse.persistence.jpa.jpql.model.query.EntryExpressionStateObject

All Implemented Interfaces:

StateObject

public class EntryExpressionStateObject
extends EncapsulatedIdentificationVariableExpressionStateObject

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

This is part of JPA 2.0.

BNF: expression ::= ENTRY(identification_variable)

Version:

2.4

See Also:

EntryExpression

Author:

Pascal Filion

Since:

2.4

Field Summary

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

IDENTIFICATION_VARIABLE_PROPERTY

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

STATE_OBJECT_PROPERTY

Constructor Summary

EntryExpressionStateObject(StateObject parent)
Creates a new EntryExpressionStateObject.

EntryExpressionStateObject(StateObject parent, java.lang.String identificationVariable)
Creates a new EntryExpressionStateObject.

Method Summary

void	accept(StateObjectVisitor visitor) Visits this StateObject by the given visitor.
EntryExpression	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(EntryExpression 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.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.model.query.AbstractSingleEncapsulatedExpressionStateObject

addChildren, hasStateObject, isEquivalent, parse, setStateObject, toTextEncapsulatedExpression

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

toTextInternal

Methods inherited from class org.eclipse.persistence.jpa.jpql.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

EntryExpressionStateObject

public EntryExpressionStateObject(StateObject parent)

Creates a new EntryExpressionStateObject.

Parameters:

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

Throws:

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

EntryExpressionStateObject

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

Creates a new EntryExpressionStateObject.

Parameters:

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

identificationVariable - 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

getExpression

public EntryExpression 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(EntryExpression 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 ENTRY expression