com.canoo.webtest.plugins.exceltest
Class AbstractExcelSheetStep

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          com.canoo.webtest.steps.Step
              com.canoo.webtest.plugins.exceltest.AbstractExcelStep
                  com.canoo.webtest.plugins.exceltest.AbstractExcelSheetStep

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

AbstractExcelCellStep, ExcelFindRow, ExcelSelectSheet

public abstract class AbstractExcelSheetStep
extends AbstractExcelStep

Base class for steps that deal with an individual sheet of an Excel spreadsheet.

Author:

Rob Nielsen

See Also:

Serialized Form

Field Summary

Fields inherited from class com.canoo.webtest.plugins.exceltest.AbstractExcelStep

KEY_CURRENT_SHEET

Fields inherited from class com.canoo.webtest.steps.Step

DEFAULT_DESCRIPTION, ELEMENT_ATTRIBUTE_ID, ELEMENT_ATTRIBUTE_NAME, PROPERTY_TYPE_ANT, PROPERTY_TYPE_ANT_STRICT, PROPERTY_TYPE_DEFAULT, PROPERTY_TYPE_DYNAMIC

Fields inherited from class org.apache.tools.ant.Task

target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Constructor Summary

AbstractExcelSheetStep()

Method Summary

protected org.apache.poi.hssf.usermodel.HSSFSheet	getExcelSheet()
String	getSheetIndex()
String	getSheetName()
protected void	setCurrentSheet(org.apache.poi.hssf.usermodel.HSSFSheet sheet)
void	setSheetIndex(String index)
void	setSheetName(String name)
protected void	verifyParameters() Called to let the step's implementation validate its parameters.

Methods inherited from class com.canoo.webtest.plugins.exceltest.AbstractExcelStep

getExcelWorkbook, verifyStrings

Methods inherited from class com.canoo.webtest.steps.Step

addComputedParameters, clone, doExecute, emptyParamCheck, execute, getComputedParameters, getContext, getDefaultPropertyType, getDescription, getDuration, getParameterDictionary, getStepLabel, getVerifier, getWebtestProperties, getWebtestProperties, getWebtestProperty, getWebtestProperty, handleException, hasDescription, integerParamCheck, isCompleted, isPerformingAction, isStarted, isSuccessful, notifyCompleted, notifyStarted, notifyStepResultsListeners, notifySuccess, nullParamCheck, nullResponseCheck, optionalIntegerParamCheck, paramCheck, positiveOrZeroParamCheck, setStepid, setWebtestProperty, setWebtestProperty, toString

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractExcelSheetStep

public AbstractExcelSheetStep()

Method Detail

setCurrentSheet

protected void setCurrentSheet(org.apache.poi.hssf.usermodel.HSSFSheet sheet)

getExcelSheet

protected org.apache.poi.hssf.usermodel.HSSFSheet getExcelSheet()

setSheetName

public void setSheetName(String name)

Parameters:

name - The Sheet Name

getSheetName

public String getSheetName()

setSheetIndex

public void setSheetIndex(String index)

Parameters:

index - The index of the sheet to select

getSheetIndex

public String getSheetIndex()

verifyParameters

protected void verifyParameters()

Description copied from class: Step

Called to let the step's implementation validate its parameters. The method is called after parameter extensions but before Step.doExecute(). This implementation does nothing, overwrite as needed.

Overrides:

verifyParameters in class AbstractExcelStep