idare.imagenode.Interfaces.DataSetReaders.WorkBook

Interface IDAREWorkbook

All Known Implementing Classes:

BasicIDAREWorkbook, POIWorkBook

public interface IDAREWorkbook

An IDAREWorkbook contains one or multiple sets of data in individual IDARESheets

Author:

Thomas Pfau

Method Summary

Modifier and Type	Method and Description
int	getNumberOfSheets() Get the number of individual data sheets present in this workbook
IDARESheet	getSheet(String arg0) Get the sheet with the specified name
IDARESheet	getSheetAt(int arg0) Get the Sheet at the requested position, or null if it does not exist-
int	getSheetIndex(IDARESheet arg0) Get the index of the provided IDARESheet.
int	getSheetIndex(String arg0) Get the 0-based index of a sheet with the provided name
String	getSheetName(int arg0) Get the name of the sheet at the provided position

Method Detail

getNumberOfSheets

int getNumberOfSheets()

Get the number of individual data sheets present in this workbook

Returns:

the number of non null sheets in this Workbook

getSheet

IDARESheet getSheet(String arg0)

Get the sheet with the specified name

Parameters:

arg0 - the name of the requested sheet

Returns:

the requested IDARESheet, or null if it does not exist.

getSheetAt

IDARESheet getSheetAt(int arg0)

Get the Sheet at the requested position, or null if it does not exist-

Parameters:

arg0 - the 0-based position of the Sheet.

Returns:

the sheet at the requested position

getSheetIndex

int getSheetIndex(String arg0)

Get the 0-based index of a sheet with the provided name

Parameters:

arg0 - the name of the IDARESheet

Returns:

the index of the Sheet with the requested name, no two sheets are allowed to have the same name.

getSheetIndex

int getSheetIndex(IDARESheet arg0)

Get the index of the provided IDARESheet.

Parameters:

arg0 - the Sheet for which to obtain the index.

Returns:

the index of the provided sheet.

getSheetName

String getSheetName(int arg0)

Get the name of the sheet at the provided position

Parameters:

arg0 - the position of the sheet for which to obtain the name

Returns:

the name of the IDARESheet, or null if the position does not contain a sheet.