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 AllInputFieldsPatternComponent

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.AllInputFieldsPatternComponent
All Implemented Interfaces:
ICustomPropertySupplier

public class AllInputFieldsPatternComponent
extends PatternComponent

This pattern match component consumes all unconsumed input fields in the consumable field list.

There are no settings to configure for this class.

See Also:
PatternMatchComponentElement, PatternComponent

Field Summary
static String CLASS_NAME
           
 
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
AllInputFieldsPatternComponent(HsrScreen hostScreen)
          Constructs a new AllInputFieldsPatternComponent.
AllInputFieldsPatternComponent(HsrScreen hostScreen, ConsumableFieldList consumableFieldList)
          Constructs a new AllInputFieldsPatternComponent.
 
Method Summary
 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)
          Not currently implemented.
 
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, getCustomProperties, 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
Constructor Detail

AllInputFieldsPatternComponent

public AllInputFieldsPatternComponent(HsrScreen hostScreen)
Constructs a new AllInputFieldsPatternComponent.

Parameters:
hostScreen -

AllInputFieldsPatternComponent

public AllInputFieldsPatternComponent(HsrScreen hostScreen,
                                      ConsumableFieldList consumableFieldList)
Constructs a new AllInputFieldsPatternComponent.

Parameters:
hostScreen -
consumableFieldList - list of candidate fields
Method Detail

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 - (not applicable in this component)
Returns:
an array of ComponentElement objects.

recognize

public ComponentElement[] recognize(com.ibm.hats.transform.regions.LinearScreenRegion region,
                                    Properties settings)
Not currently implemented.

Specified by:
recognize in class Component

HATS 7.5.1 (201005110649)