org.openmrs.api.db.hibernate

Class HibernateUtil

java.lang.Object

org.openmrs.api.db.hibernate.HibernateUtil

public class HibernateUtil
extends Object

This class holds common methods and utilities that are used across the hibernate related classes

Method Summary

Modifier and Type	Method and Description
static String	escapeSqlWildcards(String oldString, Connection connection) Escapes all sql wildcards in the given string, returns the same string if it doesn't contain any sql wildcards
static String	escapeSqlWildcards(String oldString, org.hibernate.SessionFactory sessionFactory)
static <AT extends AttributeType> List<javax.persistence.criteria.Predicate>	getAttributePredicate(javax.persistence.criteria.CriteriaBuilder cb, javax.persistence.criteria.Root<Location> locationRoot, Map<AT,String> serializedAttributeValues) Constructs a list of predicates for attribute value criteria for use in a JPA Criteria query.
static org.hibernate.dialect.Dialect	getDialect(org.hibernate.SessionFactory sessionFactory) Fetch the current Dialect of the given SessionFactory
static <T> T	getRealObjectFromProxy(T persistentObject) Gets an object as an instance of its persistent type if it is a hibernate proxy otherwise returns the same passed in object
static <T> org.hibernate.ScrollableResults	getScrollableResult(org.hibernate.SessionFactory sessionFactory, Class<T> type, int fetchSize) Creates a ScrollableResults instance for the given entity type with the specified fetch size.
static <T> T	getUniqueEntityByUUID(org.hibernate.SessionFactory sessionFactory, Class<T> entityClass, String uuid) Retrieves a unique entity by its UUID.
static boolean	isHSQLDialect(org.hibernate.SessionFactory sessionFactory) Check and cache whether the currect dialect is HSQL or not.
static boolean	isPostgreSQLDialect(org.hibernate.SessionFactory sessionFactory) Check and cache whether the currect dialect is PostgreSQL or not.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

isHSQLDialect

public static boolean isHSQLDialect(org.hibernate.SessionFactory sessionFactory)

Check and cache whether the currect dialect is HSQL or not. This is needed because some queries are different if in the hsql world as opposed to the mysql/postgres world

Parameters:

sessionFactory -

Returns:

true/false whether we're in hsql right now or not

isPostgreSQLDialect

public static boolean isPostgreSQLDialect(org.hibernate.SessionFactory sessionFactory)

Check and cache whether the currect dialect is PostgreSQL or not. This is needed because some behaviors of PostgreSQL and MySQL are different and need to be handled separately.

Parameters:

sessionFactory -

Returns:

true/false whether we're in postgresql right now or not

getDialect

public static org.hibernate.dialect.Dialect getDialect(org.hibernate.SessionFactory sessionFactory)

Fetch the current Dialect of the given SessionFactory

Parameters:

sessionFactory - SessionFactory to pull the dialect from

Returns:

Dialect of sql that this connection/session is using

escapeSqlWildcards

public static String escapeSqlWildcards(String oldString,
                                        org.hibernate.SessionFactory sessionFactory)

See Also:

escapeSqlWildcards(String, Connection)

escapeSqlWildcards

public static String escapeSqlWildcards(String oldString,
                                        Connection connection)

Escapes all sql wildcards in the given string, returns the same string if it doesn't contain any sql wildcards

Parameters:

oldString - the string in which to escape the sql wildcards

connection - The underlying database connection

Returns:

the string with sql wildcards escaped if any found otherwise the original string is returned

getAttributePredicate

public static <AT extends AttributeType> List<javax.persistence.criteria.Predicate> getAttributePredicate(javax.persistence.criteria.CriteriaBuilder cb,
                                                                                                          javax.persistence.criteria.Root<Location> locationRoot,
                                                                                                          Map<AT,String> serializedAttributeValues)

Constructs a list of predicates for attribute value criteria for use in a JPA Criteria query.

Type Parameters:

AT - The type of the attribute

Parameters:

cb - The CriteriaBuilder used to construct the CriteriaQuery

locationRoot - The root of the CriteriaQuery for the Location entity

serializedAttributeValues - A map of AttributeType to serialized attribute values

Returns:

A list of Predicate objects for use in a CriteriaQuery

getRealObjectFromProxy

public static <T> T getRealObjectFromProxy(T persistentObject)

Gets an object as an instance of its persistent type if it is a hibernate proxy otherwise returns the same passed in object

Parameters:

persistentObject - the object to unproxy

Returns:

the unproxied object

Since:

1.10

getUniqueEntityByUUID

public static <T> T getUniqueEntityByUUID(org.hibernate.SessionFactory sessionFactory,
                                          Class<T> entityClass,
                                          String uuid)
                                   throws DAOException

Retrieves a unique entity by its UUID.

Parameters:

sessionFactory - the session factory to create sessions.

entityClass - the class of the entity to retrieve.

uuid - the UUID of the entity.

Returns:

the entity if found, null otherwise.

Throws:

DAOException - if there's an issue in data access.

getScrollableResult

public static <T> org.hibernate.ScrollableResults getScrollableResult(org.hibernate.SessionFactory sessionFactory,
                                                                      Class<T> type,
                                                                      int fetchSize)

Creates a ScrollableResults instance for the given entity type with the specified fetch size.

Parameters:

sessionFactory - the session factory to create sessions.

type - the class type of the entity for which the ScrollableResults is created.

fetchSize - the number of rows to fetch in a batch.

Returns:

ScrollableResults instance for batch processing.