org.pentaho.di.trans.steps.excelinput.poi
Class PoiWorkbook

java.lang.Object
  org.pentaho.di.trans.steps.excelinput.poi.PoiWorkbook

All Implemented Interfaces:

KWorkbook

public class PoiWorkbook
extends Object
implements KWorkbook

Constructor Summary

PoiWorkbook(String filename, String encoding)

Method Summary

void	close() Close the workbook file
String	getEncoding()
String	getFilename()
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()

Methods inherited from class java.lang.Object

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

Constructor Detail

PoiWorkbook

public PoiWorkbook(String filename,
                   String encoding)
            throws KettleException

Throws:

KettleException

Method Detail

close

public void close()

Description copied from interface: KWorkbook

Close the workbook file

Specified by:

close in interface KWorkbook

getSheet

public KSheet getSheet(String sheetName)

Description copied from interface: KWorkbook

Get a sheet with a certain name in a workbook.

Specified by:

getSheet in interface KWorkbook

Parameters:

sheetName - The name of the sheet.

Returns:

The sheet or null if the sheet was not found.

getSheetNames

public String[] getSheetNames()

Specified by:

getSheetNames in interface KWorkbook

Returns:

The array of sheet names in the workbook

getFilename

public String getFilename()

getEncoding

public String getEncoding()

getNumberOfSheets

public int getNumberOfSheets()

Specified by:

getNumberOfSheets in interface KWorkbook

Returns:

The number of sheets in the workbook

getSheet

public KSheet getSheet(int sheetNr)

Description copied from interface: KWorkbook

Get a sheet in the workbook by index

Specified by:

getSheet in interface KWorkbook

Parameters:

sheetNr - The sheet number to get

Returns:

The selected sheet