public abstract class TestRecordData
extends java.lang.Object
implements java.io.Serializable
This is the RobotJ equivalent class to the AUGUIInfo seen in Classic.
This can be populated from a STAF Variables pool, although that mechanism would be
provided by a helper class (TestRecordHelper
.java). Notice that
the DEDUCED fields are not populated from the Variables pool. They would later be
set by a processor or Driver object one time.
This object can then be used by a Driver object.
The RobotJ Driver class should be a RobotJ test script(object) called with nothing more than the this TestRecordData object as parameter. The driver should have everything it needs inside the TestRecordData instance. In order to be sure of that, the processor must derive the DEDUCED fields once before proceeding.
Initially, we expect to only forward "C" Driver Commands and "T" step-level test records to RobotJ. So the driver will then route this instance to either a DriverCommands processor (another RobotJ object/script), or a ComponentFunctions processor (another object/script) based on the record type. Although none of that logic is found here, this is stated for context of how this data will later be used.
Modifier and Type | Field and Description |
---|---|
static java.lang.String[] |
POSSIBLE_SEPARATOR
An array of possible test-record-separator.
|
Constructor and Description |
---|
TestRecordData()
Purpose: no-arg constructor to make this fully qualified javabean |
Modifier and Type | Method and Description |
---|---|
TestRecordData |
copyData(TestRecordData target)
Copies the object's data into the target data and returns the target.
|
java.lang.String |
getAltCompType()
Purpose: accessor method(s) |
java.lang.String |
getAppMapName()
Purpose: accessor method(s) |
java.lang.String |
getCommand()
Purpose: accessor method(s) |
java.lang.String |
getCompClass()
Purpose: accessor method(s) |
java.lang.String |
getCompGuiId()
Purpose: accessor method(s) |
java.lang.String |
getCompModule()
Purpose: accessor method(s) |
java.lang.String |
getCompName()
Purpose: accessor method(s) |
java.lang.String |
getCompType()
Purpose: accessor method(s) |
java.lang.String |
getEnvironment()
Purpose: accessor method(s) |
java.lang.String |
getFac()
Purpose: accessor method(s) |
java.lang.String |
getFileID()
Purpose: accessor method(s) |
java.lang.String |
getFilename()
Purpose: accessor method(s) |
java.lang.String |
getInputRecord()
Purpose: accessor method(s) |
java.lang.String |
getInputRecordToken(int n)
Purpose: get the inputRecord token, based on 'separator'
starting from 0. |
java.lang.String |
getInstanceName()
Prefix used to retrieve and store SAFSVARS TestRecordData values.
|
long |
getLineNumber()
Purpose: accessor method(s) |
java.lang.String |
getNotSeparatorString() |
java.lang.String |
getRecordType()
Purpose: accessor method(s) The first token before the separator is the record type (from the inputRecord) There is no setter method because this is a deduced property |
java.lang.String |
getSeparator()
Purpose: accessor method(s) |
int |
getStatusCode()
Purpose: accessor method(s) |
java.lang.String |
getStatusInfo()
Purpose: accessor method(s) |
java.lang.String |
getTestLevel()
Purpose: accessor method(s) |
java.lang.String |
getTrimmedUnquotedInputRecordToken(int n)
Purpose: This method takes the index 'n', retrieves the token from getInputRecordToken, trim() leading and trailing whitespace, and strips one leading and/or trailing quotation mark(#34)--if they exist. |
java.lang.String |
getWinCompName()
Return the windowName+componentName.
|
java.lang.String |
getWindowGuiId()
Purpose: accessor method(s) |
java.lang.String |
getWindowName()
Purpose: accessor method(s) |
int |
inputRecordSize()
Purpose: int, the number of tokens in the inputRecord (based on separator) Assumptions: don't pass along IndexOutOfBoundsException, that is caught and a length of zero is the correct size. |
void |
reinit()
Purpose: reinit this object to be reused over again. |
void |
setAltCompType(java.lang.String altCompType) |
void |
setAppMapName(java.lang.String appMapName) |
void |
setCommand(java.lang.String command) |
void |
setCompClass(java.lang.String compClass) |
void |
setCompGuiId(java.lang.String compGuiId) |
void |
setCompModule(java.lang.String compModule) |
void |
setCompName(java.lang.String compName) |
void |
setCompType(java.lang.String compType) |
void |
setEnvironment(java.lang.String environment) |
void |
setFac(java.lang.String fac) |
void |
setFileID(java.lang.String fileID) |
void |
setFilename(java.lang.String filename) |
void |
setInputRecord(java.lang.String inputRecord) |
void |
setInstanceName(java.lang.String instanceName)
Prefix used to retrieve and store SAFSVARS TestRecordData values.
|
void |
setLineNumber(long lineNumber) |
void |
setRecordType(java.lang.String recordType) |
void |
setSeparator(java.lang.String separator) |
void |
setShutdownData() |
void |
setStatusCode(int statusCode) |
void |
setStatusInfo(java.lang.String statusInfo) |
void |
setTestLevel(java.lang.String testLevel) |
void |
setWindowGuiId(java.lang.String windowGuiId) |
void |
setWindowName(java.lang.String windowName) |
java.lang.String |
toString()
toString method
|
public static java.lang.String[] POSSIBLE_SEPARATOR
public TestRecordData()
public void reinit()
public java.lang.String getFileID()
public void setFileID(java.lang.String fileID)
public java.lang.String getFilename()
public void setFilename(java.lang.String filename)
public long getLineNumber()
public void setLineNumber(long lineNumber)
public java.lang.String getInputRecord()
public void setInputRecord(java.lang.String inputRecord)
public java.lang.String getSeparator()
public void setSeparator(java.lang.String separator)
public java.lang.String getTestLevel()
public void setTestLevel(java.lang.String testLevel)
public java.lang.String getAppMapName()
public void setAppMapName(java.lang.String appMapName)
public java.lang.String getRecordType()
public void setRecordType(java.lang.String recordType)
public java.lang.String getCommand()
public void setCommand(java.lang.String command)
public java.lang.String getWindowName() throws SAFSException
SAFSException
public void setWindowName(java.lang.String windowName)
public java.lang.String getWindowGuiId() throws SAFSException
SAFSException
public void setWindowGuiId(java.lang.String windowGuiId)
public java.lang.String getCompName()
public void setCompName(java.lang.String compName)
public java.lang.String getWinCompName()
public java.lang.String getCompGuiId() throws SAFSException
SAFSException
public void setCompGuiId(java.lang.String compGuiId)
public java.lang.String getCompType() throws SAFSException
SAFSException
public void setCompType(java.lang.String compType)
public java.lang.String getAltCompType()
public void setAltCompType(java.lang.String altCompType)
public java.lang.String getCompClass() throws SAFSException
SAFSException
public void setCompClass(java.lang.String compClass)
public java.lang.String getCompModule() throws SAFSException
SAFSException
public void setCompModule(java.lang.String compModule)
public java.lang.String getEnvironment()
public void setEnvironment(java.lang.String environment)
public java.lang.String getFac()
public void setFac(java.lang.String fac)
public int getStatusCode()
public void setStatusCode(int statusCode)
public java.lang.String getStatusInfo()
public void setStatusInfo(java.lang.String statusInfo)
public java.lang.String getInputRecordToken(int n) throws SAFSNullPointerException
inputRecord
token, based on 'separator'
starting from 0.
inputRecordTokens
(lazily set first time in)
inputRecordTokens
, inputRecord
inputRecordTokens
. Initially it is null. We use StringTokenizer first time only.
n,
- int, the index of which token to return,SAFSNullPointerException,
- if either 'inputRecord' or 'separator' are nullSAFSNullPointerException
public int inputRecordSize() throws SAFSNullPointerException
SAFSNullPointerException,
- if either 'inputRecord' or 'separator' are nullSAFSNullPointerException
public java.lang.String getTrimmedUnquotedInputRecordToken(int n) throws SAFSNullPointerException
n,
- int, the index of which token to return,SAFSNullPointerException,
- if either 'inputRecord' or 'separator' are nullSAFSNullPointerException
public java.lang.String getNotSeparatorString()
public java.lang.String toString()
toString
in class java.lang.Object
public void setShutdownData()
public java.lang.String getInstanceName()
public void setInstanceName(java.lang.String instanceName)
public TestRecordData copyData(TestRecordData target)
Copyright © SAS Institute. All Rights Reserved.