org.eclipse.persistence.jpa.jpql.parser.AbsExpression Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of eclipselink Show documentation

EclipseLink build based upon Git transaction f2b9fc5

The newest version!

/*
 * Copyright (c) 2006, 2021 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0,
 * or the Eclipse Distribution License v. 1.0 which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
 */

// Contributors:
//     Oracle - initial API and implementation
//
package org.eclipse.persistence.jpa.jpql.parser;

/**
 * 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.
 * 

 * JPA 1.0, 2.0:
 * 
BNF: expression ::= ABS(simple_arithmetic_expression)
 * 

 * JPA 2.1:
 * BNF: expression ::= ABS(arithmetic_expression)
 * 
 * Example: SELECT DISTINCT o FROM Order o WHERE o.totalPrice {@literal >} ABS(:dbl)
 *
 * @version 2.5
 * @since 2.3
 * @author Pascal Filion
 */
public final class AbsExpression extends AbstractSingleEncapsulatedExpression {

    /**
     * Creates a new AbsExpression.
     *
     * @param parent The parent of this expression
     */
    public AbsExpression(AbstractExpression parent) {
        super(parent, ABS);
    }

    @Override
    public void accept(ExpressionVisitor visitor) {
        visitor.visit(this);
    }

    @Override
    public String getEncapsulatedExpressionQueryBNFId() {
        return SimpleArithmeticExpressionBNF.ID;
    }

    @Override
    public JPQLQueryBNF getQueryBNF() {
        return getQueryBNF(FunctionsReturningNumericsBNF.ID);
    }
}