DynamicDaoHelperImpl (BroadleafCommerce 5.2.10-SNAPSHOT API)

java.lang.Object
- org.broadleafcommerce.common.util.dao.DynamicDaoHelperImpl

All Implemented Interfaces:: DynamicDaoHelper

public class DynamicDaoHelperImpl
extends Object
implements DynamicDaoHelper

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`JAVASSIST_PROXY_KEY_PHRASE`
`static Object`	`LOCK_OBJECT`
`static Map<org.hibernate.SessionFactory,Map<Class<?>,Class<?>[]>>`	`POLYMORPHIC_ENTITY_CACHE`
`static Map<org.hibernate.SessionFactory,Map<Class<?>,Class<?>[]>>`	`POLYMORPHIC_ENTITY_CACHE_WO_EXCLUSIONS`

Constructor Summary

Constructors
Constructor and Description

DynamicDaoHelperImpl()

Constructors
Constructor and Description
`DynamicDaoHelperImpl()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected Map<Class<?>,Class<?>[]>`	`buildPolymorphicEntityMap(Map<Class<?>,Class<?>[]> polymorphicEntityMap, Class<?> ceilingClass, Class<?>[] filteredEntities)`
`Class<?>[]`	`getAllPolymorphicEntitiesFromCeiling(Class<?> ceilingClass, org.hibernate.SessionFactory sessionFactory, boolean includeUnqualifiedPolymorphicEntities, boolean useCache)` Get all the polymorphic types known to Hibernate for the ceiling class provided.
`protected Class<?>[]`	`getCachedPolymorphicEntityList(Map<org.hibernate.SessionFactory,Map<Class<?>,Class<?>[]>> polymorphicEntityCache, org.hibernate.SessionFactory sessionFactory, Class<?> ceilingClass)`
`Serializable`	`getIdentifier(Object entity, javax.persistence.EntityManager em)` The value of the Hibernate registered identifier property for the entity instance.
`Serializable`	`getIdentifier(Object entity, org.hibernate.Session session)` The value of the Hibernate registered identifier property for the entity instance.
`Field`	`getIdField(Class<?> clazz, javax.persistence.EntityManager em)` The Field that represents the Hibernate registered identifier property for the entity class.
`Field`	`getIdField(Class<?> clazz, org.hibernate.Session session)` The Field that represents the Hibernate registered identifier property for the entity class.
`Map<String,Object>`	`getIdMetadata(Class<?> entityClass, org.hibernate.ejb.HibernateEntityManager entityManager)` Retrieve information about the id property for the entity class and the data type of that property.
`static Class<?>`	`getNonProxyImplementationClassIfNecessary(Class<?> candidate)`
`List<String>`	`getPropertyNames(Class<?> entityClass, org.hibernate.ejb.HibernateEntityManager entityManager)` Retrieve the list of property names known to Hibernate for the entity class.
`List<org.hibernate.type.Type>`	`getPropertyTypes(Class<?> entityClass, org.hibernate.ejb.HibernateEntityManager entityManager)` Retrieve the list of property types (`Type` known to Hibernate for the entity class.
`org.hibernate.SessionFactory`	`getSessionFactory(org.hibernate.ejb.HibernateEntityManager entityManager)` Get the SessionFactory instance from a HibernateEntityManager instance.
`Class<?>[]`	`getUpDownInheritance(Class<?> testClass, org.hibernate.SessionFactory sessionFactory, boolean includeUnqualifiedPolymorphicEntities, boolean useCache, EJB3ConfigurationDao ejb3ConfigurationDao)` Retrieve a complete polymorphic type list for an entity class, even if the entity class is not the ceiling class (or root of the hierarchy).
`boolean`	`isExcludeClassFromPolymorphism(Class<?> clazz)` Discover is a class should be excluded from a polymorphic list.
`Class<?>[]`	`sortEntities(Class<?> ceilingClass, List<Class<?>> entities)` Sort a list of polymorphic types with the most derived appearing first.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LOCK_OBJECT
```
public static final Object LOCK_OBJECT
```
  - POLYMORPHIC_ENTITY_CACHE
```
public static final Map<org.hibernate.SessionFactory,Map<Class<?>,Class<?>[]>> POLYMORPHIC_ENTITY_CACHE
```
  - POLYMORPHIC_ENTITY_CACHE_WO_EXCLUSIONS
```
public static final Map<org.hibernate.SessionFactory,Map<Class<?>,Class<?>[]>> POLYMORPHIC_ENTITY_CACHE_WO_EXCLUSIONS
```
  - JAVASSIST_PROXY_KEY_PHRASE
```
public static final String JAVASSIST_PROXY_KEY_PHRASE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DynamicDaoHelperImpl
```
public DynamicDaoHelperImpl()
```
- Method Detail
  - getNonProxyImplementationClassIfNecessary
```
public static Class<?> getNonProxyImplementationClassIfNecessary(Class<?> candidate)
```
  - getAllPolymorphicEntitiesFromCeiling
```
public Class<?>[] getAllPolymorphicEntitiesFromCeiling(Class<?> ceilingClass,
                                                       org.hibernate.SessionFactory sessionFactory,
                                                       boolean includeUnqualifiedPolymorphicEntities,
                                                       boolean useCache)
```
    Description copied from interface: DynamicDaoHelper
    
    Get all the polymorphic types known to Hibernate for the ceiling class provided. The ceiling class should be an entity class registered in Hibernate (or a specific interface unique to that entity class). The returned array is sorted with the most derived entities appearing first in the list.
    
    Specified by:
    
    getAllPolymorphicEntitiesFromCeiling in interface DynamicDaoHelper
    
    includeUnqualifiedPolymorphicEntities - Some entities may be excluded from polymorphism (Abstract class and those marked with AdminPresentationClass.excludeFromPolymorphism()). Override that exlusion behavior.
    
    useCache - Cache the polymorphic types discovered for the ceilingClass.
    
    Returns:
    
    The list of Hibernate registered entities that derive from the ceilingClass (including the ceilingClass)
  - getCachedPolymorphicEntityList
```
protected Class<?>[] getCachedPolymorphicEntityList(Map<org.hibernate.SessionFactory,Map<Class<?>,Class<?>[]>> polymorphicEntityCache,
                                                    org.hibernate.SessionFactory sessionFactory,
                                                    Class<?> ceilingClass)
```
  - buildPolymorphicEntityMap
```
protected Map<Class<?>,Class<?>[]> buildPolymorphicEntityMap(Map<Class<?>,Class<?>[]> polymorphicEntityMap,
                                                             Class<?> ceilingClass,
                                                             Class<?>[] filteredEntities)
```
  - getUpDownInheritance
```
public Class<?>[] getUpDownInheritance(Class<?> testClass,
                                       org.hibernate.SessionFactory sessionFactory,
                                       boolean includeUnqualifiedPolymorphicEntities,
                                       boolean useCache,
                                       EJB3ConfigurationDao ejb3ConfigurationDao)
```
    Description copied from interface: DynamicDaoHelper
    
    Retrieve a complete polymorphic type list for an entity class, even if the entity class is not the ceiling class (or root of the hierarchy). This allows you to possibly provide a mid-level entity class and get back a list of entity classes both above and below the testClass. The type list passed back is ordered with the ceiling class appearing first and the most derived classes appearing last.
    
    Specified by:
    
    getUpDownInheritance in interface DynamicDaoHelper
    
    Parameters:
    
    testClass - An entity class to look for polymorphic types both above and below
    
    includeUnqualifiedPolymorphicEntities - Some entities may be excluded from polymorphism (Abstract class and those marked with AdminPresentationClass.excludeFromPolymorphism()). Override that exlusion behavior.
    
    useCache - Cache the polymorphic types discovered for the ceilingClass.
    
    Returns:
    
    The list of Hibernate registered entities that appear above and below the testClass in an entity inheritance hierarchy
  - sortEntities
```
public Class<?>[] sortEntities(Class<?> ceilingClass,
                               List<Class<?>> entities)
```
    Description copied from interface: DynamicDaoHelper
    
    Sort a list of polymorphic types with the most derived appearing first.
    
    Specified by:
    
    sortEntities in interface DynamicDaoHelper
    
    Returns:
  - isExcludeClassFromPolymorphism
```
public boolean isExcludeClassFromPolymorphism(Class<?> clazz)
```
    Description copied from interface: DynamicDaoHelper
    
    Discover is a class should be excluded from a polymorphic list. Exclusion is generally enforced if the class is abstract or if the class is marked with AdminPresentationClass.excludeFromPolymorphism().
    
    Specified by:
    
    isExcludeClassFromPolymorphism in interface DynamicDaoHelper
    
    Returns:
  - getIdMetadata
```
public Map<String,Object> getIdMetadata(Class<?> entityClass,
                                        org.hibernate.ejb.HibernateEntityManager entityManager)
```
    Description copied from interface: DynamicDaoHelper
    
    Retrieve information about the id property for the entity class and the data type of that property. This will return a Map containing two members. The first will be keyed with the String "name" and will be the name of the id property on the entity class. The second will be keyed with the String "type" and will be the Hibernate Type instance for the property (e.g. LongType).
    
    Specified by:
    
    getIdMetadata in interface DynamicDaoHelper
    
    Returns:
  - getPropertyNames
```
public List<String> getPropertyNames(Class<?> entityClass,
                                     org.hibernate.ejb.HibernateEntityManager entityManager)
```
    Description copied from interface: DynamicDaoHelper
    
    Retrieve the list of property names known to Hibernate for the entity class.
    
    Specified by:
    
    getPropertyNames in interface DynamicDaoHelper
    
    Returns:
  - getPropertyTypes
```
public List<org.hibernate.type.Type> getPropertyTypes(Class<?> entityClass,
                                                      org.hibernate.ejb.HibernateEntityManager entityManager)
```
    Description copied from interface: DynamicDaoHelper
    
    Retrieve the list of property types (Type known to Hibernate for the entity class.
    
    Specified by:
    
    getPropertyTypes in interface DynamicDaoHelper
    
    Returns:
  - getSessionFactory
```
public org.hibernate.SessionFactory getSessionFactory(org.hibernate.ejb.HibernateEntityManager entityManager)
```
    Description copied from interface: DynamicDaoHelper
    
    Get the SessionFactory instance from a HibernateEntityManager instance.
    
    Specified by:
    
    getSessionFactory in interface DynamicDaoHelper
    
    Returns:
  - getIdentifier
```
public Serializable getIdentifier(Object entity,
                                  javax.persistence.EntityManager em)
```
    Description copied from interface: DynamicDaoHelper
    
    The value of the Hibernate registered identifier property for the entity instance.
    
    Specified by:
    
    getIdentifier in interface DynamicDaoHelper
    
    Returns:
  - getIdentifier
```
public Serializable getIdentifier(Object entity,
                                  org.hibernate.Session session)
```
    Description copied from interface: DynamicDaoHelper
    
    The value of the Hibernate registered identifier property for the entity instance.
    
    Specified by:
    
    getIdentifier in interface DynamicDaoHelper
    
    Returns:
  - getIdField
```
public Field getIdField(Class<?> clazz,
                        javax.persistence.EntityManager em)
```
    Description copied from interface: DynamicDaoHelper
    
    The Field that represents the Hibernate registered identifier property for the entity class.
    
    Specified by:
    
    getIdField in interface DynamicDaoHelper
    
    Returns:
  - getIdField
```
public Field getIdField(Class<?> clazz,
                        org.hibernate.Session session)
```
    Description copied from interface: DynamicDaoHelper
    
    The Field that represents the Hibernate registered identifier property for the entity class.
    
    Specified by:
    
    getIdField in interface DynamicDaoHelper
    
    Returns:

Class DynamicDaoHelperImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOCK_OBJECT

POLYMORPHIC_ENTITY_CACHE

POLYMORPHIC_ENTITY_CACHE_WO_EXCLUSIONS

JAVASSIST_PROXY_KEY_PHRASE

Constructor Detail

DynamicDaoHelperImpl

Method Detail

getNonProxyImplementationClassIfNecessary

getAllPolymorphicEntitiesFromCeiling

getCachedPolymorphicEntityList

buildPolymorphicEntityMap

getUpDownInheritance

sortEntities

isExcludeClassFromPolymorphism

getIdMetadata

getPropertyNames

getPropertyTypes

getSessionFactory

getIdentifier

getIdentifier

getIdField

getIdField