Package com.hybris.backoffice.excel.translators

Class ExcelMediaImportTranslator

java.lang.Object

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

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

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

com.hybris.backoffice.excel.translators.AbstractExcelMediaImportTranslator<MediaModel>

com.hybris.backoffice.excel.translators.ExcelMediaImportTranslator

All Implemented Interfaces:

ExcelValueTranslator<MediaModel>, org.springframework.core.Ordered

Direct Known Subclasses:

ExcelMediaUrlTranslator

public class ExcelMediaImportTranslator
extends AbstractExcelMediaImportTranslator<MediaModel>

Excel translator which allows to import single media reference. For more information AbstractExcelMediaImportTranslator

Field Summary

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

MEDIA_CONTENT_HEADER_NAME, PARAM_CODE, PARAM_FILE_PATH, PARAM_FOLDER

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
ExcelMediaImportTranslator()

Method Summary

Modifier and Type	Method	Description
boolean	canHandle(AttributeDescriptorModel attributeDescriptor)	Indicates whether the translator can handle given attribute descriptor.
java.util.Optional<java.lang.Object>	exportData(MediaModel objectToExport)	Converts given object to value which should be put into cell of exported excel file.
Impex	importData(AttributeDescriptorModel attributeDescriptor, ImportParameters importParameters)	Imports data based on provided importParameters for given attributeDescriptor.

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

addReferencedMedia, addReferencedMedia, addReferencedMedia, createMediaCatalogVersionHeader, createMediaCodeHeader, createMediaContentHeader, createMediaFolderHeader, createMediaReferenceIdHeader, createMediaRow, createReferenceHeader, createReferenceHeader, exportMedia, generateMediaRefId, getCode, getFilePath, getFolder, getMandatoryFilter, getMediaCodeGenerator, hasImportData, importValue, referenceFormat, setMandatoryFilter, setMediaCodeGenerator, setMediaFolderProvider

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

catalogVersionData, catalogVersionHeader, exportCatalogVersionData, getCatalogTypeService, referenceCatalogVersionFormat, setCatalogTypeService

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

getOrder, getTypeService, 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

Constructor Detail

ExcelMediaImportTranslator

public ExcelMediaImportTranslator()

Method Detail

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 java.util.Optional<java.lang.Object> exportData(MediaModel 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.

importData

public Impex importData(AttributeDescriptorModel attributeDescriptor,
                        ImportParameters importParameters)

Description copied from class: AbstractExcelValueTranslator

Imports data based on provided importParameters for given attributeDescriptor. The method returns Impex thanks to that it is possible to creating additional entries ( or example creating part-of entries: product - price row, ect.)

Specified by:

importData in interface ExcelValueTranslator<MediaModel>

Overrides:

importData in class AbstractExcelMediaImportTranslator<MediaModel>

Parameters:

attributeDescriptor - describes attribute which should be imported

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

Returns:

Impex object which is representation of impex script.