com.broadleafcommerce.enterprise.common.dao.batch

Interface SandBoxCollectionHelper

All Known Implementing Classes:

DefaultSandBoxCollectionHelper

public interface SandBoxCollectionHelper

Helper class that holds important parameters for retrieving a sandboxable collection. Some utility methods are also available for processing batch fetch results.

Author:

Jeff Fischer

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
Map<Serializable,List>	sortByForeignKey(List results, List<Serializable> fkValue) Sort batch fetch results for sandboxable collections by their foreign key relationship.

Method Detail

sortByForeignKey

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

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

Parameters:

results -

fkValue -

Returns:

getCollectionFetchQuery

String getCollectionFetchQuery()

Get the HQL query used to retrieve the collection members

Returns:

getSortExpressions

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

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

Returns:

getType

Class<?> getType()

Get the type for the collection members

Returns:

getForeignKeyField

String getForeignKeyField()

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

Returns:

getForeignKeyIdField

String getForeignKeyIdField()

Get the id field of the containing entity class

Returns:

getCacheRegion

String getCacheRegion()

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

Returns:

getAppropriateLargeSortingValue

Object getAppropriateLargeSortingValue(String sortProperty)

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.

Parameters:

sortProperty -

Returns:

getTargetProperty

String getTargetProperty()

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

Returns:

getCacheKey

String getCacheKey()

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

Returns: