org.pentaho.di.core.spreadsheet
Interface KWorkbook

All Known Implementing Classes:
OdfWorkbook, PoiWorkbook, XLSWorkbook

public interface KWorkbook


Method Summary
 void close()
          Close the workbook file
 int getNumberOfSheets()
           
 KSheet getSheet(int sheetNr)
          Get a sheet in the workbook by index
 KSheet getSheet(String sheetName)
          Get a sheet with a certain name in a workbook.
 String[] getSheetNames()
           
 

Method Detail

getSheet

KSheet getSheet(String sheetName)
Get a sheet with a certain name in a workbook.

Parameters:
sheetName - The name of the sheet.
Returns:
The sheet or null if the sheet was not found.

getSheetNames

String[] getSheetNames()
Returns:
The array of sheet names in the workbook

close

void close()
Close the workbook file


getNumberOfSheets

int getNumberOfSheets()
Returns:
The number of sheets in the workbook

getSheet

KSheet getSheet(int sheetNr)
Get a sheet in the workbook by index

Parameters:
sheetNr - The sheet number to get
Returns:
The selected sheet