Package com.broadleafcommerce.customersegment.dao

Class CustomerSegmentDaoImpl

java.lang.Object

com.broadleafcommerce.customersegment.dao.CustomerSegmentDaoImpl

All Implemented Interfaces:

CustomerSegmentDao

@Repository("blCustomerSegmentDao")
public class CustomerSegmentDaoImpl
extends Object
implements CustomerSegmentDao

Provides database access for CustomerSegment

Author:

bpolster

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BLC_ARCHIVE_PURCHASE_BASED_CUSTOMERS
protected jakarta.persistence.EntityManager	em
protected org.broadleafcommerce.common.persistence.EntityConfiguration	entityConfiguration
protected CustomerSegmentDaoExtensionManager	extensionManager

Constructor Summary

Constructors

Constructor	Description
CustomerSegmentDaoImpl()

Method Summary

Modifier and Type	Method	Description
int	archiveCustomerPurchaseBasedCustomerSegmentXrefs(List<Long> customerIds, Long segmentId)
protected List<jakarta.persistence.criteria.Predicate>	buildPredicates(jakarta.persistence.criteria.Path xref, jakarta.persistence.criteria.Path customerSegment, org.broadleafcommerce.profile.core.domain.Customer customer, jakarta.persistence.criteria.CriteriaBuilder builder)
void	clear()
boolean	customerIdentifiesWithCustomerSegment(Long segmentId, org.broadleafcommerce.profile.core.domain.Customer customer)	Determines if the sent customer matches the identifying criteria for the customer segment with id segmentId
void	delete(CustPrchBasedCustSegXref xref)	Deletes the passed in PurchaseCustomerCustomerSegmentXref.
void	deleteCustomerSegment(CustomerSegment customerSegment)	Removes the passed in CustomerSegment.
protected jakarta.persistence.criteria.CriteriaQuery<CustPrchBasedCustSegXref>	getAllPurchaseBasedCustomersQuery(CustomerSegment customerSegment)
protected jakarta.persistence.criteria.CriteriaQuery<Long>	getPotentialCustomerCountCriteria(PurchBasedCustSegConfigDTO config)
protected jakarta.persistence.criteria.CriteriaQuery<Long>	getPotentialCustomerCriteria(PurchBasedCustSegConfigDTO config)
protected jakarta.persistence.criteria.CriteriaQuery<Long>	getPotentialCustomerCriteria(PurchBasedCustSegConfigDTO config, boolean isCountQuery)
boolean	isCustomerInPurchaseBasedCustomerSegment(CustomerSegment customerSegment, org.broadleafcommerce.profile.core.domain.Customer customer)	Returns whether or not this customer qualified for the purchase requirements of this customer segment
List<CustPrchBasedCustSegXref>	readAllCustomersInSegmentWithLatestPurchaseBeforeDate(CustomerSegment customerSegment, Date cutoffDate)	Finds all customers for a customer segment that made a qualifying purchase before the cutoff date
List<Long>	readAllCustomersWithPurchasesInDateRange(int size, int start, PurchBasedCustSegConfigDTO config)
List<OfferCustomerSegmentXref>	readAllOfferCustomerSegmentXrefsByOfferId(Long offerId)
List<CustomerSegment>	readAllPurchaseBasedCustomerSegments()	Finds all customer segments that have purchase requirements
List<CustPrchBasedCustSegXref>	readAllPurchaseBasedCustomersInSegment(int size, int start, CustomerSegment segment)
List<CustPrchBasedCustSegXref>	readAllPurchaseBasedCustomersInSegment(CustomerSegment customerSegment)
List<CustomerSegment>	readAllRuleBasedCustomerSegments()	Read all CustomerSegments
List<CustomerCustomerSegmentXref>	readBatchCustomerCustomerSegXrefs(int firstRecord, int count)
List<CustomerCustomerSegmentXref>	readBatchCustomerCustomerSegXrefs(Long firstId, int count)	Returns list of CustomerCustomerSegmentXrefs starting at start up to start+count.
List<CustomerCustomerSegmentXref>	readBatchXrefsForCustomerSegment(Long customerSegmentId, Integer firstRecord, int count)
List<CustomerCustomerSegmentXref>	readBatchXrefsForCustomerSegment(Long customerSegmentId, Long firstId, int count)	Returns list of CustomerCustomerSegmentXrefs for a specific CustomerSegment starting at start up to start+count.
int	readCountAllCustomersWithPurchasesInDateRange(PurchBasedCustSegConfigDTO config)
int	readCountAllPurchaseBasedCustomersInSegment(CustomerSegment segment)
CustPrchBasedCustSegXref	readCustomerForPurchaseBasedSegment(CustomerSegment customerSegment, org.broadleafcommerce.profile.core.domain.Customer customer)	Finds a specific customer in a purchase based customer segment
CustomerSegment	readCustomerSegmentById(Long id)	Finds the CustomerSegment for the passed in id.
List<CustomerSegment>	readCustomerSegmentByIds(List<Long> ids)
CustomerSegment	readCustomerSegmentByName(String name)
List<CustomerSegment>	readCustomerSegmentsByFilterAndLimit(String filter, Integer limit)
List<CustomerSegment>	readCustomerSegmentsByLimit(Integer limit)
List<CustomerSegment>	readListBasedCustomerSegmentsForCustomer(org.broadleafcommerce.profile.core.domain.Customer customer)	Finds all CustomerSegments that contain this customer.
Long	readNumberOfCustomerCustomerSegXrefs()
Long	readNumberOfCustomerSegments()	Returns the total number of Customer Segments for the current site.
Long	readNumberOfXrefsForCustomerSegment(Long customerSegmentId)
CustPrchBasedCustSegXref	save(CustPrchBasedCustSegXref xref)	Creates or updates the passed in PurchaseCustomerCustomerSegmentXref.
CustomerSegment	saveCustomerSegment(CustomerSegment customerSegment)	Creates or updates the passed in CustomerSegment.

