org.eclipse.persistence.internal.jpa.querydef.SelectionImpl 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) 2011, 2021 Oracle and/or its affiliates. All rights reserved.
 * Copyright (c) 2021 IBM Corporation. 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:
//     Gordon Yorke - Initial development
//
package org.eclipse.persistence.internal.jpa.querydef;

import java.io.Serializable;
import java.util.List;

import jakarta.persistence.criteria.Selection;

import org.eclipse.persistence.expressions.Expression;
import org.eclipse.persistence.internal.localization.ExceptionLocalization;

/**
 * 
 * Purpose: Contains the implementation of the Selection interface of the JPA
 * criteria API.
 * 
 * Description: The Selection is the expression describing what should be returned by the query.
 *
 * @see jakarta.persistence.criteria Join
 *
 * @author gyorke
 * @since EclipseLink 1.2
 */
public abstract class SelectionImpl implements Selection, InternalSelection, Serializable{

    protected Class javaType;
    protected Expression currentNode;

    /**
     * Returns the current EclipseLink expression at this node in the criteria expression tree
     * @return the currentNode
     */
    @Override
    public Expression getCurrentNode() {
        return currentNode;
    }

    protected String alias;

    public SelectionImpl(Class javaType, Expression expressionNode){
        this.javaType = javaType;
        this.currentNode = expressionNode;
    }

    // Allows complete clone of the instance
    protected SelectionImpl(Class javaType, Expression expressionNode, String alias) {
        this.javaType = javaType;
        this.currentNode = expressionNode;
        this.alias = alias;
    }

    //SELECTION
    /**
     * Assign an alias to the selection.
     *
     * @param name
     *            alias
     */
    @Override
    public Selection alias(String name) {
        this.alias = name;
        return this;
    }


    @Override
    public String getAlias() {
        return this.alias;
    }

    @Override
    public Class getJavaType() {
        return this.javaType;
    }

    public void setJavaType(Class javaType) {
        this.javaType = javaType;
    }

    /**
     * Return selection items composing a compound selection
     * @return list of selection items
     * @throws IllegalStateException if selection is not a compound
     *           selection
     */
    @Override
    public List> getCompoundSelectionItems(){
        throw new IllegalStateException(ExceptionLocalization.buildMessage("CRITERIA_NOT_A_COMPOUND_SELECTION"));
    }

    /**
     * Whether the selection item is a compound selection
     * @return boolean
     */
    @Override
    public boolean isCompoundSelection(){
        return false;
    }

    @Override
    public boolean isFrom(){
        return false;
    }
    @Override
    public boolean isRoot(){
        return false;
    }
    @Override
    public boolean isConstructor(){
        return false;
    }


}