Package com.hybris.backoffice.excel.imp.wizard

Class ExcelImportHandler

java.lang.Object

com.hybris.backoffice.excel.imp.wizard.ExcelWithoutValidationImportHandler

com.hybris.backoffice.excel.imp.wizard.ExcelImportHandler

All Implemented Interfaces:

com.hybris.cockpitng.widgets.configurableflow.FlowActionHandler

public class ExcelImportHandler
extends ExcelWithoutValidationImportHandler

Handler which is used in Excel Import Process' wizard. Handler allows to start import process if uploaded file passes the validation process.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	XLSX_EXTENSION	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7 no longer used
static java.lang.String	ZIP_EXTENSION	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7 no longer used

Constructor Summary

Constructors

Constructor	Description
ExcelImportHandler()

Method Summary

Modifier and Type	Method	Description
protected org.apache.poi.ss.usermodel.Workbook	createWorkbook(byte[] fileContent)
protected FileContent	findUploadedFileWithExtension(java.util.Set<com.hybris.cockpitng.editor.defaultfileupload.FileUploadResult> uploadedFiles, java.lang.String extension)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7 no longer used.
com.hybris.cockpitng.core.util.CockpitProperties	getCockpitProperties()
ExcelImportService	getExcelImportService()
ExcelImportWorkbookPostProcessor	getExcelImportWorkbookPostProcessor()
protected java.util.Set<java.lang.String>	getFallbackZipEntry(FileContent zipFile, java.nio.charset.Charset charset)
MimeService	getMimeService()
protected java.util.Collection<java.nio.charset.Charset>	getSupportedCharsets()
protected java.util.Set<java.lang.String>	getZipEntries(FileContent zipFile)
protected java.lang.String	getZipFilenameEncodings()
protected boolean	hasValidationErrors(java.util.Collection<ExcelValidationResult> excelValidationResults)
protected void	importExcel(FileContent foundExcelFile, FileContent foundZipFile)
protected java.util.Optional<java.util.Set<java.lang.String>>	listZipEntries(FileContent foundZipFile)
void	perform(com.hybris.cockpitng.config.jaxb.wizard.CustomType customType, com.hybris.cockpitng.widgets.configurableflow.FlowActionHandlerAdapter adapter, java.util.Map<java.lang.String,java.lang.String> parameters)
void	setCockpitProperties(com.hybris.cockpitng.core.util.CockpitProperties cockpitProperties)
void	setExcelImportService(ExcelImportService excelImportService)
void	setExcelImportWorkbookPostProcessor(ExcelImportWorkbookPostProcessor excelImportWorkbookPostProcessor)
void	setMimeService(MimeService mimeService)
protected java.util.List<ExcelValidationResult>	validateExcel(FileContent excelFileContent)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7 please use validateExcel(FileContent, FileContent)
protected java.util.List<ExcelValidationResult>	validateExcel(FileContent excelFileContent, FileContent zipFileContent)

Methods inherited from class com.hybris.backoffice.excel.imp.wizard.ExcelWithoutValidationImportHandler

getCockpitEventQueue, getCronJobService, getExcelCronJobService, getNotificationService, setCockpitEventQueue, setCronJobService, setExcelCronJobService, setNotificationService, toFileContent

Methods inherited from class java.lang.Object

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

Field Detail

ZIP_EXTENSION

@Deprecated(since="6.7",
            forRemoval=true)
public static final java.lang.String ZIP_EXTENSION

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

since 6.7 no longer used

See Also:

Constant Field Values

XLSX_EXTENSION

@Deprecated(since="6.7",
            forRemoval=true)
public static final java.lang.String XLSX_EXTENSION

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

since 6.7 no longer used

See Also:

Constant Field Values

Constructor Detail

ExcelImportHandler

public ExcelImportHandler()

Method Detail

perform

public void perform(com.hybris.cockpitng.config.jaxb.wizard.CustomType customType,
                    com.hybris.cockpitng.widgets.configurableflow.FlowActionHandlerAdapter adapter,
                    java.util.Map<java.lang.String,java.lang.String> parameters)

Specified by:

perform in interface com.hybris.cockpitng.widgets.configurableflow.FlowActionHandler

Overrides:

perform in class ExcelWithoutValidationImportHandler

hasValidationErrors

protected boolean hasValidationErrors(java.util.Collection<ExcelValidationResult> excelValidationResults)

validateExcel

@Deprecated(since="6.7",
            forRemoval=true)
protected java.util.List<ExcelValidationResult> validateExcel(FileContent excelFileContent)

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

since 6.7 please use validateExcel(FileContent, FileContent)

validateExcel

protected java.util.List<ExcelValidationResult> validateExcel(FileContent excelFileContent,
                                                              FileContent zipFileContent)

importExcel

protected void importExcel(FileContent foundExcelFile,
                           FileContent foundZipFile)

Overrides:

importExcel in class ExcelWithoutValidationImportHandler

findUploadedFileWithExtension

@Deprecated(since="6.7",
            forRemoval=true)
protected FileContent findUploadedFileWithExtension(java.util.Set<com.hybris.cockpitng.editor.defaultfileupload.FileUploadResult> uploadedFiles,
                                                    java.lang.String extension)

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

since 6.7 no longer used. Use ExcelWithoutValidationImportHandler.toFileContent(FileUploadResult) to map upload result and ExcelImportWizardForm.getExcelFile() or ExcelImportWizardForm.getZipFile() to obtain file for extension

createWorkbook

protected org.apache.poi.ss.usermodel.Workbook createWorkbook(byte[] fileContent)

listZipEntries

protected java.util.Optional<java.util.Set<java.lang.String>> listZipEntries(FileContent foundZipFile)

getZipEntries

protected java.util.Set<java.lang.String> getZipEntries(FileContent zipFile)

getFallbackZipEntry

protected java.util.Set<java.lang.String> getFallbackZipEntry(FileContent zipFile,
                                                              java.nio.charset.Charset charset)

getSupportedCharsets

protected java.util.Collection<java.nio.charset.Charset> getSupportedCharsets()

getZipFilenameEncodings

protected java.lang.String getZipFilenameEncodings()

getExcelImportService

public ExcelImportService getExcelImportService()

setExcelImportService

public void setExcelImportService(ExcelImportService excelImportService)

getMimeService

public MimeService getMimeService()

setMimeService

public void setMimeService(MimeService mimeService)

getExcelImportWorkbookPostProcessor

public ExcelImportWorkbookPostProcessor getExcelImportWorkbookPostProcessor()

setExcelImportWorkbookPostProcessor

public void setExcelImportWorkbookPostProcessor(ExcelImportWorkbookPostProcessor excelImportWorkbookPostProcessor)

getCockpitProperties

public com.hybris.cockpitng.core.util.CockpitProperties getCockpitProperties()

setCockpitProperties

public void setCockpitProperties(com.hybris.cockpitng.core.util.CockpitProperties cockpitProperties)