com.broadleafcommerce.dataimportutil

Interface HeaderNameMapper

All Known Implementing Classes:

AddressPhoneNameMapper, ArchivedHeaderNameMapper, CategoryProductHeaderMapper, DefaultSkuHeaderMapper, FriendlyHeaderNameMapper, OrderHeaderNameMapper

public interface HeaderNameMapper

Transforms a header from what is given in the CSV file to how that should actually be represented in the system. An example of this is to transform columns that are friendly names (like 'Name') into their actual property representation ('Name' -> 'defaultSku.name'). It is also acceptable to not process headers at all if the CSV is already expected to be in the correct format.

A HeaderNameMapper is associated to the CSVFileImportProcessor to process CSV column headers before the CSV file is read. Multiple HeaderNameMappers can exist in the system and are ordered according to Spring's Order annotation. Once there is a HeaderNameMapper that returns a non-null header, that is the header value used.

Author:

Phillip Verheyden (phillipuniverse)

See Also:

CSVFileImportProcessor}

Method Summary

Modifier and Type	Method and Description
String	transformHeader(String header, ImportType importType) Transform the given original header from the CSV file import into the system representation of that header.

Method Detail

transformHeader

String transformHeader(String header,
                       ImportType importType)

Transform the given original header from the CSV file import into the system representation of that header. This could also just leave the header unprocessed and use whatever the user put in the CSV file itself.

Parameters:

header - the header parsed directly from the CSV file

importType - the type of import that is being performed

Returns:

a transformed version of header or null indicating that it is unprocessed and to look for another HeaderNameMapper