com.ibm.rational.test.lt.datacorrelation.testgen.proto

Interface IProtoElementAdapter

public interface IProtoElementAdapter

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canHarvest(IDCStringLocator strl) This will determine if this ProtocolAdapter wants to/can be a data source or not for this site
boolean	canSubstitute(IDCStringLocator strl) This will determine if this ProtocolAdapter wants to/can perform substitution on the specified element or not
IDCStringLocator	findDPColName(IDCStringLocator strl) This will try to find an appropriate column name for a given value
List<?>	findHarvestSites(IDCStringLocator strl, CBActionElement cb) Given a string, we will work backwards from that element through the test and find all possible sites where the string is found.
void	findReference(LTTest test, com.ibm.rational.test.common.models.behavior.cbdata.Substituter sub, ArrayList<CBActionElement> elem, int index) this will find references for the substituter
List<com.ibm.rational.test.common.models.behavior.cbdata.Substituter>	findSubs(ArrayList<CBActionElement> elem, int index) this will create Substitution sites for the current element
String	getPropertyString(CBActionElement cb, String propertyType) This will get a string of type propertyType out of a CBActionElement
String	getPropertyType(CBActionElement cb, String type) This will take a propertyType used to retrieve behavior model elements and convert it to an execution propertyType
boolean	getShouldEncode(IDCStringLocator dataString)
com.ibm.rational.test.common.models.behavior.cbdata.DataSource	makeDataSource(IDCStringLocator strl)
com.ibm.rational.test.common.models.behavior.cbdata.Substituter	makeSub(IDCStringLocator strl)
void	uninit() this will free up any static resources used for automatic data correlation

Method Detail

findSubs

List<com.ibm.rational.test.common.models.behavior.cbdata.Substituter> findSubs(ArrayList<CBActionElement> elem,
                                                                             int index)

this will create Substitution sites for the current element

Parameters:

elem - - the list of actions to be correlated

index - - the index for where to start finding correlations

Returns:

- a list of substituters created for this element. Return null if you did not want to find substituters for this element and want another protocol element adapter to try instead.

findReference

void findReference(LTTest test,
                 com.ibm.rational.test.common.models.behavior.cbdata.Substituter sub,
                 ArrayList<CBActionElement> elem,
                 int index)

this will find references for the substituter

Parameters:

elem - - the list of actions to be correlated

index - - the index for where to start finding correlations

uninit

void uninit()

this will free up any static resources used for automatic data correlation

findHarvestSites

List<?> findHarvestSites(IDCStringLocator strl,
                       CBActionElement cb)

Given a string, we will work backwards from that element through the test and find all possible sites where the string is found. This method needs to return a list of all sites that are found that are "possible" references for the string passed into it.

Parameters:

strl - - information about the string we want to find harvest sites for

cb - - where in the behavior model to start the search.

Returns:

- a list of IDCStringLocators with possible harvest sites

getPropertyString

String getPropertyString(CBActionElement cb,
                       String propertyType)

This will get a string of type propertyType out of a CBActionElement

Parameters:

cb - - the element to retrieve the string from

propertyType - - the property type of the string to be retrieved

Returns:

- the string

getPropertyType

String getPropertyType(CBActionElement cb,
                     String type)

This will take a propertyType used to retrieve behavior model elements and convert it to an execution propertyType

Parameters:

cb - - the element to retrieve the real type from

type - - the type

Returns:

- the type to write into the codegen script to be used for execution

findDPColName

IDCStringLocator findDPColName(IDCStringLocator strl)

This will try to find an appropriate column name for a given value

Parameters:

strl - - string locator with info for dp value

Returns:

- null if no suitable name found, otherwise, a name

canSubstitute

boolean canSubstitute(IDCStringLocator strl)

This will determine if this ProtocolAdapter wants to/can perform substitution on the specified element or not

Parameters:

strl - - info about the element you want to know if substitution can be performed on

Returns:

- true if substitution can be done, false if substitution can not be done

canHarvest

boolean canHarvest(IDCStringLocator strl)

This will determine if this ProtocolAdapter wants to/can be a data source or not for this site

Parameters:

strl - - info about the element you want to know if harvesting can be performed for

Returns:

- true if harvesting can be done, false if harvesting can not be done

getShouldEncode

boolean getShouldEncode(IDCStringLocator dataString)

Parameters:

dataString - - the dataString that might need to be encoded

Returns:

- true if value should be encoded, false if it shouldn't

makeSub

com.ibm.rational.test.common.models.behavior.cbdata.Substituter makeSub(IDCStringLocator strl)

Parameters:

strl - - the string locator info to make a substituter from

Returns:

- the substituter

makeDataSource

com.ibm.rational.test.common.models.behavior.cbdata.DataSource makeDataSource(IDCStringLocator strl)

Parameters:

strl - - the string locator info to make a datasource from

Returns:

- the datasource