IBM Rational Performance Tester SDK

com.ibm.rational.test.lt.models.behavior.data
Interface CorrelationHarvester

All Superinterfaces:
CBActionElement, CBBlock, com.ibm.rational.test.common.models.behavior.CBBlockElement, com.ibm.rational.test.common.models.behavior.edit.CBCloneable, com.ibm.rational.test.common.models.behavior.edit.CBEdit, com.ibm.rational.test.common.models.behavior.cbdata.CBElementModifier, com.ibm.rational.test.common.models.behavior.errors.CBErrorHost, CBNamedElement, com.ibm.rational.test.common.models.behavior.internal.CBTempData, com.ibm.rational.test.lt.models.behavior.data.CoreHarvester, DataSource, org.eclipse.emf.ecore.EObject, IAdaptable, LTBlock, com.ibm.rational.test.lt.models.behavior.common.LTElementModifier, com.ibm.rational.test.lt.models.behavior.common.LTInternational, org.eclipse.emf.common.notify.Notifier

public interface CorrelationHarvester
extends com.ibm.rational.test.lt.models.behavior.data.CoreHarvester

A representation of the model object 'Correlation Harvester'.

The following features are supported:

See Also:
DataPackage.getCorrelationHarvester()

Field Summary
static int OCCURENCE_LAST
          This is used if we want the regular expression specified to always be the LAST match.
static int OCCURENCE_RANDOM
          This is used if we want the regular expression match to be chosen at random.
static int OCCURRENCE_ALL
          This is only for internal use, i.e. regex assist UI in test editor and rules editor.
 
Fields inherited from interface com.ibm.rational.test.common.models.behavior.edit.CBEdit
MOVE_OLD_PARENT_FLAG
 
Method Summary
 int getOccurrence()
          Returns the value of the 'Occurrence' attribute
 String getRegEx()
          Returns the value of the 'Reg Ex' attribute.
 void setOccurrence(int value)
          Sets the value of the 'Occurrence' attribute
 void setRegEx(String value)
          Sets the value of the 'Reg Ex' attribute
 
Methods inherited from interface com.ibm.rational.test.lt.models.behavior.data.CoreHarvester
getHarvestedAttribute, getHarvestedString, getLength, getOffset, getUILength, getUIOffset, getUIString, setHarvestedAttribute, setHarvestedString, setLength, setOffset, setUILength, setUIOffset, setUIString
 
Methods inherited from interface com.ibm.rational.test.lt.models.behavior.data.DataSource
getConsumers, getConsumersProxy, getCreatedBy, getVariableName, setCreatedBy, setVariableName, unlink
 
Methods inherited from interface com.ibm.rational.test.lt.models.behavior.common.LTBlock
addProxy, createProxy, isProxyReference, processRemoval, removeProxy
 
Methods inherited from interface com.ibm.rational.test.common.models.behavior.CBBlock
getActions, getCBErrors, getCBRequirementTarget, processRemoval, setCBRequirementTarget
 
Methods inherited from interface com.ibm.rational.test.common.models.behavior.CBBlockElement
isControlBlock
 
Methods inherited from interface com.ibm.rational.test.common.models.behavior.CBActionElement
canDisable, canEnable, enable, getAction, getBooleanProperty, getByteProperty, getCharProperty, getDisabledCount, getDoubleProperty, getFloatProperty, getInheritedCBActionElements, getIntProperty, getLongProperty, getMovingFrom, getParent, getShortProperty, getStringProperty, getTransformID, getType, isAlwaysLog, isEnabled, isMoving, move, resetDisabledCount, setAction, setAlwaysLog, setDisabledCount, setEnabled, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setTransformID, setType, validate
 
Methods inherited from interface com.ibm.rational.test.common.models.behavior.CBNamedElement
getDescription, getId, getName, getStopId, setDescription, setId, setName
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 
Methods inherited from interface com.ibm.rational.test.common.models.behavior.internal.CBTempData
getTempAttribute, getTempAttribute, getTempAttributes, setTempAttribute, setTempAttribute, unsetTempAttribute
 
Methods inherited from interface com.ibm.rational.test.common.models.behavior.edit.CBCloneable
doClone, isCloneable
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 
Methods inherited from interface com.ibm.rational.test.common.models.behavior.edit.CBEdit
canCopy, canMove, doCopy, doMove, findProblemsWithCopy, findProblemsWithMove
 
Methods inherited from interface com.ibm.rational.test.common.models.behavior.errors.CBErrorHost
canHostCBErrors, isErrorGenerator
 
Methods inherited from interface com.ibm.rational.test.lt.models.behavior.common.LTInternational
isAsciified, modifyText, modifyText, toDisplay, toModel
 

Field Detail

OCCURENCE_RANDOM

static final int OCCURENCE_RANDOM
This is used if we want the regular expression match to be chosen at random. The occurrence will be -1, which means execute regular expression as many times as possible, and then pick one of those values at random.

See Also:
Constant Field Values

OCCURENCE_LAST

static final int OCCURENCE_LAST
This is used if we want the regular expression specified to always be the LAST match. We will keep executing the regular expression until it cannot be executed anymore.

See Also:
Constant Field Values

OCCURRENCE_ALL

static final int OCCURRENCE_ALL
This is only for internal use, i.e. regex assist UI in test editor and rules editor.

See Also:
Constant Field Values
Method Detail

getRegEx

String getRegEx()
Returns the value of the 'Reg Ex' attribute. The default value is "".

If the meaning of the 'Reg Ex' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Reg Ex' attribute.
See Also:
CorrelationHarvester.setRegEx(String), DataPackage.getCorrelationHarvester_RegEx()

setRegEx

void setRegEx(String value)
Sets the value of the 'Reg Ex' attribute.

Parameters:
value - the new value of the 'Reg Ex' attribute.
See Also:
CorrelationHarvester.getRegEx()

getOccurrence

int getOccurrence()
Returns the value of the 'Occurrence' attribute.

If the meaning of the 'Occurrence' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Occurrence' attribute.
See Also:
CorrelationHarvester.setOccurrence(int), DataPackage.getCorrelationHarvester_Occurrence()

setOccurrence

void setOccurrence(int value)
Sets the value of the 'Occurrence' attribute.

Parameters:
value - the new value of the 'Occurrence' attribute.
See Also:
CorrelationHarvester.getOccurrence()

IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2012. All rights reserved.