Package com.hybris.backoffice.excel.translators

Class ExcelEurope1PricesTypeTranslator

java.lang.Object

com.hybris.backoffice.excel.translators.AbstractValidationAwareTranslator<T>

com.hybris.backoffice.excel.translators.AbstractExcelValueTranslator<Collection<PriceRowModel>>

com.hybris.backoffice.excel.translators.ExcelEurope1PricesTypeTranslator

All Implemented Interfaces:

ExcelValueTranslator<Collection<PriceRowModel>>, org.springframework.core.Ordered

public class ExcelEurope1PricesTypeTranslator
extends AbstractExcelValueTranslator<Collection<PriceRowModel>>

Price translator which allows to import product prices. It utilises impex Europe1PricesTranslator and Europe1PricesTranslator.Europe1PriceRowTranslator to import prices. Format: price currency:'N'|'G':user|userPriceGroup:quantity unit:[dateFrom to dateTo]:channel where:

• price currency: defines price and currency which are mandatory fields
• N|G: N stands for Europe1PricesTranslator.NETTO and G for Europe1PricesTranslator.GROSS which is taken as default when not provided.
• user|userPriceGroup: User or userPriceGroup for which the price is created
• quantity unit: if not defined then default quantity is 1 and unit is taken from the product but when user or userPriceGroup is given this field is mandatory
• [dateFrom to dateTo]: defines price active range. The date time should be in format ExcelDateUtils.getDateTimeFormat(). Date is exported in ExcelDateUtils.getExportTimeZone() time zone. During import dates are converted from exported time zone to system time zone. By default export/import is done in UTC
• channel: defines channel in which price is valid

Examples:

• 10 EUR::axel:2 pieces:[10.11.2017 12:00:00 to 15:12:2017 12:00:00]:mobile - defines price with value 10 EUR Gross for user axel with min quantity 2 pieces, active from 10.11.2017 12:00:00 to 15:12:2017 12:00:00 in mobile channel
• 20 EUR:N::3 pieces - defines price with value 20 EUR Netto for 3 pieces
• 15 EUR - defines price 15 EUR for 1 unit which will be taken from ProductModel.getUnit()

Under the hood Above examples are translated into format accepted by Europe1PricesTranslator.Europe1PriceRowTranslator

• 10 EUR::axel:2 pieces:[10.11.2017 12:00:00 to 15:12:2017 12:00:00]:mobile -> axel 2 pieces = 10 EUR [10.11.2017 12:00:00,15:12:2017 12:00:00] mobile
• 20 EUR:N::3 pieces ->2 pieces = 20 EUR N
• 15 EUR -> 15 EUR

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHANNEL
static final String	EUROPE1_PRICE_HEADER	Deprecated, for removal: This API element is subject to removal in a future version. since 1811, not used anymore.
static final String	NET_GROSS
static final String	PRICE_CURRENCY
static final String	QUANTITY_UNIT
static final String	USER_OR_UPG

Fields inherited from class com.hybris.backoffice.excel.translators.AbstractExcelValueTranslator

order

Fields inherited from class com.hybris.backoffice.excel.translators.AbstractValidationAwareTranslator

validators

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
ExcelEurope1PricesTypeTranslator()

Method Summary

Modifier and Type	Method	Description
protected void	adjustPriceToCurrentLocale(ImportParameters importParameters)	Deprecated, for removal: This API element is subject to removal in a future version. since 1905.
protected void	appendIfPresent(StringBuilder sb, String value)
protected String	buildSinglePriceImpexValue(Map<String,String> params)
boolean	canHandle(AttributeDescriptorModel attributeDescriptor)	Indicates whether the translator can handle given attribute descriptor.
Optional<Object>	exportData(Collection<PriceRowModel> objectToExport)	Converts given object to value which should be put into cell of exported excel file.
protected String	exportPriceRow(PriceRowModel priceRow)
CommonI18NService	getCommonI18NService()
protected String	getDateRange(StandardDateRange range)
ExcelDateUtils	getExcelDateUtils()
protected String	getImpexDateRange(String dateRange)
protected <T> String	getValueOrEmpty(T reference, Function<T,String> valueSupplier)
ImpexValue	importValue(AttributeDescriptorModel attributeDescriptor, ImportParameters importParameters)	Imports single value instead of whole Impex object.
String	referenceFormat(AttributeDescriptorModel attributeDescriptor)	Format how a reference should be presented.
void	setCommonI18NService(CommonI18NService commonI18NService)
void	setExcelDateUtils(ExcelDateUtils excelDateUtils)

