Package com.hybris.backoffice.excel.template

Interface ExcelTemplateService

All Known Implementing Classes:
DefaultExcelTemplateService
@Deprecated(since="1808", forRemoval=true) public interface ExcelTemplateService
Deprecated, for removal: This API element is subject to removal in a future version.
since 1808. This service was split for 4 separated services:
Service responsible for operation on excel file.

  • Method Details

    • createWorkbook

      org.apache.poi.ss.usermodel.Workbook createWorkbook(InputStream is)
      Deprecated.
      since 1808. Use ExcelWorkbookService.createWorkbook(InputStream) instead
      Creates workbook object based on inputStream of excel file. If inputStream doesn't contains excel file then new empty Workbook will be returned.
      Parameters:
      is - Input stream of excel file
      Returns:
      Workbook object which represents excel file

    • getTypeSystemSheet

      org.apache.poi.ss.usermodel.Sheet getTypeSystemSheet(org.apache.poi.ss.usermodel.Workbook workbook)
      Deprecated.
      since 1808. Use ExcelWorkbookService.getMetaInformationSheet(Workbook) instead
      Returns sheet which contains metadata about type system
      Parameters:
      workbook - Workbook object which represents excel file
      Returns:
      Sheet which contains information about type system

    • getSheetsNames

      List<String> getSheetsNames(org.apache.poi.ss.usermodel.Workbook workbook)
      Deprecated.
      since 1808. Use ExcelSheetService.getSheetsNames(Workbook) instead
      Returns all sheets names except utility sheets.
      Parameters:
      workbook - Workbook object which represents excel file
      Returns:
      list of sheets names

    • getSheets

      List<org.apache.poi.ss.usermodel.Sheet> getSheets(org.apache.poi.ss.usermodel.Workbook workbook)
      Deprecated.
      since 1808. Use ExcelSheetService.getSheets(Workbook) instead
      Returns all sheets except utility sheets.
      Parameters:
      workbook - Workbook object which represents excel file
      Returns:
      list of sheets

    • getCellValue

      String getCellValue(org.apache.poi.ss.usermodel.Cell cell)
      Deprecated.
      since 1808. Use ExcelCellService.getCellValue(Cell) instead
      Returns cell value as a string value. In case when cell contains formula then the formula is evaluated and result of the evaluation is returned.
      Parameters:
      cell - Cell
      Returns:
      string value of cell

    • getHeaders

      List<SelectedAttribute> getHeaders(org.apache.poi.ss.usermodel.Sheet typeSystemSheet, org.apache.poi.ss.usermodel.Sheet typeSheet)
      Deprecated.
      since 1808. Use ExcelHeaderService.getHeaders(Sheet, Sheet) instead
      Returns list of selected attributes for given sheet, based on metainformation from type system sheet.
      Parameters:
      typeSystemSheet - Sheet contains metainformation about attributes for each type sheets
      typeSheet - Sheet contains data for given sheet
      Returns:
      list of selected attributes

    • getSelectedAttributesQualifiers

      List<SelectedAttributeQualifier> getSelectedAttributesQualifiers(org.apache.poi.ss.usermodel.Sheet typeSystemSheet, org.apache.poi.ss.usermodel.Sheet typeSheet)
      Deprecated.
      since 1808. Use ExcelHeaderService.getSelectedAttributesQualifiers(Sheet, Sheet) instead
      Returns qualifiers of attributes which at selected in the typSheet
      Parameters:
      typeSystemSheet - Sheet contains metainformation about attributes for each type sheets
      typeSheet - Sheet contains data for given sheet
      Returns:
      list of selected attributes.

    • findColumnIndex

      int findColumnIndex(org.apache.poi.ss.usermodel.Sheet typeSystemSheet, org.apache.poi.ss.usermodel.Sheet sheet, SelectedAttribute selectedAttribute)
      Deprecated.
      since 1808. Use ExcelSheetService.findColumnIndex(Sheet, Sheet, ExcelAttribute) instead
      Finds column index based on selected attribute. If column doesn't exist then -1 will be returned.
      Parameters:
      typeSystemSheet - - sheet which contains information about type system
      sheet - sheet for current type
      selectedAttribute - attribute for which column index should be found.
      Returns:
      column index for given selected attribute. If column doesn't exist then -1 will be returned.

    • createTypeSheet

      org.apache.poi.ss.usermodel.Sheet createTypeSheet(String typeCode, org.apache.poi.ss.usermodel.Workbook workbook)
      Deprecated.
      since 1808. Use ExcelSheetService.createTypeSheet(Workbook, String) instead
      Creates a new type sheet in given workbook. If a sheet with given typeCode already exists, it is returned without creating an extra one.
      Parameters:
      typeCode - a new sheet name
      workbook - workbook which will be extended by a new sheet
      Returns:
      sheet

    • findTypeCodeForSheetName

      String findTypeCodeForSheetName(String sheetName, org.apache.poi.ss.usermodel.Workbook workbook)
      Deprecated.
      since 1808. Use ExcelSheetService.findTypeCodeForSheetName(Workbook, String) instead
      Finds type code for given sheet name.
      Parameters:
      sheetName - sheet name.
      workbook - workbook.
      Returns:
      found type code.

    • findSheetNameForTypeCode

      String findSheetNameForTypeCode(String typeCode, org.apache.poi.ss.usermodel.Workbook workbook)
      Deprecated.
      since 1808. Use ExcelSheetService.findSheetNameForTypeCode(Workbook, String) instead
      Finds sheet name for given type code.
      Parameters:
      typeCode - type code
      workbook - workbook
      Returns:
      found type code.

    • addTypeSheet

      void addTypeSheet(String typeName, org.apache.poi.ss.usermodel.Workbook workbook)
      Deprecated.
      since 1808. Use ExcelSheetService.createTypeSheet(Workbook, String) instead
      Adds a new sheet to given workbook.
      Parameters:
      typeName - a new sheet name.
      workbook - workbook which will be extended by a new sheet

    • insertAttributeHeader

      void insertAttributeHeader(org.apache.poi.ss.usermodel.Sheet sheet, SelectedAttribute selectedAttribute, int columnIndex)
      Deprecated.
      since 1808. Use ExcelHeaderService.insertAttributeHeader(Sheet, ExcelAttribute, int) instead
      Inserts value to the sheet's header (first row)
      Parameters:
      sheet - where the value will be inserted
      selectedAttribute - a pojo which allows to retrieve value to insert
      columnIndex - index of a column for inserted value

    • insertAttributesHeader

      void insertAttributesHeader(org.apache.poi.ss.usermodel.Sheet sheet, Collection<SelectedAttribute> selectedAttributes)
      Deprecated.
      since 1808. Use ExcelHeaderService.insertAttributesHeader(Sheet, Collection) instead
      A shortcut for insertAttributeHeader(Sheet, SelectedAttribute, int) It is possible to inserts all values to the header at once instead of invoking insertAttributeHeader(Sheet, SelectedAttribute, int) for every attribute separately
      Parameters:
      sheet - where the value will be inserted
      selectedAttributes - a pojo which allows to retrieve value to insert

    • insertAttributeValue

      void insertAttributeValue(org.apache.poi.ss.usermodel.Cell cell, Object object)
      Deprecated.
      since 1808. Use ExcelCellService.insertAttributeValue(Cell, Object) instead
      Inserts given value to a given cell
      Parameters:
      cell - where the value will be inserted
      object - a value to insert

    • createEmptyRow

      org.apache.poi.ss.usermodel.Row createEmptyRow(org.apache.poi.ss.usermodel.Sheet sheet)
      Deprecated.
      since 1808. Use ExcelSheetService.createEmptyRow(Sheet) instead
      Creates an empty row in given sheet.
      Parameters:
      sheet - where the row will be created
      Returns:
      row

    • getAttributeDisplayName

      String getAttributeDisplayName(AttributeDescriptorModel attributeDescriptorModel, String isoCode)
      Deprecated.
      since 1808. Use DisplayNameAttributeNameFormatter.format(ExcelAttributeContext) instead
      Returns displayed header name based on attribute descriptor
      Parameters:
      attributeDescriptorModel - attribute descriptor of selected attribute
      isoCode - - isoCode of language
      Returns:
      displayed header name based on attribute descriptor