org.eclipse.persistence.jpa.jpql.parser.VersionExpression 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) 2024 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 result of an VERSION function expression is value Entity @Version field.
 * Argument must be an identification variable.
 * It's pure JPQL function which is transformed into {@link StateFieldPathExpression}
 *
 * BNF: expression ::= VERSION(identification_variable)
 *
 * @since 5.0
 * @author Radek Felcman
 */
public final class VersionExpression extends EncapsulatedIdentificationVariableExpression {

    /**
     * The field path created as a result of transformation
     */
    private StateFieldPathExpression stateFieldPathExpression;

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

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

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

    /**
     * Returns field path created as a result of transformation.
     *
     * @return The path expression that is qualified by the identification variable
     */
    public StateFieldPathExpression getStateFieldPathExpression() {
        return stateFieldPathExpression;
    }

    /**
     * Sets field path created as a result of transformation.
     */
    public void setStateFieldPathExpression(StateFieldPathExpression stateFieldPathExpression) {
        this.stateFieldPathExpression = stateFieldPathExpression;
    }
}