com.hybris.backoffice.excel.template.sheet

Class DefaultExcelSheetService

java.lang.Object

com.hybris.backoffice.excel.template.sheet.DefaultExcelSheetService

All Implemented Interfaces:

ExcelSheetService

public class DefaultExcelSheetService
extends java.lang.Object
implements ExcelSheetService

Default implementation of ExcelSheetService

Constructor Summary

Constructors

Constructor and Description
DefaultExcelSheetService()

Method Summary

Modifier and Type	Method and Description
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.
protected java.lang.String	findAttributeDisplayNameInTypeSystemSheet(Sheet typeSystemSheet, ExcelAttribute excelAttribute)
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.
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.
void	setAttributeNameFormatter(AttributeNameFormatter<ExcelAttributeDescriptorAttribute> attributeNameFormatter)
void	setCollectionFormatter(CollectionFormatter collectionFormatter)
void	setExcelCellService(ExcelCellService excelCellService)
void	setExcelSheetNamingStrategy(ExcelSheetNamingStrategy excelSheetNamingStrategy)
void	setExcelWorkbookService(ExcelWorkbookService excelWorkbookService)
void	setExcludedSheets(java.util.Collection<ExcelTemplateConstants.UtilitySheet> excludedSheets)
void	setHeaderRowIndex(ExcelTemplateConstants.Header headerRowIndex)
void	setTypeTemplate(ExcelTemplateConstants.UtilitySheet typeTemplate)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hybris.backoffice.excel.template.sheet.ExcelSheetService

createEmptyRow, getSheet

Constructor Detail

DefaultExcelSheetService

public DefaultExcelSheetService()

Method Detail

getSheetsNames

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

Description copied from interface: ExcelSheetService

Returns all sheets names except utility sheets.

Specified by:

getSheetsNames in interface ExcelSheetService

Parameters:

workbook - Workbook object which represents excel file

Returns:

collection of sheets names

getSheets

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

Description copied from interface: ExcelSheetService

Returns all sheets except utility sheets.

Specified by:

getSheets in interface ExcelSheetService

Parameters:

workbook - Workbook object which represents excel file

Returns:

collection of sheets

createOrGetTypeSheet

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

Description copied from interface: ExcelSheetService

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

Specified by:

createOrGetTypeSheet in interface ExcelSheetService

Parameters:

workbook - workbook which will be extended by a new sheet

typeCode - a new sheet name

Returns:

newly created of already existed Sheet.

createTypeSheet

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

Description copied from interface: ExcelSheetService

Creates a new sheet and adds it to given workbook.

Specified by:

createTypeSheet in interface ExcelSheetService

Parameters:

workbook - workbook which will be extended by a new sheet

sheetName - a new sheet name

Returns:

newly created Sheet.

createOrGetUtilitySheet

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

Description copied from interface: ExcelSheetService

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

Specified by:

createOrGetUtilitySheet in interface ExcelSheetService

Parameters:

workbook - workbook which will be extended by a new sheet

sheetName - a new sheet name.

Returns:

newly created or already existed Sheet.

findColumnIndex

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

Description copied from interface: ExcelSheetService

Finds column index based on selected attribute. If column doesn't exist then -1 will be returned.

Specified by:

findColumnIndex in interface ExcelSheetService

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.

findTypeCodeForSheetName

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

Description copied from interface: ExcelSheetService

Finds type code for given sheet name.

Specified by:

findTypeCodeForSheetName in interface ExcelSheetService

Parameters:

workbook - workbook

sheetName - sheet name

Returns:

found type code.

findSheetNameForTypeCode

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

Description copied from interface: ExcelSheetService

Finds sheet name for given type code.

Specified by:

findSheetNameForTypeCode in interface ExcelSheetService

Parameters:

workbook - workbook

typeCode - type code

Returns:

found type code.

findAttributeDisplayNameInTypeSystemSheet

protected java.lang.String findAttributeDisplayNameInTypeSystemSheet(Sheet typeSystemSheet,
                                                                     ExcelAttribute excelAttribute)

setCollectionFormatter

public void setCollectionFormatter(CollectionFormatter collectionFormatter)

setExcelCellService

public void setExcelCellService(ExcelCellService excelCellService)

setExcelSheetNamingStrategy

public void setExcelSheetNamingStrategy(ExcelSheetNamingStrategy excelSheetNamingStrategy)

setAttributeNameFormatter

public void setAttributeNameFormatter(AttributeNameFormatter<ExcelAttributeDescriptorAttribute> attributeNameFormatter)

setExcelWorkbookService

public void setExcelWorkbookService(ExcelWorkbookService excelWorkbookService)

setExcludedSheets

public void setExcludedSheets(java.util.Collection<ExcelTemplateConstants.UtilitySheet> excludedSheets)

setTypeTemplate

public void setTypeTemplate(ExcelTemplateConstants.UtilitySheet typeTemplate)

setHeaderRowIndex

public void setHeaderRowIndex(ExcelTemplateConstants.Header headerRowIndex)