org.eclipse.persistence.jpa.jpql.parser.InternalOrderByItemBNF 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) 2006, 2020 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 query BNF for an order by item.
 * 
 * JPA 1.0: 
BNF: orderby_item ::= state_field_path_expression [ ASC | DESC ]
 * 
 * JPA 2.0 
BNF: orderby_item ::= state_field_path_expression | result_variable [ ASC | DESC ]
 *
 * @version 2.5.1
 * @since 2.3
 * @author Pascal Filion
 */
@SuppressWarnings("nls")
public final class InternalOrderByItemBNF extends JPQLQueryBNF {

    /**
     * The unique identifier for this InternalOrderByItemBNF.
     */
    public static final String ID = "internal_orderby_item";

    /**
     * Creates a new InternalOrderByItemBNF.
     */
    public InternalOrderByItemBNF() {
        super(ID);
    }

    @Override
    protected void initialize() {
        super.initialize();
        setHandleAggregate(true); // For invalid queries
        setFallbackBNFId(ID);
        setFallbackExpressionFactoryId(InternalOrderByItemFactory.ID);
        registerChild(IdentificationVariableBNF.ID);
        registerChild(StateFieldPathExpressionBNF.ID);
    }
}