jpa/org.eclipse.persistence.jpa.jpql/src/main/java/org/eclipse/persistence/jpa/jpql/parser/DatabaseType.java

/*
 * Copyright (c) 2012, 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;

import org.eclipse.persistence.jpa.jpql.WordParser;

/**
 * This expression represents the database specific data type, which may include size and scale.
 *
 * <div><b>BNF:</b> <code>database_type ::= data_type_literal [( [numeric_literal [, numeric_literal]] )]</code></div>
 *
 * <div><b>BNF:</b> <code>data_type_literal ::= [CHAR, VARCHAR, NUMERIC, INTEGER, DATE, TIME, TIMESTAMP, etc]</code></div>
 * <p>
 * Example: <code>CASE(e.name AS VARCHAR(20))</code>
 *
 * @version 2.5
 * @since 2.4
 * @author Pascal Filion
 */
public final class DatabaseType extends AbstractDoubleEncapsulatedExpression {

    /**
     * Creates a new <code>DatabaseType</code>.
     *
     * @param parent The parent of this expression
     * @param databaseType The database type
     */
    public DatabaseType(AbstractExpression parent, String databaseType) {
        super(parent, databaseType);
    }

    @Override
    public void accept(ExpressionVisitor visitor) {
        acceptUnknownVisitor(visitor);
    }

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

    @Override
    protected boolean isSecondExpressionOptional() {
        return true;
    }

    @Override
    public String parameterExpressionBNF(int index) {
        return NumericLiteralBNF.ID;
    }

    @Override
    protected boolean shouldParseRightParenthesis(WordParser wordParser, boolean tolerant) {
        // If the database type uses parenthesis, then this expression will own the right
        // parenthesis,otherwise its parent expression should own it
        return hasLeftParenthesis() || hasFirstExpression() || hasComma() || hasSecondExpression();
    }
}