org.eclipse.persistence.jpa.jpql.parser.ReplaceExpression 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

There is a newer version: 5.0.0-B03

/*
 * Copyright (c) 2023 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 second and third arguments of the REPLACE function denote the pattern to replace and
 * replacement string. These arguments are strings. The REPLACE function returns a string.
 * 

 * Jakarta Persistence 3.2:
 * BNF ::= REPLACE(string_expression, string_expression , string_expression)
 *
 * Example: UPDATE Employee e SET e.firstName = REPLACE('TopLink Workbench', 'Top', 'Eclipse')
 *
 * @since 4.1
 * @author Radek Felcman
 */
public final class ReplaceExpression extends AbstractTripleEncapsulatedExpression {

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

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

    @Override
    public String getParameterQueryBNFId(int index) {
        return switch (index) {
            case 0 -> InternalReplaceStringExpressionBNF.ID;
            default -> InternalReplacePositionExpressionBNF.ID;
        };
    }

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

    @Override
    protected boolean isThirdExpressionOptional() {
        return false;
    }
}