EclipseLink Hermes Parser 4.0.2 · org.eclipse.persistence.jpa.jpql.tools.model.query.EncapsulatedIdentificationVariableExpressionStateObject

Field Summary

Modifier and Type	Field and Description
public static final String	IDENTIFICATION_VARIABLE_PROPERTY Notifies the identification variable property has changed.
private String	identificationVariable The cached identification variable that is used to make sure it's the same as the one stored in the `IdentificationVariableStateObject` itself.
private IManagedType	managedType The `IManagedType` mapped to the identification variable if the identification variable maps to an entity name.
private IType	type The cached `IType` of the value to resolve.
private ITypeDeclaration	typeDeclaration The cached `ITypeDeclaration` of the value to resolve.

Inherited from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSingleEncapsulatedExpressionStateObject:: STATE_OBJECT_PROPERTY

Constructor Summary

Access	Constructor and Description
protected	EncapsulatedIdentificationVariableExpressionStateObject(StateObject The parent of this state object, which cannot be `null` parent) Creates a new `EncapsulatedIdentificationVariableExpressionStateObject`.
protected	EncapsulatedIdentificationVariableExpressionStateObject(StateObject The parent of this state object, which cannot be `null` parent, String The identification variable identificationVariable) Creates a new `EncapsulatedIdentificationVariableExpressionStateObject`.

Method Summary

Modifier and Type	Method and Description
protected void	checkIntegrity() Makes sure the cached identification variable and the one owned by `IdentificationVariableStateObject` are the same.
protected void	clearResolvedObjects() Clears the values related to the managed type and type.
public EncapsulatedIdentificationVariableExpression	getExpression() Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSingleEncapsulatedExpressionStateObject.getExpression. Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getExpression. Returns the actual parsed object if this `StateObject` representation of the JPQL query was created by parsing an existing JPQL query.
public String	Returns: The name of the identification variable getIdentificationVariable() Returns the identification variable.
public IManagedType	Returns: Either the `IManagedType`, if it could be resolved; `null` otherwise getManagedType() Returns the `IManagedType` associated with the field handled by this object.
protected String	getQueryBNFId() Implements abstract org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSingleEncapsulatedExpressionStateObject.getQueryBNFId. Returns the unique identifier of the `JPQLQueryBNF` that will determine how to parse the encapsulated expression.
public IdentificationVariableStateObject	getStateObject() Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSingleEncapsulatedExpressionStateObject.getStateObject. Returns the encapsulated `StateObject`.
public IType	Returns: Either the `IType` of the identification variable or the `IType` for `IType#UNRESOLVABLE_TYPE` if it could not be resolved getType() Returns the `IType` of the field handled by this object.
public ITypeDeclaration	Returns: Either the `ITypeDeclaration` that was resolved by this object or the `ITypeDeclaration` for `IType#UNRESOLVABLE_TYPE` if it could not be resolved getTypeDeclaration() Returns the `ITypeDeclaration` of the field handled by this object.
public boolean	Returns: `true` if the identification variable has been defined; `false` otherwise hasIdentificationVariable() Determines whether the identification variable has been defined or not.
protected void	initialize() Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.initialize. Initializes this state object.
protected IManagedType	Returns: Either the `IManagedType` declared by the identification variable or `null` if it could not be resolved resolveManagedType() Retrieves the `IManagedType` that is mapped to the identification variable, if and only if the identification variable is used to declare an entity.
protected IType	Returns: Either the `IType` that was resolved by this object or the `IType` for `IType#UNRESOLVABLE_TYPE` if it could not be resolved resolveType() Resolves the `IType` of the property handled by this object.
protected ITypeDeclaration	Returns: Either the `ITypeDeclaration` that was resolved by this object or the `ITypeDeclaration` for `IType#UNRESOLVABLE_TYPE` if it could not be resolved resolveTypeDeclaration() Resolves the `ITypeDeclaration` of the property handled by this object.
public void	setIdentificationVariable(String The name of the identification variable identificationVariable) Sets the identification variable of this encapsulated expression.

Inherited from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSingleEncapsulatedExpressionStateObject:: addChildren hasStateObject isEquivalent parse setStateObject toTextEncapsulatedExpression

Field Detail

IDENTIFICATION_VARIABLE_PROPERTY	back to summary
public static final String IDENTIFICATION_VARIABLE_PROPERTY Notifies the identification variable property has changed.

identificationVariable	back to summary
private String identificationVariable The cached identification variable that is used to make sure it's the same as the one stored in the `IdentificationVariableStateObject` itself.

