com.broadleafcommerce.enterprise.common.dao.batch

Class DefaultSandBoxCollectionHelper

java.lang.Object

com.broadleafcommerce.enterprise.common.dao.batch.DefaultSandBoxCollectionHelper

All Implemented Interfaces:

SandBoxCollectionHelper

public class DefaultSandBoxCollectionHelper
extends Object
implements SandBoxCollectionHelper

Default implementation. This class can describe a wide range of collection configurations and is used any time the system initializes a sandboxable collection.

Author:

Jeff Fischer

Field Summary

Fields

Modifier and Type	Field and Description
protected String	cacheRegion
protected Class<?>	containerType
protected Field	field
protected String	foreignKeyField
protected String	foreignKeyIdField
protected Boolean	isCollection
protected Boolean	isInitialized
protected Boolean	isSuccessful
protected String	joinFetchProperty
protected List<org.broadleafcommerce.common.util.Tuple<String,String>>	sortExpressions
protected String	targetProperty
protected Class<?>	type

Constructor Summary

Constructors

Constructor and Description
DefaultSandBoxCollectionHelper(Class<?> containerType, Field field, String joinFetchProperty) This constructor allows the system to derive the collection configuration from the collection Field itself, which allows discovery from the annotations surrounding the field.
DefaultSandBoxCollectionHelper(String cacheRegion, String foreignKeyField, String foreignKeyIdField, List<org.broadleafcommerce.common.util.Tuple<String,String>> sortExpressions, String targetProperty, Class<?> type) If all the configuration params are known ahead of time, they can be passed to this constructor to populate the final values in the bean.

Method Summary

Modifier and Type	Method and Description
Object	getAppropriateLargeSortingValue(String sortProperty) Get a large value to apply to any query results that do not define a value in the sorting field.
String	getCacheKey() A key to identify the collection batch fetch query in the batch fetch cache.
String	getCacheRegion() Get the cache region used on the collection, if applicable (can be null)
String	getCollectionFetchQuery() Get the HQL query used to retrieve the collection members
String	getForeignKeyField() Get the field on the collection member that points back to the containing entity
String	getForeignKeyIdField() Get the id field of the containing entity class
List<org.broadleafcommerce.common.util.Tuple<String,String>>	getSortExpressions() Get the sorting expressions for the query results, if applicable (can be null or empty)
String	getTargetProperty() Only applicable to AdminPresentationAdornedTargetCollection annotated collections.
Class<?>	getType() Get the type for the collection members
boolean	initialize(org.hibernate.Session session) Build up the internal structure based on the annotations and information derived from the Field param passed to DefaultSandBoxCollectionHelper(Class, Field, String).
Map<Serializable,List>	sortByForeignKey(List results, List<Serializable> fkValue) Sort batch fetch results for sandboxable collections by their foreign key relationship.

Methods inherited from class java.lang.Object

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

Field Detail

foreignKeyField

protected String foreignKeyField

foreignKeyIdField

protected String foreignKeyIdField

cacheRegion

protected String cacheRegion

targetProperty

protected String targetProperty

sortExpressions

protected List<org.broadleafcommerce.common.util.Tuple<String,String>> sortExpressions

type

protected Class<?> type

field

protected Field field

containerType

protected Class<?> containerType

isCollection

protected Boolean isCollection

isInitialized

protected Boolean isInitialized

isSuccessful

protected Boolean isSuccessful

joinFetchProperty

protected String joinFetchProperty

Constructor Detail

DefaultSandBoxCollectionHelper

public DefaultSandBoxCollectionHelper(Class<?> containerType,
                                      Field field,
                                      String joinFetchProperty)

This constructor allows the system to derive the collection configuration from the collection Field itself, which allows discovery from the annotations surrounding the field. In order to build up the config based on the values passed to this constructor, you should call initialize(Session).

Parameters:

containerType -

field -

joinFetchProperty -

DefaultSandBoxCollectionHelper

public DefaultSandBoxCollectionHelper(String cacheRegion,
                                      String foreignKeyField,
                                      String foreignKeyIdField,
                                      List<org.broadleafcommerce.common.util.Tuple<String,String>> sortExpressions,
                                      String targetProperty,
                                      Class<?> type)

If all the configuration params are known ahead of time, they can be passed to this constructor to populate the final values in the bean.

Parameters:

cacheRegion -

foreignKeyField -

foreignKeyIdField -

sortExpressions -

targetProperty -

type -

Method Detail

initialize

public boolean initialize(org.hibernate.Session session)

Build up the internal structure based on the annotations and information derived from the Field param passed to DefaultSandBoxCollectionHelper(Class, Field, String). It is safe to call this method repeatedly, as it is synchronized and will only execute once based on a "isInitialized" flag.

Parameters:

session -

Returns:

sortByForeignKey

public Map<Serializable,List> sortByForeignKey(List results,
                                               List<Serializable> fkValue)

Description copied from interface: SandBoxCollectionHelper

Sort batch fetch results for sandboxable collections by their foreign key relationship.

Specified by:

sortByForeignKey in interface SandBoxCollectionHelper

Returns:

getCollectionFetchQuery

public String getCollectionFetchQuery()

Description copied from interface: SandBoxCollectionHelper

Get the HQL query used to retrieve the collection members

Specified by:

getCollectionFetchQuery in interface SandBoxCollectionHelper

Returns:

getAppropriateLargeSortingValue

public Object getAppropriateLargeSortingValue(String sortProperty)

Description copied from interface: SandBoxCollectionHelper

Get a large value to apply to any query results that do not define a value in the sorting field. This is only applicable if sorting is enabled. This will force entities with a 'NULL' value in the sorting column to appear last in the results.

Specified by:

getAppropriateLargeSortingValue in interface SandBoxCollectionHelper

Returns:

getCacheKey

public String getCacheKey()

Description copied from interface: SandBoxCollectionHelper

A key to identify the collection batch fetch query in the batch fetch cache. See EnterpriseCollectionDao for more information.

Specified by:

getCacheKey in interface SandBoxCollectionHelper

Returns:

getCacheRegion

public String getCacheRegion()

Description copied from interface: SandBoxCollectionHelper

Get the cache region used on the collection, if applicable (can be null)

Specified by:

getCacheRegion in interface SandBoxCollectionHelper

Returns:

getForeignKeyField

public String getForeignKeyField()

Description copied from interface: SandBoxCollectionHelper

Get the field on the collection member that points back to the containing entity

Specified by:

getForeignKeyField in interface SandBoxCollectionHelper

Returns:

getForeignKeyIdField

public String getForeignKeyIdField()

Description copied from interface: SandBoxCollectionHelper

Get the id field of the containing entity class

Specified by:

getForeignKeyIdField in interface SandBoxCollectionHelper

Returns:

getSortExpressions

public List<org.broadleafcommerce.common.util.Tuple<String,String>> getSortExpressions()

Description copied from interface: SandBoxCollectionHelper

Get the sorting expressions for the query results, if applicable (can be null or empty)

Specified by:

getSortExpressions in interface SandBoxCollectionHelper

Returns:

getTargetProperty

public String getTargetProperty()

Description copied from interface: SandBoxCollectionHelper

Only applicable to AdminPresentationAdornedTargetCollection annotated collections. This property references the target entity in the adorned target structure.

Specified by:

getTargetProperty in interface SandBoxCollectionHelper

Returns:

getType

public Class<?> getType()

Description copied from interface: SandBoxCollectionHelper

Get the type for the collection members

Specified by:

getType in interface SandBoxCollectionHelper

Returns: