EclipseLink 2.4.2, build 'v20130514-5956486' API Reference

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

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
              extended by org.eclipse.persistence.jpa.jpql.model.query.AdditionExpressionStateObject
All Implemented Interfaces:
StateObject

public class AdditionExpressionStateObject
extends ArithmeticExpressionStateObject

TODO:

BNF: arithmetic_expression ::= arithmetic_expression + arithmetic_term

Version:
2.4
See Also:
AdditionExpression
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
AdditionExpressionStateObject(StateObject parent)
          Creates a new AdditionExpressionStateObject.
AdditionExpressionStateObject(StateObject parent, StateObject leftStateObject, StateObject rightStateObject)
          Creates a new AdditionExpressionStateObject.
AdditionExpressionStateObject(StateObject parent, java.lang.String leftJpqlFragment, java.lang.String rightJpqlFragment)
          Creates a new AdditionExpressionStateObject.
 
Method Summary
 void accept(StateObjectVisitor visitor)
          Visits this StateObject by the given visitor.
 AdditionExpression getExpression()
          Returns the actual parsed object if this StateObject representation of the JPQL query was created by parsing an existing JPQL query.
 java.lang.String getIdentifier()
          Returns the identifier joining the two StateObjects.
 void setExpression(AdditionExpression 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.ArithmeticExpressionStateObject
getLeftQueryBNFId, getRightQueryBNFId
 
Methods inherited from class org.eclipse.persistence.jpa.jpql.model.query.CompoundExpressionStateObject
addChildren, 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
 

Constructor Detail

AdditionExpressionStateObject

public AdditionExpressionStateObject(StateObject parent)
Creates a new AdditionExpressionStateObject.

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

AdditionExpressionStateObject

public AdditionExpressionStateObject(StateObject parent,
                                     StateObject leftStateObject,
                                     StateObject rightStateObject)
Creates a new AdditionExpressionStateObject.

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

AdditionExpressionStateObject

public AdditionExpressionStateObject(StateObject parent,
                                     java.lang.String leftJpqlFragment,
                                     java.lang.String rightJpqlFragment)
Creates a new AdditionExpressionStateObject.

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

accept

public void accept(StateObjectVisitor visitor)
Visits this StateObject by the given visitor.

Parameters:
visitor - The visitor to visit this object

getExpression

public AdditionExpression 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 ArithmeticExpressionStateObject
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)

getIdentifier

public java.lang.String getIdentifier()
Returns the identifier joining the two StateObjects.

Specified by:
getIdentifier in class CompoundExpressionStateObject
Returns:
The JPQL identifier join two expressions

setExpression

public void setExpression(AdditionExpression 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 an addition expression

EclipseLink 2.4.2, build 'v20130514-5956486' API Reference