EclipseLink 2.4.2, build 'v20130514-5956486' API Reference

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

java.lang.Object
  extended by org.eclipse.persistence.jpa.jpql.model.query.AbstractStateObject
      extended by org.eclipse.persistence.jpa.jpql.model.query.CompoundExpressionStateObject
          extended by org.eclipse.persistence.jpa.jpql.model.query.ArithmeticExpressionStateObject
All Implemented Interfaces:
StateObject
Direct Known Subclasses:
AdditionExpressionStateObject, DivisionExpressionStateObject, MultiplicationExpressionStateObject, SubtractionExpressionStateObject

public abstract class ArithmeticExpressionStateObject
extends CompoundExpressionStateObject

This expression represents an arithmetic expression, which means the first and second expressions are aggregated with an arithmetic sign.

BNF: arithmetic_expression ::= arithmetic_expression <identifier> arithmetic_term

Version:
2.4
See Also:
AdditionExpressionStateObject, DivisionExpressionStateObject, MultiplicationExpressionStateObject, SubtractionExpressionStateObject, ArithmeticExpression
Author:
Pascal Filion
Since:
2.4

Field Summary
 
Fields inherited from class org.eclipse.persistence.jpa.jpql.model.query.CompoundExpressionStateObject
LEFT_STATE_OBJECT_PROPERTY, RIGHT_STATE_OBJECT_PROPERTY
 
Constructor Summary
protected ArithmeticExpressionStateObject(StateObject parent)
          Creates a new ArithmeticExpressionStateObject.
protected ArithmeticExpressionStateObject(StateObject parent, StateObject leftStateObject, StateObject rightStateObject)
          Creates a new ArithmeticExpressionStateObject.
protected ArithmeticExpressionStateObject(StateObject parent, java.lang.String leftJpqlFragment, java.lang.String rightJpqlFragment)
          Creates a new ArithmeticExpressionStateObject.
 
Method Summary
 ArithmeticExpression getExpression()
          Returns the actual parsed object if this StateObject representation of the JPQL query was created by parsing an existing JPQL query.
protected  java.lang.String getLeftQueryBNFId()
          Returns the unique identifier of the BNF that will be used to parse a JPQL fragment as the left side of the expression.
protected  java.lang.String getRightQueryBNFId()
          Returns the unique identifier of the BNF that will be used to parse a JPQL fragment as the right side of the expression.
 
Methods inherited from class org.eclipse.persistence.jpa.jpql.model.query.CompoundExpressionStateObject
addChildren, getIdentifier, getLeft, getRight, hasLeft, hasRight, isEquivalent, parseLeft, parseRight, setLeft, setRight, 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
 

Constructor Detail

ArithmeticExpressionStateObject

protected ArithmeticExpressionStateObject(StateObject parent)
Creates a new ArithmeticExpressionStateObject.

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

ArithmeticExpressionStateObject

protected ArithmeticExpressionStateObject(StateObject parent,
                                          StateObject leftStateObject,
                                          StateObject rightStateObject)
Creates a new ArithmeticExpressionStateObject.

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

ArithmeticExpressionStateObject

protected ArithmeticExpressionStateObject(StateObject parent,
                                          java.lang.String leftJpqlFragment,
                                          java.lang.String rightJpqlFragment)
Creates a new ArithmeticExpressionStateObject.

Parameters:
parent - The parent of this state object, which cannot be null
leftJpqlFragment - The string representation of the left expression to parse and to convert into a StateObject
rightJpqlFragment - The string representation of the right expression to parse and to convert into a StateObject
Throws:
java.lang.NullPointerException - The given parent cannot be null
Method Detail

getExpression

public ArithmeticExpression 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 CompoundExpressionStateObject
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)

getLeftQueryBNFId

protected java.lang.String getLeftQueryBNFId()
Returns the unique identifier of the BNF that will be used to parse a JPQL fragment as the left side of the expression.

Specified by:
getLeftQueryBNFId in class CompoundExpressionStateObject
Returns:
The query BNF ID for the left side of the expression

getRightQueryBNFId

protected java.lang.String getRightQueryBNFId()
Returns the unique identifier of the BNF that will be used to parse a JPQL fragment as the right side of the expression.

Specified by:
getRightQueryBNFId in class CompoundExpressionStateObject
Returns:
The query BNF ID for the right side of the expression

EclipseLink 2.4.2, build 'v20130514-5956486' API Reference