managedType	back to summary
private IManagedType managedType The `IManagedType` mapped to the identification variable if the identification variable maps to an entity name.

type	back to summary
private IType type The cached `IType` of the value to resolve.

typeDeclaration	back to summary
private ITypeDeclaration typeDeclaration The cached `ITypeDeclaration` of the value to resolve.

Constructor Detail

EncapsulatedIdentificationVariableExpressionStateObject back to summary

EncapsulatedIdentificationVariableExpressionStateObject	back to summary
protected EncapsulatedIdentificationVariableExpressionStateObject(StateObject parent) Creates a new `EncapsulatedIdentificationVariableExpressionStateObject`. Parameters parent:StateObject The parent of this state object, which cannot be `null` Exceptions NullPointerException: The given parent cannot be `null`

protected EncapsulatedIdentificationVariableExpressionStateObject(StateObject parent)

Creates a new EncapsulatedIdentificationVariableExpressionStateObject.

Parameters

parent:StateObject: The parent of this state object, which cannot be null

Exceptions

NullPointerException:: The given parent cannot be null

EncapsulatedIdentificationVariableExpressionStateObject back to summary

EncapsulatedIdentificationVariableExpressionStateObject	back to summary
protected EncapsulatedIdentificationVariableExpressionStateObject(StateObject parent, String identificationVariable) Creates a new `EncapsulatedIdentificationVariableExpressionStateObject`. Parameters parent:StateObject The parent of this state object, which cannot be `null` identificationVariable:String The identification variable Exceptions NullPointerException: The given parent cannot be `null`

protected EncapsulatedIdentificationVariableExpressionStateObject(StateObject parent, String identificationVariable)

Creates a new EncapsulatedIdentificationVariableExpressionStateObject.

Parameters

parent:StateObject: The parent of this state object, which cannot be null
identificationVariable:String: The identification variable

Exceptions

NullPointerException:: The given parent cannot be null

Method Detail

checkIntegrity	back to summary
protected void checkIntegrity() Makes sure the cached identification variable and the one owned by `IdentificationVariableStateObject` are the same. If they are not, then clears the cached values related to the type.

clearResolvedObjects	back to summary
protected void clearResolvedObjects() Clears the values related to the managed type and type.

getExpression back to summary

getExpression	back to summary
public EncapsulatedIdentificationVariableExpression getExpression() Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSingleEncapsulatedExpressionStateObject.getExpression. Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getExpression. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getExpression. Returns the actual parsed object if this `StateObject` representation of the JPQL query was created by parsing an existing JPQL query. Returns:EncapsulatedIdentificationVariableExpression 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) Annotations @Override

public EncapsulatedIdentificationVariableExpression getExpression()

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

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getExpression.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getExpression.

Returns the actual parsed object if this StateObject representation of the JPQL query was created by parsing an existing JPQL query.

Returns:EncapsulatedIdentificationVariableExpression

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)

Annotations

@Override

getIdentificationVariable	back to summary
public String getIdentificationVariable() Returns the identification variable. Returns:String The name of the identification variable

getIdentificationVariable

back to summary

public String getIdentificationVariable()

Returns the identification variable.

Returns:String: The name of the identification variable

getManagedType back to summary

getManagedType	back to summary
public IManagedType getManagedType() Returns the `IManagedType` associated with the field handled by this object. If this object does not handle a field that has a `IManagedType`, then `null` should be returned. For example: "`SELECT e FROM Employee e`", the object for e would be returning the `IManagedType` for Employee. Returns:IManagedType Either the `IManagedType`, if it could be resolved; `null` otherwise

public IManagedType getManagedType()

Returns the IManagedType associated with the field handled by this object. If this object does not handle a field that has a IManagedType, then null should be returned.

For example: "SELECT e FROM Employee e", the object for e would be returning the IManagedType for Employee.

Returns:IManagedType: Either the IManagedType, if it could be resolved; null otherwise

getQueryBNFId back to summary

getQueryBNFId	back to summary
protected String getQueryBNFId() Implements abstract org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSingleEncapsulatedExpressionStateObject.getQueryBNFId. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSingleEncapsulatedExpressionStateObject.getQueryBNFId. Returns the unique identifier of the `JPQLQueryBNF` that will determine how to parse the encapsulated expression. Returns:String The non-`null` ID of the BNF Annotations @Override

protected String getQueryBNFId()

Implements abstract org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSingleEncapsulatedExpressionStateObject.getQueryBNFId.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSingleEncapsulatedExpressionStateObject.getQueryBNFId.

Returns the unique identifier of the JPQLQueryBNF that will determine how to parse the encapsulated expression.

