Package com.broadleafcommerce.dataimport.processor.specification

Class DefaultSpecification

java.lang.Object

com.broadleafcommerce.dataimport.processor.specification.DefaultSpecification

All Implemented Interfaces:

ImportSpecification

Direct Known Subclasses:

CampaignCodeSpecification, CompleteProductImportSpecification, CustomerSegmentMemberSpecification, CustomerSpecification, OfferCodeSpecification, PriceDataSpecification, ProductSpecification, SkuInventoryImportSpecification, UpdatePricesSpecification

public class DefaultSpecification
extends Object
implements ImportSpecification

A Specification that operates solely off of the import type

Author:

Phillip Verheyden (phillipuniverse)

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,Set<String>>	dependencyMappings	Dependency mappings don't change, so define a immutable instance of them for efficiency.
protected LinkedHashMap<String,ImportFieldConfig>	fieldConfigMap	Deprecated, for removal: This API element is subject to removal in a future version.

Fields inherited from interface com.broadleafcommerce.dataimport.processor.specification.ImportSpecification

ROW_DETERMINATION_COLUMN

Constructor Summary

Constructors

Constructor	Description
DefaultSpecification(String importType)
DefaultSpecification(String importType, String name)
DefaultSpecification(String importType, List<String> requiredAuthorities, List<String> requiredScopes)
DefaultSpecification(String importType, List<String> requiredAuthorities, List<String> requiredScopes, String name)

Method Summary

Modifier and Type	Method	Description
boolean	canHandle(String importType)	Whether or not this specification can actually handle the given import.
Map<String,Set<String>>	getDependencyMappings()	Dependency mappings don't change, so define a immutable instance of them for efficiency.
protected Map<String,List<DynamicHeaderFieldMapping>>	getDynamicHeaderMappingConfigsByRowType()
LinkedHashMap<String,ImportFieldConfig>	getFieldConfigMap()	Deprecated.
Map<String,Map<String,ImportFieldConfig>>	getHeaderFieldConfigsByRowType()	These represent the fields expected for this specification.
String	getImportType()	Which import type this specification is valid for
String	getName()	This is an arbitrary name for the specification, potentially allowing more than one specification for a particular type for a particular tenant or application.
List<String>	getRequiredAuthorities()	The list of required authorities necessary for carrying out a specific import.
Set<String>	getRequiredHeaders()	Deprecated, for removal: This API element is subject to removal in a future version.
Set<String>	getRequiredHeaders(String rowType)	Gets all the required headers for the provided row type.
List<String>	getRequiredScopes()	The list of required scopes necessary for carrying out a specific import.
boolean	isRequiresRowTypeHeader()	Whether or not the import requires a header for row_type.
String	mapDynamicFieldToHeader(String field, String rowType)	Similar to ImportSpecification.mapDynamicHeaderToField(String, String), but for reverse mappings from field names back to header names.
String	mapDynamicHeaderToField(String header, String rowType)	The specification may support dynamic header-field mappings beyond any hardcoded configuration in ImportSpecification.getHeaderFieldConfigsByRowType().
protected void	populateDynamicHeaderMappingsByRowType(Map<String,List<DynamicHeaderFieldMapping>> dynamicHeaderMappingConfigsByRowType)	This method is always invoked in the constructor - see createUnmodifiableDynamicHeaderMappingsByRowType().
protected void	populateHeaderFieldConfigsByRowType(Map<String,Map<String,ImportFieldConfig>> headerFieldConfigsByRowType)	This method is always invoked in the constructor - see createUnmodifiableHeaderFieldConfigsByRowType().

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.broadleafcommerce.dataimport.processor.specification.ImportSpecification

getImportDataNormalizers, getMainRecordType, isCatalogDiscriminated, isSandboxDiscriminated, parentEntityIdRequiredInRequest, resolveAndRemoveRecordType, resolveRecordTypeBeforePropertyMapping, shouldAllowUnmappedHeaders, shouldAutoGenerateOperationTypeForEachRecord, shouldAutoGenerateResourceTierIdForEachRecord

Field Details

fieldConfigMap

@Deprecated(since="1.8.1",
            forRemoval=true)
protected LinkedHashMap<String,ImportFieldConfig> fieldConfigMap

Deprecated, for removal: This API element is subject to removal in a future version.

