Class DefaultExcelWorkbookService

java.lang.Object
com.hybris.backoffice.excel.template.workbook.DefaultExcelWorkbookService
All Implemented Interfaces:
ExcelWorkbookService

public class DefaultExcelWorkbookService extends Object implements ExcelWorkbookService
Default implementation of ExcelWorkbookService
  • Constructor Details

    • DefaultExcelWorkbookService

      public DefaultExcelWorkbookService()
  • Method Details

    • getMetaInformationSheet

      public org.apache.poi.ss.usermodel.Sheet getMetaInformationSheet(@WillNotClose org.apache.poi.ss.usermodel.Workbook workbook)
      Description copied from interface: ExcelWorkbookService
      Returns sheet which contains metadata about type system
      Specified by:
      getMetaInformationSheet in interface ExcelWorkbookService
      Parameters:
      workbook - Workbook object which represents excel file
      Returns:
      Sheet which contains information about type system
    • createWorkbook

      public org.apache.poi.ss.usermodel.Workbook createWorkbook(@WillNotClose InputStream is)
      Description copied from interface: ExcelWorkbookService
      Creates workbook object based on inputStream of excel file. If inputStream doesn't contains excel file then new empty Workbook will be returned.
      Specified by:
      createWorkbook in interface ExcelWorkbookService
      Parameters:
      is - Input stream of excel file
      Returns:
      Workbook object which represents excel file
    • addProperty

      public void addProperty(@WillNotClose org.apache.poi.ss.usermodel.Workbook workbook, @Nonnull String key, @Nonnull String value)
      Description copied from interface: ExcelWorkbookService
      Adds property to given workbook
      Specified by:
      addProperty in interface ExcelWorkbookService
      Parameters:
      workbook - workbook which should be decorated by property
      key - key of property
      value - value of property
    • getProperty

      public Optional<String> getProperty(@WillNotClose org.apache.poi.ss.usermodel.Workbook workbook, @Nonnull String key)
      Description copied from interface: ExcelWorkbookService
      Retrieves property from given workbook
      Specified by:
      getProperty in interface ExcelWorkbookService
      Parameters:
      workbook - the source of the properties
      key - key of the property
      Returns:
      value of searching property
    • getUnderlyingProperties

      public Collection<org.openxmlformats.schemas.officeDocument.x2006.customProperties.CTProperty> getUnderlyingProperties(org.apache.poi.ss.usermodel.Workbook workbook)
      Description copied from interface: ExcelWorkbookService
      Retrieves underlying properties
      Specified by:
      getUnderlyingProperties in interface ExcelWorkbookService
      Parameters:
      workbook - the source of the properties
      Returns:
      collection of underlying properties
    • getProperties

      protected Optional<org.apache.poi.ooxml.POIXMLProperties.CustomProperties> getProperties(org.apache.poi.ss.usermodel.Workbook workbook)
    • setMetaInformationSheet

      public void setMetaInformationSheet(ExcelTemplateConstants.UtilitySheet metaInformationSheet)