Returns:String

The non-null ID of the BNF

Annotations

@Override

getStateObject back to summary

getStateObject	back to summary
public IdentificationVariableStateObject getStateObject() Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSingleEncapsulatedExpressionStateObject.getStateObject. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSingleEncapsulatedExpressionStateObject.getStateObject. Returns the encapsulated `StateObject`. Returns:IdentificationVariableStateObject The encapsulated `StateObject` Annotations @Override

public IdentificationVariableStateObject getStateObject()

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

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSingleEncapsulatedExpressionStateObject.getStateObject.

Returns the encapsulated StateObject.

Returns:IdentificationVariableStateObject

The encapsulated StateObject

Annotations

@Override

getType back to summary

getType	back to summary
public IType getType() Returns the `IType` of the field handled by this object. Returns:IType Either the `IType` of the identification variable or the `IType` for `IType#UNRESOLVABLE_TYPE` if it could not be resolved

public IType getType()

Returns the IType of the field handled by this object.

Returns:IType: Either the IType of the identification variable or the IType for IType#UNRESOLVABLE_TYPE if it could not be resolved

getTypeDeclaration back to summary

getTypeDeclaration	back to summary
public ITypeDeclaration getTypeDeclaration() Returns the `ITypeDeclaration` of the field handled by this object. Returns:ITypeDeclaration Either the `ITypeDeclaration` that was resolved by this object or the `ITypeDeclaration` for `IType#UNRESOLVABLE_TYPE` if it could not be resolved

public ITypeDeclaration getTypeDeclaration()

Returns the ITypeDeclaration of the field handled by this object.

Returns:ITypeDeclaration: Either the ITypeDeclaration that was resolved by this object or the ITypeDeclaration for IType#UNRESOLVABLE_TYPE if it could not be resolved

hasIdentificationVariable back to summary

hasIdentificationVariable	back to summary
public boolean hasIdentificationVariable() Determines whether the identification variable has been defined or not. Returns:boolean `true` if the identification variable has been defined; `false` otherwise

public boolean hasIdentificationVariable()

Determines whether the identification variable has been defined or not.

Returns:boolean: true if the identification variable has been defined; false otherwise

initialize	back to summary
protected void initialize() Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.initialize. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.initialize. Initializes this state object. Annotations @Override

initialize

back to summary

protected void initialize()

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

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.initialize.

Initializes this state object.

Annotations

@Override

resolveManagedType back to summary

resolveManagedType	back to summary
protected IManagedType resolveManagedType() Retrieves the `IManagedType` that is mapped to the identification variable, if and only if the identification variable is used to declare an entity. Returns:IManagedType Either the `IManagedType` declared by the identification variable or `null` if it could not be resolved

protected IManagedType resolveManagedType()

Retrieves the IManagedType that is mapped to the identification variable, if and only if the identification variable is used to declare an entity.

Returns:IManagedType: Either the IManagedType declared by the identification variable or null if it could not be resolved

resolveType back to summary

resolveType	back to summary
protected IType resolveType() Resolves the `IType` of the property handled by this object. Returns:IType Either the `IType` that was resolved by this object or the `IType` for `IType#UNRESOLVABLE_TYPE` if it could not be resolved

protected IType resolveType()

Resolves the IType of the property handled by this object.

Returns:IType: Either the IType that was resolved by this object or the IType for IType#UNRESOLVABLE_TYPE if it could not be resolved

resolveTypeDeclaration back to summary

resolveTypeDeclaration	back to summary
protected ITypeDeclaration resolveTypeDeclaration() Resolves the `ITypeDeclaration` of the property handled by this object. Returns:ITypeDeclaration Either the `ITypeDeclaration` that was resolved by this object or the `ITypeDeclaration` for `IType#UNRESOLVABLE_TYPE` if it could not be resolved

protected ITypeDeclaration resolveTypeDeclaration()

Resolves the ITypeDeclaration of the property handled by this object.

Returns:ITypeDeclaration: Either the ITypeDeclaration that was resolved by this object or the ITypeDeclaration for IType#UNRESOLVABLE_TYPE if it could not be resolved

setIdentificationVariable	back to summary
public void setIdentificationVariable(String identificationVariable) Sets the identification variable of this encapsulated expression. Parameters identificationVariable:String The name of the identification variable

setIdentificationVariable

back to summary

public void setIdentificationVariable(String identificationVariable)

Sets the identification variable of this encapsulated expression.

Parameters

identificationVariable:String: The name of the identification variable

public abstract Class EncapsulatedIdentificationVariableExpressionStateObject

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail