net.sf.jameleon.plugin.httpunit
Class HUGetMatchingTextTag

java.lang.Object
  org.apache.commons.jelly.TagSupport
      net.sf.jameleon.LocationAwareTagSupport
          net.sf.jameleon.JameleonTagSupport
              net.sf.jameleon.function.FunctionTag
                  net.sf.jameleon.plugin.httpunit.HttpUnitFunctionTag
                      net.sf.jameleon.plugin.httpunit.HUGetMatchingTextTag

All Implemented Interfaces:

BreakPoint, Attributable, Storable, TextMatcher, DynaTag, LocationAware, Tag

public class HUGetMatchingTextTag
extends HttpUnitFunctionTag
implements TextMatcher

Gets the matching text against the currently active browser and sets the matching text in the provided context variable name. Created on May 16, 2006

Author:

Pravin Bhujbal, Christian Hargraves

Tag Name: <hu-get-matching-text> Type: action
Steps:

1. Find the given regular expression in the current document
2. Store the matching text in the provided variable name.

Field Summary

protected String	regex The pattern which is to be used to extract the data from the repsonse
protected int	regexGroup The group number (based on parenthesis) to extract the data from.
protected String	varName The name by which a context variable will be created

Fields inherited from class net.sf.jameleon.plugin.httpunit.HttpUnitFunctionTag

currentPage, httpUnitFrameName, listener, requestTime, session

Fields inherited from class net.sf.jameleon.function.FunctionTag

addt, breakPoint, expectException, expectFailure, fResults, functionDelay, functionId, lastFileWritten, log, NO_DELAY, params, postcondition, precondition, st, state, tct, vpt

Fields inherited from class net.sf.jameleon.JameleonTagSupport

attributes, broker, contextVars, fp, unsupportedAttributes

Fields inherited from class net.sf.jameleon.LocationAwareTagSupport

columnNumber, elementTagName, lineNumber, scriptFileName

Fields inherited from class org.apache.commons.jelly.TagSupport

body, context, hasTrimmed, parent, shouldTrim

Constructor Summary

HUGetMatchingTextTag()

Method Summary

String	getCurrentScreenAsText() Get the text representing the current screen.
void	testBlock()

Methods inherited from class net.sf.jameleon.plugin.httpunit.HttpUnitFunctionTag

assertFormElementPresent, assertFormElementPresent, assertFormElementPresent, assertFormElementPresent, assertFormPresent, assertFormPresent, assertFormPresent, assertFormPresent, assertFormPresent, assertFormPresent, assertImageNotPresent, assertImageNotPresent, assertImageNotPresent, assertImageNotPresent, assertImagePresent, assertImagePresent, assertImagePresent, assertImagePresent, assertLinkPresent, assertLinkPresent, assertLinkPresent, assertLinkPresent, assertLinkPresentInTable, assertLinkPresentInTable, assertLinkPresentInTable, assertOptionDisplayContains, assertOptionDisplayContains, assertOptionDisplayContains, assertOptionDisplayContains, assertOptionDisplayEndsWith, assertOptionDisplayEndsWith, assertOptionDisplayEndsWith, assertOptionDisplayEndsWith, assertOptionDisplayEquals, assertOptionDisplayEquals, assertOptionDisplayEquals, assertOptionDisplayEquals, assertOptionDisplayStartsWith, assertOptionDisplayStartsWith, assertOptionDisplayStartsWith, assertOptionDisplayStartsWith, assertOptionValueEquals, assertOptionValueEquals, assertOptionValueEquals, assertOptionValueEquals, assertTableNotPresent, assertTableNotPresent, assertTableNotPresent, assertTableNotPresent, assertTablePresent, assertTablePresent, assertTablePresent, assertTablePresent, assertTextInputEquals, assertTextInputEquals, assertTextInputEquals, assertTextInputEquals, assertTextNotPresent, assertTextNotPresent, assertTextNotPresent, assertTextNotPresent, assertTextNotPresent, assertTextNotPresent, assertTextNotPresent, assertTextNotPresent, assertTextPresent, assertTextPresent, assertTextPresent, assertTextPresent, assertTextPresent, assertTextPresent, assertTextPresent, assertTextPresent, assertTitleContains, assertTitleContains, assertTitleContains, assertTitleContains, assertTitleEquals, assertTitleEquals, assertTitleEquals, assertTitleEquals, assertTitleEquals, assertTitleEquals, assertTitleEquals, assertTitleEquals, assertTitleNotEquals, assertTitleNotEquals, assertTitleNotEquals, assertTitleNotEquals, beginSession, beginSessionAt, clickButton, clickButtonWithID, clickButtonWithName, clickLink, clickLink, clickLink, clickLinkWithId, clickLinkWithImage, clickLinkWithImageSrc, clickLinkWithText, getBaseUrl, getCurrentPage, getCurrentPageText, getForm, getHttpSession, getImage, getLink, getLinkInTable, getOptionDisplay, getOptionValue, getOptionValueContains, getOptionValueEndsWith, getOptionValueMatches, getOptionValueStartsWith, getResponse, getTable, getTableColumnCells, getTrimmedCellText, pluginTearDown, setFormParameterValueFromContext, setHttpUnitFrameName, setupEnvironment, store, submitForm, submitForm

Methods inherited from class net.sf.jameleon.function.FunctionTag

addParam, addRequiredAttribute, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertFalse, assertFalse, assertFalse, assertFalse, assertMethod, assertMethodWithLevel, assertNotNull, assertNotNull, assertNotNull, assertNotNull, assertNotSame, assertNotSame, assertNotSame, assertNotSame, assertNull, assertNull, assertNull, assertNull, assertRegexMatches, assertRegexMatches, assertRegexMatches, assertRegexMatches, assertSame, assertSame, assertSame, assertSame, assertTextContains, assertTextContains, assertTextContains, assertTextContains, assertTextEndsWith, assertTextEndsWith, assertTextEndsWith, assertTextEndsWith, assertTextStartsWith, assertTextStartsWith, assertTextStartsWith, assertTextStartsWith, assertTrue, assertTrue, assertTrue, assertTrue, checkParamTypes, cleanUp, cleanUpEnvironment, delay, delay, doTag, fail, fail, fail, fail, getFunctionId, getFunctionResults, getMatchingRegexText, getParam, getParamLength, getParams, getParentTags, getSessionTag, getStoreToFileName, getStringOrDefault, getTestCaseTag, getVariable, getVariableAsBoolean, getVariableAsList, getVariableAsString, isBreakPoint, isContextVariableNull, recordFunctionResult, regexMatches, removeFunctionResult, removeVariable, setDefaultVariableValue, setDefaultVariableValue, setExpectException, setExpectFailure, setFunctionDelay, setFunctionId, setup, setUpFunctionResults, setVariable, tearDown, traceMsg, validate

Methods inherited from class net.sf.jameleon.JameleonTagSupport

cleanVariablesInContext, createAttributes, describeAttributes, getAttributeBroker, getAttributes, getAttributeType, getClassAttributes, getFunctionalPoint, getUnsupportedAttributes, loadFunctionalPoint, resetFunctionalPoint, setAttribute, setVariableInContext, testForUnsupportedAttributesCaught

Methods inherited from class net.sf.jameleon.LocationAwareTagSupport

getColumnNumber, getElementName, getFileName, getLineNumber, setColumnNumber, setElementName, setFileName, setLineNumber

Methods inherited from class org.apache.commons.jelly.TagSupport

findAncestorWithClass, findAncestorWithClass, findAncestorWithClass, findAncestorWithClass, findAncestorWithClass, findAncestorWithClass, getBody, getBodyText, getBodyText, getContext, getParent, invokeBody, isEscapeText, isTrim, setBody, setContext, setEscapeText, setParent, setTrim, trimBody

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.jameleon.util.TextMatcher

getMatchingRegexText, setVariable

Methods inherited from interface org.apache.commons.jelly.Tag

getBody, getContext, getParent, invokeBody, setBody, setContext, setParent

Field Detail

varName

protected String varName

The name by which a context variable will be created

This attribute is recognized by Jameleon
Context Name: huGetMatchinTextVarName

regex

protected String regex

The pattern which is to be used to extract the data from the repsonse

This attribute is recognized by Jameleon
Context Name: huGetMatchinTextRegex

regexGroup

protected int regexGroup

The group number (based on parenthesis) to extract the data from. For example, the following regex has two different groups: (Some text ([\\d]+)) The first group would be the entire expression. The second group would be only the matching numbers.

This attribute is recognized by Jameleon
Context Name: huGetMatchinTextRegexGroup

Constructor Detail

HUGetMatchingTextTag

public HUGetMatchingTextTag()

Method Detail

testBlock

public void testBlock()

Overrides:

testBlock in class FunctionTag

getCurrentScreenAsText

public String getCurrentScreenAsText()

Get the text representing the current screen.

Specified by:

getCurrentScreenAsText in interface TextMatcher

Returns:

String - the text representing the current screen.