com.ibm.rational.test.lt.datacorrelation.execution.harvest

Interface IDataHarvester

public interface IDataHarvester

Method Summary

Methods

Modifier and Type	Method and Description
void	addHarvestInstruction(com.ibm.rational.test.lt.datacorrelation.execution.harvest.IHarvestRule rule)
void	addHarvestInstruction(String propertyName, com.ibm.rational.test.lt.datacorrelation.execution.harvest.IDataCorrelationVar dcVar) This will add a harvest instruction to the DataHarvester.
void	addHarvestInstruction(String propertyName, com.ibm.rational.test.lt.datacorrelation.execution.harvest.IDataCorrelationVar dcVar, String regex) This will add a harvest instruction to the DataHarvester.
void	addHarvestInstruction(String propertyName, com.ibm.rational.test.lt.datacorrelation.execution.harvest.IDataCorrelationVar dcVar, String regex, int maxOcc, int occ) This will add a harvest instruction to the DataHarvester.
void	addHarvestInstruction(String propertyName, com.ibm.rational.test.lt.datacorrelation.execution.harvest.IDataCorrelationVar dcVar, String regex, int maxOcc, int occ, boolean removeXMLEntity) This will add a harvest instruction to the DataHarvester.
void	addHarvestInstruction(String propertyName, com.ibm.rational.test.lt.datacorrelation.execution.harvest.IDataCorrelationVar dcVar, String regex, int maxOcc, int occ, boolean removeXMLEntity, String name, RPTEvent behavior, boolean alwaysLog) This will add a harvest instruction to the DataHarvester.
void	addHarvestInstruction(String propertyName, com.ibm.rational.test.lt.datacorrelation.execution.harvest.IDataCorrelationVar dcVar, String regex, int maxOcc, int occ, int minRange, int maxRange, boolean removeXMLEntity, String name, RPTEvent behavior, boolean alwaysLog) This will add a harvest instruction to the DataHarvester.
void	addHarvestInstruction(String propertyName, com.ibm.rational.test.lt.datacorrelation.execution.harvest.IDataCorrelationVar dcVar, String regex, int maxOcc, int occ, int minRange, int maxRange, boolean removeXMLEntity, String name, RPTEvent behavior, int health, boolean alwaysLog) This will add a harvest instruction to the DataHarvester.
ArrayList<org.eclipse.hyades.test.common.event.EventProperty>	getEvents()
void	harvestData(Object action) This function will execute all harvest instructions that are stored in it and set the values in the DataCorrelationVars.
void	harvestData(Object action, boolean fcr) This function will execute all harvest instructions that are stored in it and set the values in the DataCorrelationVars.

Method Detail

addHarvestInstruction

void addHarvestInstruction(String propertyName,
                         com.ibm.rational.test.lt.datacorrelation.execution.harvest.IDataCorrelationVar dcVar,
                         String regex,
                         int maxOcc,
                         int occ)

This will add a harvest instruction to the DataHarvester. The harvest instruction will be executed when harvestData is called.

Parameters:

propertyName - - the property in the action that we will harvest from. ex. - URI

dcVar - - the DataCorrelationVar that the harvested data will be saved into

regex - - the regular expression used to extract the data from the propertyName

maxOcc - - the number of occurences for this regex from the beginning of the string til the one we want

occ - - the number of occ. for this regex from the last harvester in the response string

addHarvestInstruction

void addHarvestInstruction(String propertyName,
                         com.ibm.rational.test.lt.datacorrelation.execution.harvest.IDataCorrelationVar dcVar,
                         String regex,
                         int maxOcc,
                         int occ,
                         boolean removeXMLEntity)

This will add a harvest instruction to the DataHarvester. The harvest instruction will be executed when harvestData is called.

Parameters:

propertyName - - the property in the action that we will harvest from. ex. - URI

dcVar - - the DataCorrelationVar that the harvested data will be saved into

regex - - the regular expression used to extract the data from the propertyName

maxOcc - - the number of occurences for this regex from the beginning of the string til the one we want

occ - - the number of occ. for this regex from the last harvester in the response string

removeXMLEntity - - after harvesting data, if this is true we will remove XMLEntities such as & and replace it with &

addHarvestInstruction

void addHarvestInstruction(String propertyName,
                         com.ibm.rational.test.lt.datacorrelation.execution.harvest.IDataCorrelationVar dcVar,
                         String regex,
                         int maxOcc,
                         int occ,
                         boolean removeXMLEntity,
                         String name,
                         RPTEvent behavior,
                         boolean alwaysLog)

This will add a harvest instruction to the DataHarvester. The harvest instruction will be executed when harvestData is called.

