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

Class StateFieldPathExpressionStateObject

java.lang.Object

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

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

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

All Implemented Interfaces:

ListHolderStateObject<java.lang.String>, StateObject

public class StateFieldPathExpressionStateObject
extends AbstractPathExpressionStateObject

A single-valued association field is designated by the name of an association-field in a one-to-one or many-to-one relationship. The type of a single-valued association field and thus a single-valued association path expression is the abstract schema type of the related entity.

BNF: state_field_path_expression ::= {identification_variable | single_valued_association_path_expression}.state_field

BNF: single_valued_association_path_expression ::= identification_variable.{single_valued_association_field.}*single_valued_association_field

Since:

2.4

Version:

2.5

Author:

Pascal Filion

See Also:

StateFieldPathExpression

Field Summary

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

IDENTIFICATION_VARIABLE_PROPERTY, PATHS_LIST

Constructor Summary

Constructors

Constructor and Description
StateFieldPathExpressionStateObject(StateObject parent) Creates a new StateFieldPathExpressionStateObject.
StateFieldPathExpressionStateObject(StateObject parent, java.lang.String path) Creates a new StateFieldPathExpressionStateObject.

Method Summary

Modifier and Type	Method and Description
void	accept(StateObjectVisitor visitor) Visits this StateObject by the given visitor.
StateFieldPathExpression	getExpression() Returns the actual parsed object if this StateObject representation of the JPQL query was created by parsing an existing JPQL query.
void	setExpression(StateFieldPathExpression 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.AbstractPathExpressionStateObject

addItem, addItems, addListChangeListener, append, canMoveDown, canMoveUp, getIdentificationVariable, getItem, getManagedType, getMapping, getMapping, getPath, getType, getTypeDeclaration, hasIdentificationVariable, hasItems, isEquivalent, items, itemsSize, moveDown, moveUp, removeItem, removeItem, removeItems, removeListChangeListener, setIdentificationVariable, setPath, setPath, setPaths, setPaths, setPaths

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

addPropertyChangeListener, children, decorate, equals, findIdentificationVariable, getDeclaration, getDecorator, getGrammar, getManagedTypeProvider, getParent, getQueryBuilder, getRoot, getType, getType, getTypeHelper, getTypeRepository, hashCode, isDecorated, removePropertyChangeListener, setExpression, setParent, toString, toString, toText

Methods inherited from class java.lang.Object

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

Constructor Detail

StateFieldPathExpressionStateObject

public StateFieldPathExpressionStateObject(StateObject parent)

Creates a new StateFieldPathExpressionStateObject.

Parameters:

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

Throws:

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

StateFieldPathExpressionStateObject

public StateFieldPathExpressionStateObject(StateObject parent,
                                           java.lang.String path)

Creates a new StateFieldPathExpressionStateObject.

Parameters:

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

path - The state field 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.

Parameters:

visitor - The visitor to visit this object

getExpression

public StateFieldPathExpression 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 AbstractPathExpressionStateObject

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)

setExpression

public void setExpression(StateFieldPathExpression 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 state field path expression