EclipseLink 2.4.2, build 'v20130514-5956486' API Reference

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

java.lang.Object
  extended by org.eclipse.persistence.jpa.jpql.model.query.AbstractStateObject
      extended by org.eclipse.persistence.jpa.jpql.model.query.AbstractEncapsulatedExpressionStateObject
          extended by org.eclipse.persistence.jpa.jpql.model.query.AbstractSingleEncapsulatedExpressionStateObject
All Implemented Interfaces:
StateObject
Direct Known Subclasses:
AbsExpressionStateObject, AggregateFunctionStateObject, AllOrAnyExpressionStateObject, EncapsulatedIdentificationVariableExpressionStateObject, ExistsExpressionStateObject, LengthExpressionStateObject, LowerExpressionStateObject, SizeExpressionStateObject, SqrtExpressionStateObject, SubExpressionStateObject, TrimExpressionStateObject, TypeExpressionStateObject, UpperExpressionStateObject

public abstract class AbstractSingleEncapsulatedExpressionStateObject
extends AbstractEncapsulatedExpressionStateObject

This StateObject represents a JPQL expression that has a JPQL identifier followed by an encapsulated expression with parenthesis.

BNF: expression ::= <identifier>(expression)

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

Field Summary
static java.lang.String STATE_OBJECT_PROPERTY
          Notifies the encapsulated StateObject has changed.
 
Constructor Summary
protected AbstractSingleEncapsulatedExpressionStateObject(StateObject parent)
          Creates a new AbstractSingleEncapsulatedExpressionStateObject.
protected AbstractSingleEncapsulatedExpressionStateObject(StateObject parent, StateObject stateObject)
          Creates a new AbstractSingleEncapsulatedExpressionStateObject.
protected AbstractSingleEncapsulatedExpressionStateObject(StateObject parent, java.lang.String jpqlFragment)
          Creates a new AbstractSingleEncapsulatedExpressionStateObject.
 
Method Summary
protected  void addChildren(java.util.List<StateObject> children)
          Adds the children of this StateObject to the given list.
 AbstractSingleEncapsulatedExpression getExpression()
          Returns the actual parsed object if this StateObject representation of the JPQL query was created by parsing an existing JPQL query.
protected abstract  java.lang.String getQueryBNFId()
          Returns the unique identifier of the JPQLQueryBNF that will determine how to parse the encapsulated expression.
 StateObject getStateObject()
          Returns the encapsulated StateObject.
 boolean hasStateObject()
          Determines whether the StateObject representing the encapsulated expression is present or not.
 boolean isEquivalent(StateObject stateObject)
          Determines whether the given StateObject is equivalent to this one, i.e. the information of both StateObject is the same.
 void parse(java.lang.String jpqlFragment)
          Parses the given JPQL fragment, which represents the encapsulated expression, and creates the StateObject.
protected  void setStateObject(StateObject stateObject)
          Sets the given StateObject to represent the new encapsulated expression.
protected  void toTextEncapsulatedExpression(java.lang.Appendable writer)
          Prints out a string representation of this encapsulated information, which should not be used to define a true string representation of a JPQL query but should be used for debugging purposes.
 
Methods inherited from class org.eclipse.persistence.jpa.jpql.model.query.AbstractEncapsulatedExpressionStateObject
getIdentifier, 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, initialize, 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
accept
 

Field Detail

STATE_OBJECT_PROPERTY

public static final java.lang.String STATE_OBJECT_PROPERTY
Notifies the encapsulated StateObject has changed.

See Also:
Constant Field Values
Constructor Detail

AbstractSingleEncapsulatedExpressionStateObject

protected AbstractSingleEncapsulatedExpressionStateObject(StateObject parent)
Creates a new AbstractSingleEncapsulatedExpressionStateObject.

Parameters:
parent - The parent of this state object, which cannot be null
Throws:
java.lang.NullPointerException - The given parent cannot be null

AbstractSingleEncapsulatedExpressionStateObject

protected AbstractSingleEncapsulatedExpressionStateObject(StateObject parent,
                                                          StateObject stateObject)
Creates a new AbstractSingleEncapsulatedExpressionStateObject.

Parameters:
parent - The parent of this state object, which cannot be null
stateObject - The StateObject representing the encapsulated expression
Throws:
java.lang.NullPointerException - The given parent cannot be null

AbstractSingleEncapsulatedExpressionStateObject

protected AbstractSingleEncapsulatedExpressionStateObject(StateObject parent,
                                                          java.lang.String jpqlFragment)
Creates a new AbstractSingleEncapsulatedExpressionStateObject.

Parameters:
parent - The parent of this state object, which cannot be null
jpqlFragment - The portion of the query representing the encapsulated expression
Throws:
java.lang.NullPointerException - The given parent cannot be null
Method Detail

addChildren

protected void addChildren(java.util.List<StateObject> children)
Adds the children of this StateObject to the given list.

Overrides:
addChildren in class AbstractStateObject
Parameters:
children - The list used to store the children

getExpression

public AbstractSingleEncapsulatedExpression 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 AbstractEncapsulatedExpressionStateObject
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)

getQueryBNFId

protected abstract java.lang.String getQueryBNFId()
Returns the unique identifier of the JPQLQueryBNF that will determine how to parse the encapsulated expression.

Returns:
The non-null ID of the BNF

getStateObject

public StateObject getStateObject()
Returns the encapsulated StateObject.

Returns:
The encapsulated StateObject

hasStateObject

public boolean hasStateObject()
Determines whether the StateObject representing the encapsulated expression is present or not.

Returns:
true if the encapsulated StateObject is not null; false otherwise

isEquivalent

public boolean isEquivalent(StateObject stateObject)
Determines whether the given StateObject is equivalent to this one, i.e. the information of both StateObject is the same.

Specified by:
isEquivalent in interface StateObject
Overrides:
isEquivalent in class AbstractStateObject
Parameters:
stateObject - The StateObject to compare its content to this one
Returns:
true if both object are equivalent; false otherwise

parse

public void parse(java.lang.String jpqlFragment)
Parses the given JPQL fragment, which represents the encapsulated expression, and creates the StateObject.

Parameters:
jpqlFragment - The portion of the query representing the encapsulated expression

setStateObject

protected void setStateObject(StateObject stateObject)
Sets the given StateObject to represent the new encapsulated expression.

Parameters:
stateObject - The new encapsulated StateObject

toTextEncapsulatedExpression

protected void toTextEncapsulatedExpression(java.lang.Appendable writer)
                                     throws java.io.IOException
Prints out a string representation of this encapsulated information, which should not be used to define a true string representation of a JPQL query but should be used for debugging purposes.

Specified by:
toTextEncapsulatedExpression in class AbstractEncapsulatedExpressionStateObject
Parameters:
writer - The writer used to print out the string representation of the encapsulated information
Throws:
java.io.IOException - This should never happens, only required because Appendable is used instead of StringBuilder for instance

EclipseLink 2.4.2, build 'v20130514-5956486' API Reference