Package com.broadleafcommerce.catalog.service.bulkoperation.processor.util

Class BulkUpdateProcessorHelper<I extends BulkOperationItem>

java.lang.Object

com.broadleafcommerce.catalog.service.bulkoperation.processor.util.BulkUpdateProcessorHelper<I>

public class BulkUpdateProcessorHelper<I extends BulkOperationItem>
extends Object

Helper component for processing BulkOperations against the designated Items.

Since:

2.1.0-GA

Author:

Nathan Moore (nathandmoore)

See Also:

• BulkUpdateProcessor
• BulkItemPageOperator

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	ID
protected static final String	ID_START_QUERY_PARAM

Constructor Summary

Constructors

Constructor	Description
BulkUpdateProcessorHelper(BulkOperationItemService<I> bulkOperationItemService, BulkOperationService<BulkOperation> bulkOperationService)

Method Summary

Modifier and Type	Method	Description
protected cz.jirutka.rsql.parser.ast.Node	buildBulkItemLookupFilter(String startId)
protected org.springframework.data.domain.Pageable	buildBulkItemLookupPageable()
protected com.broadleafcommerce.data.tracking.core.service.context.BulkOperationContextConfigurationProperties	getBulkOpContextConfigurationProperties()
com.broadleafcommerce.data.tracking.core.service.context.BulkOperationContextConfigurationProperties.BulkOperationContextProperties	getBulkOperationContextProperties(BulkOperation bulkOperation, String operationType)	Retrieves the configuration for the given bulk operation type.
protected BulkOperationItemService<I>	getBulkOperationItemService()
protected BulkOperationService<BulkOperation>	getBulkOperationService()
protected void	handleFailedItemUpdates(@NonNull com.broadleafcommerce.data.tracking.core.service.BulkPersistenceResponse<I> response)
<T> void	handleFailureEntityUpdates(@NonNull com.broadleafcommerce.data.tracking.core.service.BulkPersistenceResponse<T> bulkPersistenceResponse, @NonNull Function<T,String> getIdFunction, @NonNull org.springframework.data.domain.Page<I> bulkOperationItems, String operationType)	Updates the bulk operation items based on the failed records in the persistence response.
<T> void	handleSuccessfulEntityUpdates(@NonNull com.broadleafcommerce.data.tracking.core.service.BulkPersistenceResponse<T> bulkPersistenceResponse, @NonNull Function<T,String> getIdFunction, @NonNull org.springframework.data.domain.Page<I> bulkOperationItems, String operationType)	Updates the bulk operation items based on the successful records in the persistence response.
void	processBulkItemsInBatches(@NonNull BulkOperation bulkOperation, @NonNull BulkItemPageOperator<I> bulkItemPageOperator)	Handles processing a page of BulkOperationItems in batches, applying the given BulkItemPageOperator to the retrieved items.
void	setBulkOpContextConfigurationProperties(com.broadleafcommerce.data.tracking.core.service.context.BulkOperationContextConfigurationProperties bulkOpContextConfigurationProperties)
protected String	updateBatchingStartId(String startId, @NonNull org.springframework.data.domain.Page<I> bulkOperationItems)

Methods inherited from class java.lang.Object

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

Field Details

ID

protected static final String ID

See Also:

• Constant Field Values

ID_START_QUERY_PARAM

protected static final String ID_START_QUERY_PARAM

See Also:

• Constant Field Values

Constructor Details

BulkUpdateProcessorHelper

public BulkUpdateProcessorHelper(BulkOperationItemService<I> bulkOperationItemService,
 BulkOperationService<BulkOperation> bulkOperationService)

Method Details

getBulkOperationContextProperties

@Nullable
public com.broadleafcommerce.data.tracking.core.service.context.BulkOperationContextConfigurationProperties.BulkOperationContextProperties getBulkOperationContextProperties(BulkOperation bulkOperation,
 String operationType)

Retrieves the configuration for the given bulk operation type.

Parameters:

bulkOperation - The BulkOperation

operationType - The type of the operation, e.g., ADD_TAG.

Returns:

The configuration for the type or null if none.

handleSuccessfulEntityUpdates

public <T> void handleSuccessfulEntityUpdates(@NonNull
 @NonNull com.broadleafcommerce.data.tracking.core.service.BulkPersistenceResponse<T> bulkPersistenceResponse,
 @NonNull
 @NonNull Function<T,String> getIdFunction,
 @NonNull
 @NonNull org.springframework.data.domain.Page<I> bulkOperationItems,
 String operationType)

Updates the bulk operation items based on the successful records in the persistence response.

Type Parameters:

T - the type of entity that was persisted

Parameters:

bulkPersistenceResponse - the BulkPersistenceResponse that contains information about which entities succeeded, and which entities failed and why

getIdFunction - the function to get the entity's context ID

bulkOperationItems - the page of bulk operation items to update

handleFailureEntityUpdates

public <T> void handleFailureEntityUpdates(@NonNull
 @NonNull com.broadleafcommerce.data.tracking.core.service.BulkPersistenceResponse<T> bulkPersistenceResponse,
 @NonNull
 @NonNull Function<T,String> getIdFunction,
 @NonNull
 @NonNull org.springframework.data.domain.Page<I> bulkOperationItems,
 String operationType)

Updates the bulk operation items based on the failed records in the persistence response.

Type Parameters:

T - the type of entity that was persisted

Parameters:

bulkPersistenceResponse - the BulkPersistenceResponse that contains information about which entities succeeded, and which entities failed and why

getIdFunction - the function to get the entity's context ID

bulkOperationItems - the page of bulk operation items to update

processBulkItemsInBatches

public void processBulkItemsInBatches(@NonNull
 @NonNull BulkOperation bulkOperation,
 @NonNull
 @NonNull BulkItemPageOperator<I> bulkItemPageOperator)

Handles processing a page of BulkOperationItems in batches, applying the given BulkItemPageOperator to the retrieved items.

Parameters:

bulkOperation - The parent BulkOperation

bulkItemPageOperator - The BulkItemPageOperator representing the operation to perform against the items.

handleFailedItemUpdates

protected void handleFailedItemUpdates(@NonNull
 @NonNull com.broadleafcommerce.data.tracking.core.service.BulkPersistenceResponse<I> response)

updateBatchingStartId

protected String updateBatchingStartId(@Nullable
 String startId,
 @NonNull
 @NonNull org.springframework.data.domain.Page<I> bulkOperationItems)

buildBulkItemLookupPageable

protected org.springframework.data.domain.Pageable buildBulkItemLookupPageable()

buildBulkItemLookupFilter

protected cz.jirutka.rsql.parser.ast.Node buildBulkItemLookupFilter(@Nullable
 String startId)

getBulkOperationItemService

protected BulkOperationItemService<I> getBulkOperationItemService()

getBulkOperationService

protected BulkOperationService<BulkOperation> getBulkOperationService()

getBulkOpContextConfigurationProperties

protected com.broadleafcommerce.data.tracking.core.service.context.BulkOperationContextConfigurationProperties getBulkOpContextConfigurationProperties()

setBulkOpContextConfigurationProperties

@Autowired
public void setBulkOpContextConfigurationProperties(@Nullable
 com.broadleafcommerce.data.tracking.core.service.context.BulkOperationContextConfigurationProperties bulkOpContextConfigurationProperties)