io.micronaut.data.model.jpa.criteria.PersistentEntitySubquery Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of micronaut-data-model Show documentation

Data Repository Support for Micronaut

The newest version!

/*
 * Copyright 2017-2021 original authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.micronaut.data.model.jpa.criteria;

import io.micronaut.core.annotation.Experimental;
import io.micronaut.core.annotation.NonNull;
import jakarta.persistence.criteria.Expression;
import jakarta.persistence.criteria.Predicate;
import jakarta.persistence.criteria.Subquery;
import jakarta.persistence.metamodel.EntityType;

import java.util.List;

/**
 * The persistent entity {@link Subquery}.
 *
 * @param  The type of the selected item
 * @author Denis Stepanov
 * @since 4.10
 */
@Experimental
public interface PersistentEntitySubquery extends Subquery, PersistentEntityQuery {

    @Override
    @NonNull
    PersistentEntitySubquery limit(int limit);

    @Override
    @NonNull
    PersistentEntitySubquery offset(int offset);

    @Override
    @NonNull
     PersistentEntityRoot from(@NonNull Class entityClass);

    @Override
    @NonNull
     PersistentEntityRoot from(@NonNull EntityType entity);

    @Override
    PersistentEntitySubquery select(@NonNull Expression expression);

    @Override
    @NonNull
    PersistentEntitySubquery where(@NonNull Expression restriction);

    @Override
    @NonNull
    PersistentEntitySubquery where(@NonNull Predicate... restrictions);

    @Override
    @NonNull
    PersistentEntitySubquery groupBy(@NonNull Expression... grouping);

    @Override
    @NonNull
    PersistentEntitySubquery groupBy(@NonNull List> grouping);

    @Override
    @NonNull
    PersistentEntitySubquery having(@NonNull Expression restriction);

    @Override
    @NonNull
    PersistentEntitySubquery having(@NonNull Predicate... restrictions);

    @Override
    @NonNull
    PersistentEntitySubquery distinct(boolean distinct);

    /**
     * @return The expression type
     */
    ExpressionType getExpressionType();

}