Package com.broadleafcommerce.common.dataimport.util

Class CorrelationIdUtil

java.lang.Object

com.broadleafcommerce.common.dataimport.util.CorrelationIdUtil

public final class CorrelationIdUtil
extends Object

By default, this detects correlation id values that ends with () and optionally tokenized by | for columns that can contain multiple correlation ids

Author:

Phillip Verheyden (phillipuniverse)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CORRELATIONID_POSTFIX
static final Pattern	CORRELATIONID_REGEX
static final String	DEFAULT_MULTIVALUE_SEPARATOR

Method Summary

Modifier and Type	Method	Description
static List<String>	correlationIdsFor(Map<String,String> resolvedRow)
static List<String>	parseCorrelationIds(String value)	Given a column that can contain correlation id references, returns only the correlation id(s) that are within the column.
static List<String>	parseCorrelationIds(String value, String multiValuedSeparator)	Given a column that can contain correlation id references, returns only the correlation id(s) that are within the column.
static String	populateCorrelationIds(String value, String multiValuedSeparator, UnaryOperator<String> correlationIdToIdentifierResolver)	Replaces the contents of value with the appropriate value from the result of correlationIdToIdentifierResolver.
static String	populateCorrelationIds(String value, UnaryOperator<String> correlationIdToIdentifierResolver)	Replaces the contents of value with the appropriate value from the result of correlationIdToIdentifierResolver.
static Map<String,String>	replaceWithMappedCorrelationIds(Map<String,String> row, UnaryOperator<String> correlationIdToIdentifierResolver)

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_MULTIVALUE_SEPARATOR

public static final String DEFAULT_MULTIVALUE_SEPARATOR

See Also:

• Constant Field Values

CORRELATIONID_REGEX

public static final Pattern CORRELATIONID_REGEX

CORRELATIONID_POSTFIX

public static final String CORRELATIONID_POSTFIX

See Also:

• Constant Field Values

Method Details

parseCorrelationIds

public static List<String> parseCorrelationIds(@Nullable
 String value)

Given a column that can contain correlation id references, returns only the correlation id(s) that are within the column. If there are no correlation ids this will return an empty list. If there is a mix of values (in the case of multiple values embedded within value) this will only return the discovered correlation ids from those values.

Parameters:

value - potentially contains correlation ids. Allows muliple values separated by DEFAULT_MULTIVALUE_SEPARATOR

Returns:

the correlation ids within the column

See Also:

• parseCorrelationIds(String, String)

parseCorrelationIds

public static List<String> parseCorrelationIds(@Nullable
 String value,
 @Nullable
 String multiValuedSeparator)

Given a column that can contain correlation id references, returns only the correlation id(s) that are within the column. If there are no correlation ids this will return an empty list. If there is a mix of values (in the case of multiple values embedded within value) this will only return the discovered correlation ids from those values.

Parameters:

value - potentially contains correlation ids

multiValuedSeparator - optional separator column that can split the given value for multiple values. If null, defaults to DEFAULT_MULTIVALUE_SEPARATOR

Returns:

the correlation ids within the column

correlationIdsFor

public static List<String> correlationIdsFor(Map<String,String> resolvedRow)

replaceWithMappedCorrelationIds

public static Map<String,String> replaceWithMappedCorrelationIds(Map<String,String> row,
 UnaryOperator<String> correlationIdToIdentifierResolver)

populateCorrelationIds

@Nullable
public static String populateCorrelationIds(@Nullable
 String value,
 UnaryOperator<String> correlationIdToIdentifierResolver)

Replaces the contents of value with the appropriate value from the result of correlationIdToIdentifierResolver. This is flexible enough to only perform the operation if there are correlation ids to begin with contained with value and those correlationIds have corresponding non-null results from the correlationIdToIdentifierResolver.

Parameters:

value - what should be inspected and potentially replaced

correlationIdToIdentifierResolver - given a correlationId, can resolve a resource tier id

Returns:

value replaced with the the parsed correlation ids. If value is null, this will also return null. If there are no correlation ids within value, the original is returned unchanged.

populateCorrelationIds

@Nullable
public static String populateCorrelationIds(@Nullable
 String value,
 @Nullable
 String multiValuedSeparator,
 UnaryOperator<String> correlationIdToIdentifierResolver)

Replaces the contents of value with the appropriate value from the result of correlationIdToIdentifierResolver. This is flexible enough to only perform the operation if there are correlation ids to begin with contained with value and those correlationIds have corresponding non-null results from the correlationIdToIdentifierResolver.

Parameters:

value - what should be inspected and potentially replaced

multiValuedSeparator - if value could contain multiple entries this is the separation between them

correlationIdToIdentifierResolver - given a correlationId, can resolve a resource tier id

Returns:

value replaced with the the parsed correlation ids. If value is null, this will also return null. If there are no correlation ids within value, the original is returned unchanged.