Methods inherited from class java.lang.Object

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

Field Details

BLC_ARCHIVE_PURCHASE_BASED_CUSTOMERS

public static final String BLC_ARCHIVE_PURCHASE_BASED_CUSTOMERS

See Also:

• Constant Field Values

em

protected jakarta.persistence.EntityManager em

entityConfiguration

protected org.broadleafcommerce.common.persistence.EntityConfiguration entityConfiguration

extensionManager

protected CustomerSegmentDaoExtensionManager extensionManager

Constructor Details

CustomerSegmentDaoImpl

public CustomerSegmentDaoImpl()

Method Details

readAllRuleBasedCustomerSegments

public List<CustomerSegment> readAllRuleBasedCustomerSegments()

Description copied from interface: CustomerSegmentDao

Read all CustomerSegments

Specified by:

readAllRuleBasedCustomerSegments in interface CustomerSegmentDao

Returns:

clear

public void clear()

Specified by:

clear in interface CustomerSegmentDao

readBatchCustomerCustomerSegXrefs

public List<CustomerCustomerSegmentXref> readBatchCustomerCustomerSegXrefs(Long firstId,
 int count)

Description copied from interface: CustomerSegmentDao

Returns list of CustomerCustomerSegmentXrefs starting at start up to start+count.

Specified by:

readBatchCustomerCustomerSegXrefs in interface CustomerSegmentDao

readBatchCustomerCustomerSegXrefs

public List<CustomerCustomerSegmentXref> readBatchCustomerCustomerSegXrefs(int firstRecord,
 int count)

Specified by:

readBatchCustomerCustomerSegXrefs in interface CustomerSegmentDao

readBatchXrefsForCustomerSegment

public List<CustomerCustomerSegmentXref> readBatchXrefsForCustomerSegment(Long customerSegmentId,
 Long firstId,
 int count)

Description copied from interface: CustomerSegmentDao

Returns list of CustomerCustomerSegmentXrefs for a specific CustomerSegment starting at start up to start+count.

Specified by:

readBatchXrefsForCustomerSegment in interface CustomerSegmentDao

readBatchXrefsForCustomerSegment

public List<CustomerCustomerSegmentXref> readBatchXrefsForCustomerSegment(Long customerSegmentId,
 Integer firstRecord,
 int count)

Specified by:

readBatchXrefsForCustomerSegment in interface CustomerSegmentDao

readNumberOfCustomerCustomerSegXrefs

public Long readNumberOfCustomerCustomerSegXrefs()

Specified by:

readNumberOfCustomerCustomerSegXrefs in interface CustomerSegmentDao

readNumberOfXrefsForCustomerSegment