Methods inherited from class com.hybris.backoffice.excel.translators.AbstractExcelValueTranslator

getOrder, getTypeService, importData, isLocalizedOfType, setOrder, setTypeService

Methods inherited from class com.hybris.backoffice.excel.translators.AbstractValidationAwareTranslator

getValidators, setValidators, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hybris.backoffice.excel.translators.ExcelValueTranslator

canHandle, exportData

Field Details

EUROPE1_PRICE_HEADER

@Deprecated(since="1811",
            forRemoval=true)
public static final String EUROPE1_PRICE_HEADER

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

since 1811, not used anymore. The attribute qualifier (DescriptorModel.getQualifier()) will be used as impex header value name (ImpexHeaderValue.name)

See Also:

• Constant Field Values

PRICE_CURRENCY

public static final String PRICE_CURRENCY

See Also:

• Constant Field Values

NET_GROSS

public static final String NET_GROSS

See Also:

• Constant Field Values

USER_OR_UPG

public static final String USER_OR_UPG

See Also:

• Constant Field Values

QUANTITY_UNIT

public static final String QUANTITY_UNIT

See Also:

• Constant Field Values

CHANNEL

public static final String CHANNEL

See Also:

• Constant Field Values

Constructor Details

ExcelEurope1PricesTypeTranslator

public ExcelEurope1PricesTypeTranslator()

Method Details

canHandle

public boolean canHandle(AttributeDescriptorModel attributeDescriptor)

Description copied from interface: ExcelValueTranslator

Indicates whether the translator can handle given attribute descriptor. This method is Recommended during importing excel file.

Parameters:

attributeDescriptor - AttributeDescriptorModel

Returns:

whether the translator can handle request

exportData

public Optional<Object> exportData(Collection<PriceRowModel> objectToExport)

Description copied from interface: ExcelValueTranslator

Converts given object to value which should be put into cell of exported excel file.

Returns:

value which will be put into cell of exported excel file.

exportPriceRow

protected String exportPriceRow(PriceRowModel priceRow)

getDateRange

protected String getDateRange(StandardDateRange range)

getValueOrEmpty

protected <T> String getValueOrEmpty(T reference,
 Function<T,String> valueSupplier)

referenceFormat

public String referenceFormat(AttributeDescriptorModel attributeDescriptor)

Description copied from interface: ExcelValueTranslator

Format how a reference should be presented. Usually references consist of a few fields indicated as unique. Therefore all unique attributes should be included in the format. Example reference format: "catalog:version"

Parameters:

attributeDescriptor - AttributeDescriptorModel

Returns:

Format how a reference should be presented

importValue

public ImpexValue importValue(AttributeDescriptorModel attributeDescriptor,
 ImportParameters importParameters)

Description copied from class: AbstractExcelValueTranslator

Imports single value instead of whole Impex object. Impex value consists of header and value.

Specified by:

importValue in class AbstractExcelValueTranslator<Collection<PriceRowModel>>

Parameters:

attributeDescriptor - AttributeDescriptorModel describes attribute which should be imported

importParameters - - contains information about language for localized field, type code, parsed parameters inserted into excel's cell.

Returns:

ImpexValue value which should be imported

adjustPriceToCurrentLocale

@Deprecated(since="1905",
            forRemoval=true)
protected void adjustPriceToCurrentLocale(ImportParameters importParameters)

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

since 1905. Not used anymore.

buildSinglePriceImpexValue

protected String buildSinglePriceImpexValue(Map<String,String> params)

appendIfPresent

protected void appendIfPresent(StringBuilder sb,
 String value)

getImpexDateRange

protected String getImpexDateRange(String dateRange)

getCommonI18NService

public CommonI18NService getCommonI18NService()

setCommonI18NService

public void setCommonI18NService(CommonI18NService commonI18NService)

getExcelDateUtils

public ExcelDateUtils getExcelDateUtils()

setExcelDateUtils

public void setExcelDateUtils(ExcelDateUtils excelDateUtils)