Parameters:

propertyName - - the property in the action that we will harvest from. ex. - URI

dcVar - - the DataCorrelationVar that the harvested data will be saved into

regex - - the regular expression used to extract the data from the propertyName

maxOcc - - the number of occurences for this regex from the beginning of the string til the one we want

occ - - the number of occ. for this regex from the last harvester in the response string

removeXMLEntity - - after harvesting data, if this is true we will remove XMLEntities such as & and replace it with &

name - - the description of the name

behavior - - if the harvest should fail, what action should be taken

alwaysLog - - says to always log this value regardless of logging level specified

addHarvestInstruction

void addHarvestInstruction(String propertyName,
                         com.ibm.rational.test.lt.datacorrelation.execution.harvest.IDataCorrelationVar dcVar,
                         String regex,
                         int maxOcc,
                         int occ,
                         int minRange,
                         int maxRange,
                         boolean removeXMLEntity,
                         String name,
                         RPTEvent behavior,
                         boolean alwaysLog)

This will add a harvest instruction to the DataHarvester. The harvest instruction will be executed when harvestData is called.

Parameters:

propertyName - - the property in the action that we will harvest from. ex. - URI

dcVar - - the DataCorrelationVar that the harvested data will be saved into

regex - - the regular expression used to extract the data from the propertyName

maxOcc - - the number of occurences for this regex from the beginning of the string til the one we want

occ - - the number of occ. for this regex from the last harvester in the response string

removeXMLEntity - - after harvesting data, if this is true we will remove XMLEntities such as & and replace it with &

name - - the description of the name

behavior - - if the harvest should fail, what action should be taken

alwaysLog - - says to always log this value regardless of logging level specified

addHarvestInstruction

void addHarvestInstruction(String propertyName,
                         com.ibm.rational.test.lt.datacorrelation.execution.harvest.IDataCorrelationVar dcVar,
                         String regex,
                         int maxOcc,
                         int occ,
                         int minRange,
                         int maxRange,
                         boolean removeXMLEntity,
                         String name,
                         RPTEvent behavior,
                         int health,
                         boolean alwaysLog)

This will add a harvest instruction to the DataHarvester. The harvest instruction will be executed when harvestData is called.

Parameters:

propertyName - - the property in the action that we will harvest from. ex. - URI

dcVar - - the DataCorrelationVar that the harvested data will be saved into

regex - - the regular expression used to extract the data from the propertyName

maxOcc - - the number of occurences for this regex from the beginning of the string til the one we want

occ - - the number of occ. for this regex from the last harvester in the response string

removeXMLEntity - - after harvesting data, if this is true we will remove XMLEntities such as & and replace it with &

name - - the description of the name

behavior - - if the harvest should fail, what action should be taken

health - - whether to contribute to health of action

alwaysLog - - says to always log this value regardless of logging level specified

addHarvestInstruction

void addHarvestInstruction(String propertyName,
                         com.ibm.rational.test.lt.datacorrelation.execution.harvest.IDataCorrelationVar dcVar,
                         String regex)

This will add a harvest instruction to the DataHarvester. The harvest instruction will be executed when harvestData is called.

Parameters:

propertyName - - the property in the action that we will harvest from. ex. - URI

dcVar - - the DataCorrelationVar that the harvested data will be saved into

regex - - the regular expression used to extract the data from the propertyName

addHarvestInstruction

void addHarvestInstruction(String propertyName,
                         com.ibm.rational.test.lt.datacorrelation.execution.harvest.IDataCorrelationVar dcVar)

This will add a harvest instruction to the DataHarvester. The harvest instruction will be executed when harvestData is called. This will harvest an entire field.

Parameters:

propertyName - - the property in the action that we will harvest from. ex. - URI

dcVar - - the DataCorrelationVar that the harvested data will be saved into

addHarvestInstruction

void addHarvestInstruction(com.ibm.rational.test.lt.datacorrelation.execution.harvest.IHarvestRule rule)

Parameters:

rule - - the harvest rule to be added for this request

harvestData

void harvestData(Object action)

This function will execute all harvest instructions that are stored in it and set the values in the DataCorrelationVars.

Parameters:

action - - the action to perform the harvest on

harvestData

void harvestData(Object action,
               boolean fcr)

This function will execute all harvest instructions that are stored in it and set the values in the DataCorrelationVars.

Parameters:

action - - the action to perform the harvest on

fcr - - if we should fcr harvester or not

getEvents

ArrayList<org.eclipse.hyades.test.common.event.EventProperty> getEvents()

Returns:

- a list of Events to add to the extended events to be logged