Interface ExcelImportService
- All Known Implementing Classes:
DefaultExcelImportService
public interface ExcelImportService
Service responsible for generating
Impex based on excel file represented by Workbook object. In order
to generating impex script, we can pass the result of {#importData} to ImpexConverter.convert(Impex).-
Method Summary
Modifier and TypeMethodDescriptionconvertToImpex(org.apache.poi.ss.usermodel.Workbook workbook) Transforms excel workbook intoImpexobject.validate(org.apache.poi.ss.usermodel.Workbook workbook) Deprecated, for removal: This API element is subject to removal in a future version.default List<ExcelValidationResult>Deprecated, for removal: This API element is subject to removal in a future version.since 2005 please usevalidate(Workbook, Set, Map)default List<ExcelValidationResult>validate(org.apache.poi.ss.usermodel.Workbook workbook, Set<String> mediaContentEntries, Map<String, Object> context) Validates a workbook.
-
Method Details
-
convertToImpex
Transforms excel workbook intoImpexobject. It takes into account all sheets included in excel file.- Parameters:
workbook-Workbookobject which represents excel file- Returns:
- generated
Impexobject which represents data from the workbook
-
validate
@Deprecated(since="6.7", forRemoval=true) List<ExcelValidationResult> validate(org.apache.poi.ss.usermodel.Workbook workbook) Deprecated, for removal: This API element is subject to removal in a future version.since 6.7 please usevalidate(Workbook, Set)Validates a workbook.- Parameters:
workbook- workbook to validate.- Returns:
- list of validation results.
-
validate
@Deprecated(since="2005", forRemoval=true) default List<ExcelValidationResult> validate(org.apache.poi.ss.usermodel.Workbook workbook, @Nullable Set<String> mediaContentEntries) Deprecated, for removal: This API element is subject to removal in a future version.since 2005 please usevalidate(Workbook, Set, Map)Validates a workbook.- Parameters:
workbook- workbook to validate.mediaContentEntries- set of entries names inside media content attached to the excel file. Null if media is not attached.- Returns:
- list of validation results.
-
validate
default List<ExcelValidationResult> validate(org.apache.poi.ss.usermodel.Workbook workbook, @Nullable Set<String> mediaContentEntries, Map<String, Object> context) Validates a workbook.- Parameters:
workbook- workbook to validate.mediaContentEntries- set of entries names inside media content attached to the excel file. Null if media is not attached.context- context with additional parameters- Returns:
- list of validation results.
-
validate(Workbook, Set)