io.micronaut.data.processor.model.criteria.SourcePersistentEntityCriteriaBuilder Maven / Gradle / Ivy

Go to download

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

Data Repository Support for Micronaut

There is a newer version: 4.10.3

Show 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.processor.model.criteria;

import io.micronaut.core.annotation.Experimental;
import io.micronaut.core.annotation.NonNull;
import io.micronaut.core.annotation.Nullable;
import io.micronaut.data.model.PersistentProperty;
import io.micronaut.data.model.PersistentPropertyPath;
import io.micronaut.data.model.jpa.criteria.PersistentEntityCriteriaBuilder;
import io.micronaut.inject.ast.ParameterElement;
import jakarta.persistence.criteria.ParameterExpression;

/**
 * The source persistent entity extension of {@link PersistentEntityCriteriaBuilder}.
 *
 * @author Denis Stepanov
 * @since 3.2
 */
@Experimental
public interface SourcePersistentEntityCriteriaBuilder extends PersistentEntityCriteriaBuilder {

    /**
     * Create parameter expression from {@link ParameterElement}.
     *
     * @param property   The property
     * @param expression The expression
     * @param         The expression type
     * @return new parameter
     */
    @NonNull
     ParameterExpression expression(@NonNull PersistentProperty property, @NonNull String expression);

    /**
     * Create parameter expression from {@link ParameterElement}.
     *
     * @param parameterElement The parameter element
     * @param propertyPath     The property path this parameter is representing
     * @param               The expression type
     * @return new parameter
     */
    @NonNull
     ParameterExpression parameter(@NonNull ParameterElement parameterElement,
                                         @Nullable PersistentPropertyPath propertyPath);

    /**
     * Create parameter expression from {@link ParameterElement} that is representing an entity instance.
     *
     * @param entityParameter The entity parameter element
     * @param propertyPath     The property path this parameter is representing
     * @param              The expression type
     * @return new parameter
     */
    @NonNull
     ParameterExpression entityPropertyParameter(@NonNull ParameterElement entityParameter,
                                                       @Nullable PersistentPropertyPath propertyPath);
}