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.components
Class InputFieldByTextPatternComponent

java.lang.Object
  extended by com.ibm.hats.transform.components.Component
      extended by com.ibm.hats.transform.components.PatternComponent
          extended by com.ibm.hats.transform.components.InputFieldByTextPatternComponent
All Implemented Interfaces:
ICustomPropertySupplier

public class InputFieldByTextPatternComponent
extends PatternComponent

This pattern match component consumes all unconsumed input fields in the consumable field list which contain the specified text at the specified relation to the input field. The recognize() methods of this component return ComponentElement objects of type:

The following settings can be configured for this component:

PropertyDescriptionTypeDefault Value
textString that much exist for the candidate input field to match (maybe include the wildcard * character).String(empty)
locationSpecifies where the text must appear (relative to the candidate input field). Valid values: ABOVE, BELOW, LEFT, RIGHTenumLEFT
caseSensitiveSpecifies whether the candidate input field's candidate text must match the specified text exactly.booleanfalse

See Also:
PatternMatchComponentElement, PatternComponent

Field Summary
static String CLASS_NAME
           
static Properties defaults
          Properties object of default class settings
static String LOCATION_ABOVE
           
static String LOCATION_BELOW
           
static String LOCATION_LEFT
           
static String LOCATION_RIGHT
           
static char MULTI_CHAR_WILDCARD
          Multi-letter substitution wildcard character
static String PROPERTY_CASE_SENSITIVE
          Case sensitivity setting
static String PROPERTY_ENFORCE_IMMEDIACY
           
static String PROPERTY_IMMEDIATELY_NEXT_TO
          Immediately next to setting
static String PROPERTY_LOCATION
          Text location (relative to input field)
static String PROPERTY_TEXT
          Required text setting
static char SINGLE_CHAR_WILDCARD
          Single letter substitution wildcard characters (currently not supported)
 
Fields inherited from class com.ibm.hats.transform.components.PatternComponent
consumableFieldList
 
Fields inherited from class com.ibm.hats.transform.components.Component
contextAttributes, flag, hostScreen
 
Fields inherited from interface com.ibm.hats.common.ICustomPropertySupplier
CLASSNAME
 
Constructor Summary
InputFieldByTextPatternComponent(HsrScreen hostScreen)
          Constructs a new InputFieldByTextPatternComponent pattern component.
InputFieldByTextPatternComponent(HsrScreen hostScreen, ConsumableFieldList consumableFieldList)
          Constructs a new InputFieldByTextPatternComponent pattern component.
 
Method Summary
protected  PatternMatchComponentElement addFoundComponentElement(HsrScreenField field, int fieldIndex, ArrayList ceList)
           
protected  ArrayList findAllInputFields(String text, boolean isCaseSensitive, int location, com.ibm.hats.transform.components.BidiSettings bidiSettings, boolean isImmediateNext2, boolean enforceImmediacy)
           
protected  void findComponentElementsAboveText(ScreenRegion textRegion, PatternMatchComponentElement initialElement, ArrayList ceList)
           
protected  void findComponentElementsBelowText(ScreenRegion textRegion, PatternMatchComponentElement initialElement, ArrayList ceList)
           
protected  void findComponentElementsLeftOfText(ScreenRegion textRegion, ArrayList ceList)
           
protected  void findComponentElementsRightOfText(ScreenRegion textRegion, ArrayList ceList)
           
protected  BlockScreenRegion findMatchingTextRegion(String text, int location, HsrScreenField field, boolean isCaseSensitive, com.ibm.hats.transform.components.BidiSettings bidiSettings, boolean enforceImmediacy)
           
protected  void findTheRestOfComponentElements(int location, ScreenRegion textRegion, PatternMatchComponentElement initialElement, ArrayList ceList)
           
protected  void findTheRestOfComponentElements(int location, ScreenRegion textRegion, PatternMatchComponentElement initialElement, ArrayList ceList, com.ibm.hats.transform.components.BidiSettings bidiSettings)
           
 Vector getCustomProperties(int iPageNumber, Properties properties, ResourceBundle bundle)
          Returns a list of this object's custom properties.
protected  BlockScreenRegion getSearchRegion(int location, HsrScreenField field)
           
protected  boolean isArabicSession()
           
protected  boolean isBidiSession()
           
protected  int isMatch(String lookFor, String lookIn, com.ibm.hats.transform.components.BidiSettings bidiSettings)
           
protected  boolean isRTLScreen()
           
 ComponentElement[] recognize(BlockScreenRegion region, Properties settings)
          Returns an array of PatternMatchComponentElement objects, each representing a field in the consumable field list that was consumed.
 ComponentElement[] recognize(com.ibm.hats.transform.regions.LinearScreenRegion region, Properties settings)
          Currently not supported.
 
Methods inherited from class com.ibm.hats.transform.components.PatternComponent
getConsumableFieldList, newInstance, setConsumableFieldList
 
Methods inherited from class com.ibm.hats.transform.components.Component
convertPosToCol, convertPosToRow, convertRowColToPos, findFirstDelimiterIndex, findFirstIndexOf, findFirstIndexOf, findFirstIndexOf, findFirstNonWhitespaceIndex, findFirstNonWhitespaceIndex, findFirstNonWhitespaceIndex, getContextAttribute, getContextAttributes, getCustomComposite, getDefaultValues, getHostScreen, getPropertyPageCount, getTrailingSpaceCount, newInstance, recognize, setContextAttribute, setContextAttributes, setHostScreen
 
Methods inherited from class java.lang.Object
clone, 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

PROPERTY_TEXT

