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

Class AbsExpressionStateObject

java.lang.Object

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

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

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

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

All Implemented Interfaces:

StateObject

public class AbsExpressionStateObject
extends AbstractSingleEncapsulatedExpressionStateObject

The ABS function removes the minus sign from a specified argument and returns the absolute value, which is always a positive number or zero.

This is one of the JPQL arithmetic functions. The ABS function takes a numeric argument and returns a number (integer, float, or double) of the same type as the argument to the function.

BNF: expression ::= ABS(simple_arithmetic_expression)

Since:

2.4

Version:

2.4

Author:

Pascal Filion

See Also:

AbsExpression

Field Summary

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

STATE_OBJECT_PROPERTY

Constructor Summary

Constructors

Constructor and Description
AbsExpressionStateObject(StateObject parent) Creates a new AbsExpressionStateObject.
AbsExpressionStateObject(StateObject parent, StateObject stateObject) Creates a new AbsExpressionStateObject.

Method Summary

Modifier and Type	Method and Description
void	accept(StateObjectVisitor visitor) Visits this StateObject by the given visitor.
AbsExpression	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 JPQL identifier of the expression represented by this AbstractSingleEncapsulatedExpressionStateObject.
void	setExpression(AbsExpression 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.
void	setStateObject(StateObject stateObject) Sets the given StateObject to represent the new encapsulated expression.

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

getStateObject, hasStateObject, isEquivalent, parse

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

Constructor Detail

AbsExpressionStateObject

public AbsExpressionStateObject(StateObject parent)

Creates a new AbsExpressionStateObject.

Parameters:

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

Throws:

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

AbsExpressionStateObject

public AbsExpressionStateObject(StateObject parent,
                                StateObject stateObject)

Creates a new AbsExpressionStateObject.

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

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 AbsExpression 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 AbstractSingleEncapsulatedExpressionStateObject

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 JPQL identifier of the expression represented by this AbstractSingleEncapsulatedExpressionStateObject.

Specified by:

getIdentifier in class AbstractEncapsulatedExpressionStateObject

Returns:

The JPQL identifier that is shown before the left parenthesis

setExpression

public void setExpression(AbsExpression 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 ABS expression

setStateObject

public void setStateObject(StateObject stateObject)

Sets the given StateObject to represent the new encapsulated expression.

Parameters:

stateObject - The new encapsulated StateObject