com.hybris.backoffice.excel.template.sheet

Interface ExcelSheetService

All Known Implementing Classes:

DefaultExcelSheetService

public interface ExcelSheetService

Service responsible for operation on excel's sheet.

Method Summary

Modifier and Type	Method and Description
default Row	createEmptyRow(Sheet sheet) Creates an empty row in given sheet.
Sheet	createOrGetTypeSheet(Workbook workbook, java.lang.String typeCode) Creates a new type sheet in given workbook.
Sheet	createOrGetUtilitySheet(Workbook workbook, java.lang.String sheetName) Creates a new utility sheet in given workbook.
Sheet	createTypeSheet(Workbook workbook, java.lang.String sheetName) Creates a new sheet and adds it to given workbook.
int	findColumnIndex(Sheet typeSystemSheet, Sheet sheet, ExcelAttribute excelAttribute) Finds column index based on selected attribute.
java.lang.String	findSheetNameForTypeCode(Workbook workbook, java.lang.String typeCode) Finds sheet name for given type code.
java.lang.String	findTypeCodeForSheetName(Workbook workbook, java.lang.String sheetName) Finds type code for given sheet name.
default java.util.Optional<Sheet>	getSheet(Workbook workbook, java.lang.String sheetName) Returns sheet in given workbook
java.util.Collection<Sheet>	getSheets(Workbook workbook) Returns all sheets except utility sheets.
java.util.Collection<java.lang.String>	getSheetsNames(Workbook workbook) Returns all sheets names except utility sheets.

Method Detail

createEmptyRow

default Row createEmptyRow(Sheet sheet)

Creates an empty row in given sheet.

Parameters:

sheet - where the row will be created

Returns:

row

createOrGetTypeSheet

Sheet createOrGetTypeSheet(Workbook workbook,
                           java.lang.String typeCode)

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:

workbook - workbook which will be extended by a new sheet

typeCode - a new sheet name

Returns:

newly created of already existed Sheet.

createTypeSheet

Sheet createTypeSheet(Workbook workbook,
                      java.lang.String sheetName)

Creates a new sheet and adds it to given workbook.

Parameters:

workbook - workbook which will be extended by a new sheet

sheetName - a new sheet name

Returns:

newly created Sheet.

createOrGetUtilitySheet

Sheet createOrGetUtilitySheet(Workbook workbook,
                              java.lang.String sheetName)

Creates a new utility sheet in given workbook. If a sheet with given name already exists, it is returned without creating an extra one.

Parameters:

workbook - workbook which will be extended by a new sheet

sheetName - a new sheet name.

Returns:

newly created or already existed Sheet.

findSheetNameForTypeCode

java.lang.String findSheetNameForTypeCode(Workbook workbook,
                                          java.lang.String typeCode)

Finds sheet name for given type code.

Parameters:

workbook - workbook

typeCode - type code

Returns:

found type code.

findTypeCodeForSheetName

java.lang.String findTypeCodeForSheetName(Workbook workbook,
                                          java.lang.String sheetName)

Finds type code for given sheet name.

Parameters:

workbook - workbook

sheetName - sheet name

Returns:

found type code.

findColumnIndex

int findColumnIndex(Sheet typeSystemSheet,
                    Sheet sheet,
                    ExcelAttribute excelAttribute)

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

excelAttribute - 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.

getSheet

default java.util.Optional<Sheet> getSheet(Workbook workbook,
                                           java.lang.String sheetName)

Returns sheet in given workbook

Parameters:

workbook - workbook

sheetName - name of the looked for sheet

Returns:

found or not found sheet

getSheets

java.util.Collection<Sheet> getSheets(Workbook workbook)

Returns all sheets except utility sheets.

Parameters:

workbook - Workbook object which represents excel file

Returns:

collection of sheets

getSheetsNames

java.util.Collection<java.lang.String> getSheetsNames(Workbook workbook)

Returns all sheets names except utility sheets.

Parameters:

workbook - Workbook object which represents excel file

Returns:

collection of sheets names