public Long readNumberOfXrefsForCustomerSegment(Long customerSegmentId)

Specified by:

readNumberOfXrefsForCustomerSegment in interface CustomerSegmentDao

readCustomerSegmentsByFilterAndLimit

public List<CustomerSegment> readCustomerSegmentsByFilterAndLimit(String filter,
 Integer limit)

Specified by:

readCustomerSegmentsByFilterAndLimit in interface CustomerSegmentDao

readCustomerSegmentsByLimit

public List<CustomerSegment> readCustomerSegmentsByLimit(Integer limit)

Specified by:

readCustomerSegmentsByLimit in interface CustomerSegmentDao

readAllPurchaseBasedCustomerSegments

public List<CustomerSegment> readAllPurchaseBasedCustomerSegments()

Description copied from interface: CustomerSegmentDao

Finds all customer segments that have purchase requirements

Specified by:

readAllPurchaseBasedCustomerSegments in interface CustomerSegmentDao

Returns:

readCustomerSegmentById

public CustomerSegment readCustomerSegmentById(Long id)

Description copied from interface: CustomerSegmentDao

Finds the CustomerSegment for the passed in id.

Specified by:

readCustomerSegmentById in interface CustomerSegmentDao

Returns:

readCustomerSegmentByName

public CustomerSegment readCustomerSegmentByName(String name)

Specified by:

readCustomerSegmentByName in interface CustomerSegmentDao

readCustomerSegmentByIds

public List<CustomerSegment> readCustomerSegmentByIds(List<Long> ids)

Specified by:

readCustomerSegmentByIds in interface CustomerSegmentDao

readNumberOfCustomerSegments

public Long readNumberOfCustomerSegments()

Description copied from interface: CustomerSegmentDao

Returns the total number of Customer Segments for the current site.

Specified by:

readNumberOfCustomerSegments in interface CustomerSegmentDao

Returns:

total number of Customer Segments for the current site

isCustomerInPurchaseBasedCustomerSegment

public boolean isCustomerInPurchaseBasedCustomerSegment(CustomerSegment customerSegment,
 org.broadleafcommerce.profile.core.domain.Customer customer)

Description copied from interface: CustomerSegmentDao

Returns whether or not this customer qualified for the purchase requirements of this customer segment

Specified by:

isCustomerInPurchaseBasedCustomerSegment in interface CustomerSegmentDao

Returns:

saveCustomerSegment

@Transactional("blTransactionManager")
public CustomerSegment saveCustomerSegment(CustomerSegment customerSegment)

Creates or updates the passed in CustomerSegment.

Specified by:

saveCustomerSegment in interface CustomerSegmentDao

Parameters:

customerSegment -

Returns:

save

@Transactional("blTransactionManager")
public CustPrchBasedCustSegXref save(CustPrchBasedCustSegXref xref)

Creates or updates the passed in PurchaseCustomerCustomerSegmentXref.

Specified by:

save in interface CustomerSegmentDao

Parameters:

xref -

Returns:

delete

@Transactional("blTransactionManager")
public void delete(CustPrchBasedCustSegXref xref)

Deletes the passed in PurchaseCustomerCustomerSegmentXref.

Specified by:

delete in interface CustomerSegmentDao

Parameters:

xref -

deleteCustomerSegment

public void deleteCustomerSegment(CustomerSegment customerSegment)

Removes the passed in CustomerSegment.

Specified by:

deleteCustomerSegment in interface CustomerSegmentDao

Parameters:

customerSegment -

readAllOfferCustomerSegmentXrefsByOfferId

public List<OfferCustomerSegmentXref> readAllOfferCustomerSegmentXrefsByOfferId(Long offerId)

Specified by:

readAllOfferCustomerSegmentXrefsByOfferId in interface CustomerSegmentDao

readAllPurchaseBasedCustomersInSegment

public List<CustPrchBasedCustSegXref> readAllPurchaseBasedCustomersInSegment(int size,
 int start,
 CustomerSegment segment)

Specified by:

readAllPurchaseBasedCustomersInSegment in interface CustomerSegmentDao

readCountAllPurchaseBasedCustomersInSegment

public int readCountAllPurchaseBasedCustomersInSegment(CustomerSegment segment)

Specified by:

readCountAllPurchaseBasedCustomersInSegment in interface CustomerSegmentDao

