com.broadleafcommerce.dataimport.service

Interface LateIdResolver

All Known Implementing Classes:

ImportOrderPersisterImpl, ImportPersisterImpl

public interface LateIdResolver

Component used to handle late-stage primary key resolution. While importing files, it is sometimes necessary to back-reference primary keys of lines that have already been processed but have not yet been persisted. Consider the case of assigning a defaultParentCategory to a Category. The import CSV might look like:

externalId,name,defaultParentCategory,url
cat-home,Home,,/home
cat-merch,Merchandise,cat-home,/merchandise
cat-clearance,Clearance,cat-home,/clearance

The cat-merch and cat-clearance categories both back-reference the cat-home row. However, since this entire set will be processed and persisted as a batch, at the time of processing the cat-merch and cat-clearance rows the cat-home row will not have been persisted and thus there is no way to properly handle the lookup. This allows us to process those rows and then actually fill in the IDs later (specifically, once cat-home has actually been persisted).

If we were not processing multiple lines in a batch this problem would not exist since each row would be processed and persisted one-by-one.

Author:

Phillip Verheyden (phillipuniverse)

See Also:

ImportPersisterImpl}

Field Summary

Fields

Modifier and Type	Field and Description
static String	LATE_RESOLUTION_VALUE Used to indicate that the property value should be resolved later.

Method Summary

Modifier and Type	Method and Description
String	buildLateResolutionKey(String ceilingClass, String externalId) This should be invoked by any of the BroadleafCellProcessors that want to resolve an ID late in the game.
String	getPrimaryKey(String key) Attempts to retrieve the primary key from the cache.
void	populatePrimaryKey(String key, String primaryKey) Populates the cache with a primary key

Field Detail

LATE_RESOLUTION_VALUE

static final String LATE_RESOLUTION_VALUE

Used to indicate that the property value should be resolved later. This String constant should be appended with the actual value that you intend on resolving later.

See Also:

DefaultParentCategoryCellProcessor}, {@link CategoryRelationshipCellProcessor}, Constant Field Values

Method Detail

populatePrimaryKey

void populatePrimaryKey(String key,
                        String primaryKey)

Populates the cache with a primary key

Parameters:

key - a valid key built from buildLateResolutionKey(String, String)

primaryKey - the primary key to put in the map

getPrimaryKey

String getPrimaryKey(String key)

Attempts to retrieve the primary key from the cache. This will return null if none exists

Parameters:

key - a valid key built from buildLateResolutionKey(String, String)

Returns:

the primary key that was inserted by populatePrimaryKey(String, String) or null if none exists

buildLateResolutionKey

String buildLateResolutionKey(String ceilingClass,
                              String externalId)

This should be invoked by any of the BroadleafCellProcessors that want to resolve an ID late in the game. This will automatically build something that takes the ceilingClass, externalId and LATE_RESOLUTION_VALUE to build a placeholder key

Parameters:

ceilingClass - the class that the primary key should come from

externalId - the external ID that should uniquely identify the given ceilingClass

Returns:

the key that should be used in place of the actual Broadleaf primary key