com.blazebit.persistence.view.SubqueryProviderFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of blaze-persistence-entity-view-api-jar Show documentation

There is a newer version: 1.6.14

Show newest version

/*
 * Copyright 2014 - 2019 Blazebit.
 *
 * 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
 *
 *      http://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 com.blazebit.persistence.view;

import com.blazebit.persistence.ParameterHolder;

import java.util.Map;

/**
 * A factory for creating a {@link SubqueryProvider}.
 * 
 * @author Christian Beikov
 * @since 1.4.0
 */
public interface SubqueryProviderFactory {

    /**
     * Returns whether the {@link SubqueryProvider} is parameterized or not.
     *
     * @return whether the {@link SubqueryProvider} is parameterized or not
     */
    public boolean isParameterized();

    /**
     * Creates and returns a new subquery provider for the given parameters.
     *
     * @param parameterHolder The parameter holder i.e. a {@link com.blazebit.persistence.CriteriaBuilder}
     * @param optionalParameters The optional parameter map
     * @return the subquery provider
     */
    public SubqueryProvider create(ParameterHolder parameterHolder, Map optionalParameters);
}