This has been deprecated in favor of getHeaderFieldConfigsByRowType().

dependencyMappings

protected Map<String,Set<String>> dependencyMappings

Dependency mappings don't change, so define a immutable instance of them for efficiency.

This is important, as getDependencyMappings() is invoked multiple times for each row of an import.

Constructor Details

DefaultSpecification

public DefaultSpecification(String importType)

DefaultSpecification

public DefaultSpecification(String importType,
 String name)

DefaultSpecification

public DefaultSpecification(String importType,
 List<String> requiredAuthorities,
 List<String> requiredScopes)

DefaultSpecification

public DefaultSpecification(String importType,
 List<String> requiredAuthorities,
 List<String> requiredScopes,
 String name)

Method Details

canHandle

public boolean canHandle(String importType)

Description copied from interface: ImportSpecification

Whether or not this specification can actually handle the given import. Checks will generally be based on the import type.

Specified by:

canHandle in interface ImportSpecification

Returns:

whether or not this specification can actually handle the given import

populateHeaderFieldConfigsByRowType

protected void populateHeaderFieldConfigsByRowType(Map<String,Map<String,ImportFieldConfig>> headerFieldConfigsByRowType)

This method is always invoked in the constructor - see createUnmodifiableHeaderFieldConfigsByRowType().

Extensions of this class should override this method and use it to populate the values that they want to ultimately be in getHeaderFieldConfigsByRowType().

Parameters:

headerFieldConfigsByRowType - a special, mutable map instance which implementations should populate with field configurations. This map will ultimately be copied into an unmodifiable separate instance that will actually be used for getHeaderFieldConfigsByRowType().

populateDynamicHeaderMappingsByRowType

protected void populateDynamicHeaderMappingsByRowType(Map<String,List<DynamicHeaderFieldMapping>> dynamicHeaderMappingConfigsByRowType)

This method is always invoked in the constructor - see createUnmodifiableDynamicHeaderMappingsByRowType().

Extensions of this class should override this method and use it to populate the values that they want to ultimately be in getDynamicHeaderMappingConfigsByRowType().

Parameters:

dynamicHeaderMappingConfigsByRowType - a special, mutable map instance which implementations should populate with dynamic header mappings. This map will ultimately be copied into an unmodifiable separate instance that will actually be used for getDynamicHeaderMappingConfigsByRowType().

isRequiresRowTypeHeader

public boolean isRequiresRowTypeHeader()

Description copied from interface: ImportSpecification

Whether or not the import requires a header for row_type. This is generally only required when there are multiple record types in an import, but could also be used to dynamically determine the row type during processing

Specified by:

isRequiresRowTypeHeader in interface ImportSpecification

Returns:

whether or not this import requires a row type header

getRequiredHeaders

@Deprecated(since="1.8.1",
            forRemoval=true)
public Set<String> getRequiredHeaders()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: ImportSpecification

This should represent the required headers that will be validated for _all_ row types. For consistency, the implementation of this should be backed by ImportSpecification.getFieldConfigMap().

Specified by:

getRequiredHeaders in interface ImportSpecification

Returns:

the list of required headers for all row types

See Also:

• ImportSpecification.getRequiredHeaders(String)

getRequiredHeaders

public Set<String> getRequiredHeaders(String rowType)

Description copied from interface: ImportSpecification

Gets all the required headers for the provided row type. Each row of the given type should be required to provide a value for each of the returned headers.

For consistency, this should ideally be backed by the implementation of ImportSpecification.getHeaderFieldConfigsByRowType().

The default implementation in this interface will be removed at the time ImportSpecification.getRequiredHeaders() is removed, with the expectation that a real ImportSpecification.getHeaderFieldConfigsByRowType() will be backing the implementation..

Specified by:

getRequiredHeaders in interface ImportSpecification

Parameters:

rowType - the row type to get the required headers for

Returns:

a list of required headers for the provided row type. Should be empty if there are no required headers.

See Also:

• ImportSpecification.getHeaderFieldConfigsByRowType()

mapDynamicHeaderToField

@Nullable
public String mapDynamicHeaderToField(String header,
 String rowType)

Description copied from interface: ImportSpecification

The specification may support dynamic header-field mappings beyond any hardcoded configuration in ImportSpecification.getHeaderFieldConfigsByRowType(). If so, then this method should be overridden to attempt performing such mappings on the given header for the given row type. If the mapping is successful, the mapped field should be returned, else null.