readAllPurchaseBasedCustomersInSegment

public List<CustPrchBasedCustSegXref> readAllPurchaseBasedCustomersInSegment(CustomerSegment customerSegment)

Specified by:

readAllPurchaseBasedCustomersInSegment in interface CustomerSegmentDao

getAllPurchaseBasedCustomersQuery

protected jakarta.persistence.criteria.CriteriaQuery<CustPrchBasedCustSegXref> getAllPurchaseBasedCustomersQuery(CustomerSegment customerSegment)

readAllCustomersInSegmentWithLatestPurchaseBeforeDate

public List<CustPrchBasedCustSegXref> readAllCustomersInSegmentWithLatestPurchaseBeforeDate(CustomerSegment customerSegment,
 Date cutoffDate)

Description copied from interface: CustomerSegmentDao

Finds all customers for a customer segment that made a qualifying purchase before the cutoff date

Specified by:

readAllCustomersInSegmentWithLatestPurchaseBeforeDate in interface CustomerSegmentDao

Returns:

readCustomerForPurchaseBasedSegment

public CustPrchBasedCustSegXref readCustomerForPurchaseBasedSegment(CustomerSegment customerSegment,
 org.broadleafcommerce.profile.core.domain.Customer customer)

Description copied from interface: CustomerSegmentDao

Finds a specific customer in a purchase based customer segment

Specified by:

readCustomerForPurchaseBasedSegment in interface CustomerSegmentDao

Returns:

readCountAllCustomersWithPurchasesInDateRange

public int readCountAllCustomersWithPurchasesInDateRange(PurchBasedCustSegConfigDTO config)

Specified by:

readCountAllCustomersWithPurchasesInDateRange in interface CustomerSegmentDao

readAllCustomersWithPurchasesInDateRange

public List<Long> readAllCustomersWithPurchasesInDateRange(int size,
 int start,
 PurchBasedCustSegConfigDTO config)

Specified by:

readAllCustomersWithPurchasesInDateRange in interface CustomerSegmentDao

getPotentialCustomerCountCriteria

protected jakarta.persistence.criteria.CriteriaQuery<Long> getPotentialCustomerCountCriteria(PurchBasedCustSegConfigDTO config)

getPotentialCustomerCriteria

protected jakarta.persistence.criteria.CriteriaQuery<Long> getPotentialCustomerCriteria(PurchBasedCustSegConfigDTO config)

getPotentialCustomerCriteria

protected jakarta.persistence.criteria.CriteriaQuery<Long> getPotentialCustomerCriteria(PurchBasedCustSegConfigDTO config,
 boolean isCountQuery)

readListBasedCustomerSegmentsForCustomer

public List<CustomerSegment> readListBasedCustomerSegmentsForCustomer(org.broadleafcommerce.profile.core.domain.Customer customer)

Description copied from interface: CustomerSegmentDao

Finds all CustomerSegments that contain this customer. Returns an empty List if customer is anonymous to prevent IllegalArgumentException, since anonymous customers will have null customerId.

Specified by:

readListBasedCustomerSegmentsForCustomer in interface CustomerSegmentDao

Returns:

archiveCustomerPurchaseBasedCustomerSegmentXrefs

public int archiveCustomerPurchaseBasedCustomerSegmentXrefs(List<Long> customerIds,
 Long segmentId)

Specified by:

archiveCustomerPurchaseBasedCustomerSegmentXrefs in interface CustomerSegmentDao

customerIdentifiesWithCustomerSegment

public boolean customerIdentifiesWithCustomerSegment(Long segmentId,
 org.broadleafcommerce.profile.core.domain.Customer customer)

Determines if the sent customer matches the identifying criteria for the customer segment with id segmentId

Specified by:

customerIdentifiesWithCustomerSegment in interface CustomerSegmentDao

Parameters:

segmentId - the Customer Segment id to check against

customer - the customer we're checking to see if matches the given customer segment or not

Returns:

true if the customer sent identifies with the customer segment sent

buildPredicates

protected List<jakarta.persistence.criteria.Predicate> buildPredicates(jakarta.persistence.criteria.Path xref,
 jakarta.persistence.criteria.Path customerSegment,
 org.broadleafcommerce.profile.core.domain.Customer customer,
 jakarta.persistence.criteria.CriteriaBuilder builder)