EclipseLink 2.4.2, build 'v20130514-5956486' API Reference

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

java.lang.Object
  extended by org.eclipse.persistence.jpa.jpql.model.query.AbstractStateObject
      extended by org.eclipse.persistence.jpa.jpql.model.query.AbstractPathExpressionStateObject
          extended by org.eclipse.persistence.jpa.jpql.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

Version:
2.4
See Also:
StateFieldPathExpression
Author:
Pascal Filion
Since:
2.4

Nested Class Summary
protected static class StateFieldPathExpressionStateObject.MapManagedType
           
 
Field Summary
 
Fields inherited from class org.eclipse.persistence.jpa.jpql.model.query.AbstractPathExpressionStateObject
IDENTIFICATION_VARIABLE_PROPERTY, PATHS_LIST
 
Constructor Summary
StateFieldPathExpressionStateObject(StateObject parent)
          Creates a new StateFieldPathExpressionStateObject.
StateFieldPathExpressionStateObject(StateObject parent, java.lang.String path)
          Creates a new StateFieldPathExpressionStateObject.
 
Method Summary
 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.
protected  IManagedType resolveManagedType()
          Resolves
protected  IType resolveType()
          Resolves the IType of the property handled by this object.
 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.model.query.AbstractPathExpressionStateObject
addChildren, addItem, addItems, addListChangeListener, append, canMoveDown, canMoveUp, clearResolvedObjects, getIdentificationVariable, getItem, getManagedType, getMapping, getMapping, getPath, getType, getTypeDeclaration, hasIdentificationVariable, hasItems, initialize, isEquivalent, items, itemsSize, moveDown, moveUp, removeItem, removeItem, removeItems, removeListChangeListener, resolveMappings, resolveTypeDeclaration, setIdentificationVariable, setIdentificationVariableInternally, setPath, setPath, setPaths, setPaths, setPaths, 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
 
Methods inherited from interface org.eclipse.persistence.jpa.jpql.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)

resolveManagedType

protected IManagedType resolveManagedType()
Resolves

Specified by:
resolveManagedType in class AbstractPathExpressionStateObject
Returns:

resolveType

protected IType resolveType()
Resolves the IType of the property handled by this object.

Specified by:
resolveType in class AbstractPathExpressionStateObject
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(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

EclipseLink 2.4.2, build 'v20130514-5956486' API Reference