Package com.blazebit.persistence.spi

Interface EntityManagerFactoryIntegrator

public interface EntityManagerFactoryIntegrator
Interface implemented by the criteria provider. It is used to integrate some features with the persistence provider.
Since:
1.0.0
Author:
Christian Beikov, Moritz Becker

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDbms(javax.persistence.EntityManagerFactory entityManagerFactory)
    Returns the name of dbms for which the given entity manager factory operates.
    JpaProviderFactory
    getJpaProviderFactory(javax.persistence.EntityManagerFactory entityManagerFactory)
    Returns the jpa provider factory for the jpa provider of the given entity manager factory.
    Map<String,JpqlFunction>
    getRegisteredFunctions(javax.persistence.EntityManagerFactory entityManagerFactory)
    Returns all registered functions as map with the function name as key and a JpqlFunction.
    javax.persistence.EntityManagerFactory
    registerFunctions(javax.persistence.EntityManagerFactory entityManagerFactory, Map<String,JpqlFunctionGroup> dbmsFunctions)
    Registers the given functions under the given names on the given entity manager factory.

  • Method Details

    • getDbms

      String getDbms(javax.persistence.EntityManagerFactory entityManagerFactory)
      Returns the name of dbms for which the given entity manager factory operates.
      Parameters:
      entityManagerFactory - Then entity manager factory for which to retrieve the dbms from
      Returns:
      The name of the dbms
      Since:
      1.1.0

    • getJpaProviderFactory

      JpaProviderFactory getJpaProviderFactory(javax.persistence.EntityManagerFactory entityManagerFactory)
      Returns the jpa provider factory for the jpa provider of the given entity manager factory.
      Parameters:
      entityManagerFactory - Then entity manager factory for which to retrieve jpa provider factory for
      Returns:
      The jpa provider factory
      Since:
      1.2.0

    • registerFunctions

      javax.persistence.EntityManagerFactory registerFunctions(javax.persistence.EntityManagerFactory entityManagerFactory, Map<String,JpqlFunctionGroup> dbmsFunctions)
      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.
      Parameters:
      entityManagerFactory - The entity manager factory which should be enriched
      dbmsFunctions - The functions for various dbms
      Returns:
      The enriched entity manager

    • getRegisteredFunctions

      Map<String,JpqlFunction> getRegisteredFunctions(javax.persistence.EntityManagerFactory entityManagerFactory)
      Returns all registered functions as map with the function name as key and a JpqlFunction.
      Parameters:
      entityManagerFactory - The entity manager factory which should be queried
      Returns:
      The registered functions