SheetPOI (Katalon Studio API Specification)

com.kms.katalon.core.testdata.reader.SheetPOI

public class SheetPOI
extends ExcelData

Inherited fields
Fields inherited from class	Fields
`class AbstractTestData`	`hasHeaders, properties, sourceUrl`

Constructor Summary

Constructors
Constructor and description
`SheetPOI (String sourceUrl, boolean hasHeaders, Workbook workbook)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public void`	`changeSheet(String sheetName)` Change this excel data to use another sheet with the specify sheet name
	`protected int`	`getColumnIndex(String colName)`
	`public String[]`	`getColumnNames()` Get all column names of the test data
	`public int`	`getColumnNumbers()` Get total column of the test data
	`public int`	`getMaxColumn(int rowIndex)` Get the max column of a row
	`public int`	`getRowNumbers()` Get total rows of the test data
	`public String`	`getSheetName()` Get the sheet name of this excel data
	`public String[]`	`getSheetNames()` Get all sheet names of the parent excel file
	`protected Object`	`internallyGetValue(int col, int row)`
	`protected Object`	`internallyGetValue(String colName, int row)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class ExcelData`	`getAllData, getMaxColumn, getSheetName, getType`
`class AbstractTestData`	`activeHeaders, getDataInfo, getHeaderRowIdx, getObjectValue, getObjectValue, getProperty, getSourceUrl, getValue, getValue, hasHeaders, internallyGetValue, internallyGetValue, setProperty, verifyColumnIndex, verifyColumnName, verifyRowIndex`

- Constructor Detail
  - public SheetPOI(String sourceUrl, boolean hasHeaders, Workbook workbook)
- Method Detail
  - @Override public void changeSheet(String sheetName)
    
    Change this excel data to use another sheet with the specify sheet name
    Parameters:
    sheetName - the new sheet name
  - protected int getColumnIndex(String colName)
  - @Override public String[] getColumnNames()
    
    Get all column names of the test data
    throws:
    IOException if any io errors happened
    
    Returns:
    an array that contains names of all columns
  - @Override public int getColumnNumbers()
    
    Get total column of the test data
    throws:
    IOException if any io errors happened
    
    Returns:
    total columns of the test data
  - @Override public int getMaxColumn(int rowIndex)
    
    Get the max column of a row
    throws:
    IOException
    
    Parameters:
    rowIndex - the row index
    Returns:
    the max column of a row, or -1 if the row index is invalid
  - @Override public int getRowNumbers()
    
    Get total rows of the test data
    Returns:
    total rows of the test data
  - @Override public String getSheetName()
    
    Get the sheet name of this excel data
    Returns:
    the sheet name
  - @Override public String[] getSheetNames()
    
    Get all sheet names of the parent excel file
    Returns:
    an array contains all the sheet name
  - @Override protected Object internallyGetValue(int col, int row)
  - @Override protected Object internallyGetValue(String colName, int row)

Summary:
Constructor
Method

| Detail:
Constructor
Method

[Java] Class SheetPOI

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

public SheetPOI(String sourceUrl, boolean hasHeaders, Workbook workbook)

Method Detail

@Override public void changeSheet(String sheetName)

protected int getColumnIndex(String colName)

@Override public String[] getColumnNames()

@Override public int getColumnNumbers()

@Override public int getMaxColumn(int rowIndex)

@Override public int getRowNumbers()

@Override public String getSheetName()

@Override public String[] getSheetNames()

@Override protected Object internallyGetValue(int col, int row)

@Override protected Object internallyGetValue(String colName, int row)