com.blazebit.persistence.spi.EntityManagerFactoryIntegrator Maven / Gradle / Ivy

/*
 * Copyright 2014 - 2020 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.spi;

import javax.persistence.EntityManagerFactory;
import java.util.Map;

/**
 * Interface implemented by the criteria provider.
 *
 * It is used to integrate some features with the persistence provider.
 *
 * @author Christian Beikov
 * @author Moritz Becker
 * @since 1.0.0
 */
public interface EntityManagerFactoryIntegrator {
    
    /**
     * Returns the name of dbms for which the given entity manager factory operates.
     * 
     * @param entityManagerFactory Then entity manager factory for which to retrieve the dbms from
     * @return The name of the dbms
     * @since 1.1.0
     */
    public String getDbms(EntityManagerFactory entityManagerFactory);

    /**
     * Returns the jpa provider factory for the jpa provider of the given entity manager factory.
     *
     * @param entityManagerFactory Then entity manager factory for which to retrieve jpa provider factory for
     * @return The jpa provider factory
     * @since 1.2.0
     */
    public JpaProviderFactory getJpaProviderFactory(EntityManagerFactory entityManagerFactory);

    /**
     * Registers the given functions under the given names on the given entity manager factory.
     * The dbmsFunctions map the function name to a map of dbms specific functions.
     * The dbms specific functions map uses a dbms identifier as key.
     *
     * @param entityManagerFactory The entity manager factory which should be enriched
     * @param dbmsFunctions The functions for various dbms
     * @return The enriched entity manager
     */
    public EntityManagerFactory registerFunctions(EntityManagerFactory entityManagerFactory, Map dbmsFunctions);

    /**
     * Returns all registered functions as map with the function name as key and a {@link JpqlFunction}.
     *
     * @param entityManagerFactory The entity manager factory which should be queried
     * @return The registered functions
     */
    public Map getRegisteredFunctions(EntityManagerFactory entityManagerFactory);
}