public static final String PROPERTY_TEXT
Required text setting

See Also:
Constant Field Values

PROPERTY_LOCATION

public static final String PROPERTY_LOCATION
Text location (relative to input field)

See Also:
Constant Field Values

PROPERTY_CASE_SENSITIVE

public static final String PROPERTY_CASE_SENSITIVE
Case sensitivity setting

See Also:
Constant Field Values

PROPERTY_IMMEDIATELY_NEXT_TO

public static final String PROPERTY_IMMEDIATELY_NEXT_TO
Immediately next to setting

See Also:
Constant Field Values

PROPERTY_ENFORCE_IMMEDIACY

public static final String PROPERTY_ENFORCE_IMMEDIACY
See Also:
Constant Field Values

LOCATION_ABOVE

public static final String LOCATION_ABOVE
See Also:
Constant Field Values

LOCATION_BELOW

public static final String LOCATION_BELOW
See Also:
Constant Field Values

LOCATION_LEFT

public static final String LOCATION_LEFT
See Also:
Constant Field Values

LOCATION_RIGHT

public static final String LOCATION_RIGHT
See Also:
Constant Field Values

MULTI_CHAR_WILDCARD

public static final char MULTI_CHAR_WILDCARD
Multi-letter substitution wildcard character

See Also:
Constant Field Values

SINGLE_CHAR_WILDCARD

public static final char SINGLE_CHAR_WILDCARD
Single letter substitution wildcard characters (currently not supported)

See Also:
Constant Field Values

defaults

public static final Properties defaults
Properties object of default class settings

Constructor Detail

InputFieldByTextPatternComponent

public InputFieldByTextPatternComponent(HsrScreen hostScreen)
Constructs a new InputFieldByTextPatternComponent pattern component.

Parameters:
hostScreen -

InputFieldByTextPatternComponent

public InputFieldByTextPatternComponent(HsrScreen hostScreen,
                                        ConsumableFieldList consumableFieldList)
Constructs a new InputFieldByTextPatternComponent pattern component.

Parameters:
hostScreen -
Method Detail

recognize

public ComponentElement[] recognize(com.ibm.hats.transform.regions.LinearScreenRegion region,
                                    Properties settings)
Currently not supported.

Specified by:
recognize in class Component

recognize

public ComponentElement[] recognize(BlockScreenRegion region,
                                    Properties settings)
Returns an array of PatternMatchComponentElement objects, each representing a field in the consumable field list that was consumed.

Specified by:
recognize in class Component
Parameters:
region - screen region to search in
settings - (see table above)
Returns:
an array of ComponentElement objects.

findAllInputFields

protected ArrayList findAllInputFields(String text,
                                       boolean isCaseSensitive,
                                       int location,
                                       com.ibm.hats.transform.components.BidiSettings bidiSettings,
                                       boolean isImmediateNext2,
                                       boolean enforceImmediacy)

findMatchingTextRegion

protected BlockScreenRegion findMatchingTextRegion(String text,
                                                   int location,
                                                   HsrScreenField field,
                                                   boolean isCaseSensitive,
                                                   com.ibm.hats.transform.components.BidiSettings bidiSettings,
                                                   boolean enforceImmediacy)

getSearchRegion

protected BlockScreenRegion getSearchRegion(int location,
                                            HsrScreenField field)

isMatch

protected int isMatch(String lookFor,
                      String lookIn,
                      com.ibm.hats.transform.components.BidiSettings bidiSettings)

addFoundComponentElement

protected PatternMatchComponentElement addFoundComponentElement(HsrScreenField field,
                                                                int fieldIndex,
                                                                ArrayList ceList)

findTheRestOfComponentElements

protected void findTheRestOfComponentElements(int location,
                                              ScreenRegion textRegion,
                                              PatternMatchComponentElement initialElement,
                                              ArrayList ceList)

findTheRestOfComponentElements

protected void findTheRestOfComponentElements(int location,
                                              ScreenRegion textRegion,
                                              PatternMatchComponentElement initialElement,
                                              ArrayList ceList,
                                              com.ibm.hats.transform.components.BidiSettings bidiSettings)

findComponentElementsBelowText

protected void findComponentElementsBelowText(ScreenRegion textRegion,
                                              PatternMatchComponentElement initialElement,
                                              ArrayList ceList)

findComponentElementsAboveText

protected void findComponentElementsAboveText(ScreenRegion textRegion,
                                              PatternMatchComponentElement initialElement,
                                              ArrayList ceList)

findComponentElementsLeftOfText

protected void findComponentElementsLeftOfText(ScreenRegion textRegion,
                                               ArrayList ceList)

findComponentElementsRightOfText

protected void findComponentElementsRightOfText(ScreenRegion textRegion,
                                                ArrayList ceList)

getCustomProperties

public Vector getCustomProperties(int iPageNumber,
                                  Properties properties,
                                  ResourceBundle bundle)
Description copied from interface: ICustomPropertySupplier
Returns a list of this object's custom properties. Items must be of type com.ibm.hats.common.HCustomProperty.

Specified by:
getCustomProperties in interface ICustomPropertySupplier
Overrides:
getCustomProperties in class Component
Parameters:
iPageNumber - page number containing desired properties
properties - existing values for properties defined here
bundle - ResourceBundle containing NLS descriptions for the properties
Returns:
Vector containing all the custom properties for this object, or null if there are none
See Also:
HCustomProperty

isBidiSession

protected boolean isBidiSession()

isArabicSession

protected boolean isArabicSession()

isRTLScreen

protected boolean isRTLScreen()

HATS 7.5.1 (201005110649)