com.broadleafcommerce.enterprise.common.extension.tenant

Class RelationshipOverridesUtil

java.lang.Object

com.broadleafcommerce.enterprise.common.extension.tenant.RelationshipOverridesUtil

@Component(value="blRelationshipOverridesUtil")
public class RelationshipOverridesUtil
extends Object

Common utility for database-backed inherited catalog relationship overrides. Most (if not all) of the queries for this is used in very similar ways across anything that relates to a parent entity, which means that anything that implements RelationshipOverridesExtensionHandler will likely need to utilize this.

Only relevant when running with Broadleaf Multi Tenant enabled, kept here for other modules to utilize

Author:

Phillip Verheyden (phillipuniverse)

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.persistence.EntityManager	em
protected org.broadleafcommerce.common.dao.GenericEntityDao	genericEntityDao
protected org.broadleafcommerce.common.util.StreamingTransactionCapableUtil	transUtil

Constructor Summary

Constructors

Constructor and Description
RelationshipOverridesUtil()

Method Summary

Modifier and Type	Method and Description
void	appendRelationshipQueryWhereClause(StringBuilder sb, Class<?> type, Class<?> targetType, String targetIdField, String targetFieldName) Append the where clause params for the relationship entity count and basic retrieval queries.
protected Map<Long,Set<Long>>	buildUpOverriddenRelationshipCatalogs(javax.persistence.TypedQuery<Long> countQuery, javax.persistence.Query catalogQuery) Execute queries to retrieve the standard site overridden catalogs and build up the overrides map for a particular relation type.
protected Long	convertId(Object id) In translations, the id comes back as a String while normal relationships come back as a Long.
Map<Long,Set<Long>>	getRelationshipOverrideCatalogsForType(Class<?> relationType, String targetFieldName, Class<?> relationTargetType) For the specified xref relation to target type, final all standard site catalogs that have an overridden version of the relation.
Map<Long,Set<Long>>	getTranslationOverrideCatalogsForType(org.broadleafcommerce.common.i18n.domain.TranslatedEntity translationType) Gets all of the places that translations have been overridden for particular products (really, their defaultSkus)
void	mergeOverrides(Map<Long,Set<Long>> receivingOverrides, Map<Long,Set<Long>> overridesToMerge) Add a map of overrides to an overall collection of overrides

Methods inherited from class java.lang.Object

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

Field Detail

em

protected javax.persistence.EntityManager em

transUtil

protected org.broadleafcommerce.common.util.StreamingTransactionCapableUtil transUtil

genericEntityDao

protected org.broadleafcommerce.common.dao.GenericEntityDao genericEntityDao

Constructor Detail

RelationshipOverridesUtil

public RelationshipOverridesUtil()

Method Detail

mergeOverrides

public void mergeOverrides(Map<Long,Set<Long>> receivingOverrides,
                           Map<Long,Set<Long>> overridesToMerge)

Add a map of overrides to an overall collection of overrides

Parameters:

receivingOverrides - the overall overrides

overridesToMerge - the subset of overrides

getTranslationOverrideCatalogsForType

public Map<Long,Set<Long>> getTranslationOverrideCatalogsForType(org.broadleafcommerce.common.i18n.domain.TranslatedEntity translationType)

Gets all of the places that translations have been overridden for particular products (really, their defaultSkus)

Parameters:

relationType -

translationProperty -

Returns:

Throws:

ClassNotFoundException

getRelationshipOverrideCatalogsForType

public Map<Long,Set<Long>> getRelationshipOverrideCatalogsForType(Class<?> relationType,
                                                                  String targetFieldName,
                                                                  Class<?> relationTargetType)

For the specified xref relation to target type, final all standard site catalogs that have an overridden version of the relation. This is keyed by the id of the target type in the template catalog.

Parameters:

relationType - the type of the xref entity (e.g. CategoryProductXrefImpl)

targetFieldName - the field on the relationType holding the reference to the target (e.g. CategoryProductXrefImpl.product)

relationTargetType - the type of the target field (e.g. ProductImpl)

Returns:

All the overriding standard site catalogs

appendRelationshipQueryWhereClause

public void appendRelationshipQueryWhereClause(StringBuilder sb,
                                               Class<?> type,
                                               Class<?> targetType,
                                               String targetIdField,
                                               String targetFieldName)

Append the where clause params for the relationship entity count and basic retrieval queries. These queries are trying to find relationship entity instances that represent an override for the target entity. This requires restricting this list to relationship entities whose target field points to a target entity instance (e.g. Product) whose catalog is different from that of the relationship entity itself (e.g. CategoryProductXref). This verifies that this relation represents an override of the catalog target entity.

Parameters:

sb - the stub of the count or retrieval query

type - the relation type

targetType - the type of the relation target

targetIdField - the id field of the target type

targetFieldName - the field in the relation entity pointing to target

buildUpOverriddenRelationshipCatalogs

protected Map<Long,Set<Long>> buildUpOverriddenRelationshipCatalogs(javax.persistence.TypedQuery<Long> countQuery,
                                                                    javax.persistence.Query catalogQuery)

Execute queries to retrieve the standard site overridden catalogs and build up the overrides map for a particular relation type. Do so in a paged fashion for efficiency and conservative memory usage.

Parameters:

countQuery - the count query to retrieve the overridden catalogs

catalogQuery - the query to retrieve the overridden catalogs

Returns:

All the overriding standard site catalogs

convertId

protected Long convertId(Object id)

In translations, the id comes back as a String while normal relationships come back as a Long. This converts correctly between the 2

Parameters:

id -

Returns: