HATS 7.5.1 Web API Reference

Publicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product.

com.ibm.hats.transform.elements
Class PatternMatchComponentElement

java.lang.Object
  extended by com.ibm.hats.transform.elements.ComponentElement
      extended by com.ibm.hats.transform.elements.PatternMatchComponentElement
All Implemented Interfaces:
Cloneable

public class PatternMatchComponentElement
extends ComponentElement

This class represents a pattern match (used by Global Rules).


Field Summary
static String CLASS_NAME
           
 
Fields inherited from class com.ibm.hats.transform.elements.ComponentElement
consumedRegion
 
Constructor Summary
PatternMatchComponentElement(ComponentElement match, ScreenRegion dynamicRegion)
          The parameter constructor.
 
Method Summary
 void doTextReplacement(TextReplacementPair pair, ContextAttributes contextAttributes)
          Method to perform text replacement on this component element.
 ScreenRegion getDynamicRegion()
          Retrieve the dynamic screen region.
 ComponentElement getMatchedElement()
          Retrieve the matched element.
 String getPreviewText()
          Returns some form of descriptive text about the component element.
 boolean isMatch(ComponentElement ce)
          Returns a boolean specifying whether the specified component element "matches" this component element.
 void setDynamicRegion(ScreenRegion region)
          Set the dynamic screen region.
 void setMatchedElement(ComponentElement element)
          Set the matched component element.
 void setScreenId(int id)
           
 
Methods inherited from class com.ibm.hats.transform.elements.ComponentElement
clone, getConsumedRegion, getScreenId, isConsumer, isTruncateToPreserveLength, setConsumedRegion, type, type
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CLASS_NAME

public static final String CLASS_NAME
See Also:
Constant Field Values
Constructor Detail

PatternMatchComponentElement

public PatternMatchComponentElement(ComponentElement match,
                                    ScreenRegion dynamicRegion)
The parameter constructor.

Parameters:
match - The component element.
dynamicRegion - The dynamic screen region.
Method Detail

getDynamicRegion

public ScreenRegion getDynamicRegion()
Retrieve the dynamic screen region.

Returns:
The dynamic screen region.

setDynamicRegion

public void setDynamicRegion(ScreenRegion region)
Set the dynamic screen region.

Parameters:
region - The dynamic screen region.

getMatchedElement

public ComponentElement getMatchedElement()
Retrieve the matched element.

Returns:
The component element.

setMatchedElement

public void setMatchedElement(ComponentElement element)
Set the matched component element.

Parameters:
element - The matched component element.

doTextReplacement

public void doTextReplacement(TextReplacementPair pair,
                              ContextAttributes contextAttributes)
Description copied from class: ComponentElement
Method to perform text replacement on this component element.

Specified by:
doTextReplacement in class ComponentElement
Parameters:
pair - TextReplacementPair to base replacement on
contextAttributes - context attributes

getPreviewText

public String getPreviewText()
Description copied from class: ComponentElement
Returns some form of descriptive text about the component element.

Specified by:
getPreviewText in class ComponentElement

isMatch

public boolean isMatch(ComponentElement ce)
Description copied from class: ComponentElement
Returns a boolean specifying whether the specified component element "matches" this component element.

Currently only implemented by the PatternComponentElement, other classes return false.

Overrides:
isMatch in class ComponentElement
Parameters:
ce - The ComponentElement object for the comparison.
Returns:
A boolean specifying whether the specified component element "matches" this component element.

setScreenId

public void setScreenId(int id)
Overrides:
setScreenId in class ComponentElement

HATS 7.5.1 (201005110649)