Package cz.cvut.kbss.jopa.model

Interface EntityManagerFactory

All Superinterfaces:
AutoCloseable
All Known Implementing Classes:
EntityManagerFactoryImpl
public interface EntityManagerFactory extends AutoCloseable

  • Method Details

    • createEntityManager

      EntityManager createEntityManager()
      Create a new application-managed EntityManager. This method returns a new EntityManager instance each time it is invoked. The isOpen method will return true on the returned instance.
      Returns:
      entity manager instance
      Throws:
      IllegalStateException - if the entity manager factory has been closed

    • createEntityManager

      EntityManager createEntityManager(Map<String,String> map)
      Create a new EntityManager with the specified Map of properties. This method returns a new EntityManager instance each time it is invoked. The isOpen method will return true on the returned instance.
      Parameters:
      map - properties for entity manager
      Returns:
      entity manager instance

    • getCriteriaBuilder

      CriteriaBuilder getCriteriaBuilder()
      Returns an instance of CriteriaBuilder which may be used to construct CriteriaQuery objects.
      Returns:
      an instance of CriteriaBuilder
      Throws:
      IllegalStateException - if the entity manager factory has been closed

    • getMetamodel

      Metamodel getMetamodel()
      Return an instance of Metamodel interface for access to the metamodel of the persistence unit.
      Returns:
      Metamodel instance
      Throws:
      IllegalStateException - if the entity manager factory has been closed

    • close

      void close()
      Close the factory, releasing any resources that it holds. After a factory instance is closed, all methods invoked on it will throw an IllegalStateException, except for isOpen, which will return false. Once an EntityManagerFactory has been closed, all its entity managers are considered to be in the closed state.
      Specified by:
      close in interface AutoCloseable
      Throws:
      IllegalStateException - if the entity manager factory has been closed

    • isOpen

      boolean isOpen()
      Indicates whether the factory is open. Returns true until the factory has been closed.
      Returns:
      true if the entity manager is open
      Throws:
      IllegalStateException - if the entity manager factory has been closed

    • getProperties

      Map<String,String> getProperties()
      Get the properties and associated values that are in effect for the entity manager factory.

      Changing the contents of the map does not change the configuration in effect.

      Returns:
      properties
      Throws:
      IllegalStateException - if the entity manager factory has been closed

    • getCache

      Cache getCache()
      Access the cache that is associated with the entity manager factory (the "second level cache").
      Returns:
      instance of the Cache interface
      Throws:
      IllegalStateException - if the entity manager factory has been closed

    • getPersistenceUnitUtil

      PersistenceUnitUtil getPersistenceUnitUtil()
      Return interface providing access to utility methods for the persistence unit.
      Returns:
      PersistenceUnitUtil interface
      Throws:
      IllegalStateException - if the entity manager factory has been closed

    • addNamedQuery

      void addNamedQuery(String name, Query query)
      Define the query or typed query as a named query such that future query objects can be created from it using the createNamedQuery method. Any configuration of the query object (except for actual parameter binding) in effect when the named query is added is retained as part of the named query definition. This includes configuration information such as max results and result set mapping information.

      When the query is executed, information that can be set by means of the query APIs can be overridden. Information that is overridden does not affect the named query as registered with the entity manager factory, and thus does not affect subsequent query objects created from it by means of the createNamedQuery method.

      If a named query of the same name has been previously defined, either statically via metadata or via this method, that query definition is replaced.

      Parameters:
      name - name for the query
      query - Query or TypedQuery object
      Since:
      JPA 2.1

    • unwrap

      <T> T unwrap(Class<T> cls)
      Return an object of the specified type to allow access to the provider-specific API. If the provider's EntityManagerFactory implementation does not support the specified class, the OWLPersistenceException is thrown.
      Parameters:
      cls - The class of the object to be returned. This can be also an implementation of the underlying driver
      Returns:
      an instance of the specified class
      Throws:
      OWLPersistenceException - If the provider does not support the specified class