Typically, any hard-coded mappings in ImportSpecification.getHeaderFieldConfigsByRowType() should take precedence over this, so consumers should check for a mapping there first.

Specified by:

mapDynamicHeaderToField in interface ImportSpecification

Parameters:

header - the raw input header that needs to be mapped to a field

rowType - the row type that this mapping is being performed for

Returns:

the mapped field if supported, else null

See Also:

• DynamicHeaderFieldMapping

mapDynamicFieldToHeader

@Nullable
public String mapDynamicFieldToHeader(String field,
 String rowType)

Description copied from interface: ImportSpecification

Similar to ImportSpecification.mapDynamicHeaderToField(String, String), but for reverse mappings from field names back to header names.

Specified by:

mapDynamicFieldToHeader in interface ImportSpecification

Parameters:

field - the raw field that needs to be mapped back to a header

rowType - the row type that this mapping is being performed for

Returns:

the mapped header if supported, else null

See Also:

• DynamicHeaderFieldMapping

getRequiredAuthorities

public List<String> getRequiredAuthorities()

Description copied from interface: ImportSpecification

The list of required authorities necessary for carrying out a specific import. For example, a Product import requires you to be able to READ_PRODUCT, UPDATE_PRODUCT, and of course, CREATE_PRODUCT. So we need to be sure to check that a person has access to those authorities when they try to start a Product import.

Specified by:

getRequiredAuthorities in interface ImportSpecification

Returns:

the list of required authorities

getRequiredScopes

public List<String> getRequiredScopes()

Description copied from interface: ImportSpecification

The list of required scopes necessary for carrying out a specific import. This is required for the global-level imports to display the import types that match the current user's permissions.

Specified by:

getRequiredScopes in interface ImportSpecification

Returns:

the list of required scopes

getImportType

public String getImportType()

Description copied from interface: ImportSpecification

Which import type this specification is valid for

Specified by:

getImportType in interface ImportSpecification

Returns:

the Import.getType() that should match this specification

getName

public String getName()

Description copied from interface: ImportSpecification

This is an arbitrary name for the specification, potentially allowing more than one specification for a particular type for a particular tenant or application.

It's possible for this to be used as the Import.getSpecificationRef().

Specified by:

getName in interface ImportSpecification

Returns:

name of this ImportSpecification

getFieldConfigMap

@Deprecated
public LinkedHashMap<String,ImportFieldConfig> getFieldConfigMap()

Deprecated.

This has been deprecated in favor of getHeaderFieldConfigsByRowType().

Specified by:

getFieldConfigMap in interface ImportSpecification

Returns:

a map from header name to the field config for it

See Also:

• ImportSpecification.getHeaderFieldConfigsByRowType()

getHeaderFieldConfigsByRowType

public Map<String,Map<String,ImportFieldConfig>> getHeaderFieldConfigsByRowType()

These represent the fields expected for this specification.

The key of the top level map is the row type, and the value is itself a map from header name to field config. This enables validation to only enforce certain field requirements in specific row types.

If the import type represented by this specification doesn't have the concept of multiple row types, then field configs should be added here under the ImportSpecification.getMainRecordType().

Specified by:

getHeaderFieldConfigsByRowType in interface ImportSpecification

Returns:

a map from row type to another map of headers to field configs. Ideally, the map should be fully immutable (including the nested maps) to prevent inadvertent modification by consumers.

See Also:

• createUnmodifiableHeaderFieldConfigsByRowType()
• populateHeaderFieldConfigsByRowType(Map)

getDynamicHeaderMappingConfigsByRowType

protected Map<String,List<DynamicHeaderFieldMapping>> getDynamicHeaderMappingConfigsByRowType()

See Also:

• mapDynamicHeaderToField(String, String)
• mapDynamicFieldToHeader(String, String)
• createUnmodifiableDynamicHeaderMappingsByRowType()
• populateDynamicHeaderMappingsByRowType(Map)

getDependencyMappings

public Map<String,Set<String>> getDependencyMappings()

Dependency mappings don't change, so define a immutable instance of them for efficiency.

This is important, as getDependencyMappings() is invoked multiple times for each row of an import.

Specified by:

getDependencyMappings in interface ImportSpecification