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 InputFieldBySizePatternComponent

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

public class InputFieldBySizePatternComponent
extends PatternComponent

This pattern match component consumes all unconsumed input fields in the consumable field list whose length matches the specified length (see the PROPERTY_FIELD_SIZE field).

The recognize() methods of this component return ComponentElement objects of type:

The following settings can be configured for this component:

PropertyDescriptionTypeDefault Value
fieldSizeSpecifies the length (size) each field must be in order to be consumed.int1

See Also:
PatternMatchComponentElement, PatternComponent

Field Summary
static String CLASS_NAME
           
static String PROPERTY_FIELD_SIZE
          Setting name for the field size property
 
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
InputFieldBySizePatternComponent(HsrScreen hostScreen)
          Constructs a new InputFieldBySizePatternComponent object.
InputFieldBySizePatternComponent(HsrScreen hostScreen, ConsumableFieldList fieldList)
          Constructs a new InputFieldBySizePatternComponent object.
 
Method Summary
 Vector getCustomProperties(int iPageNumber, Properties properties, ResourceBundle bundle)
          Returns a list of this object's custom properties.
 int getPropertyPageCount()
          Returns the number of property pages associated with this object.
 ComponentElement[] recognize(BlockScreenRegion region, Properties settings)
          Returns an array of PatternMatchComponentElement objects, each representing a field in the consumable field list that was consumed (because its length was equal to the length specified in the settings).
 ComponentElement[] recognize(com.ibm.hats.transform.regions.LinearScreenRegion region, Properties settings)
          Currently not 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, getDefaultValues, getHostScreen, 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_FIELD_SIZE

public static final String PROPERTY_FIELD_SIZE
Setting name for the field size property

See Also:
Constant Field Values
Constructor Detail

InputFieldBySizePatternComponent

public InputFieldBySizePatternComponent(HsrScreen hostScreen)
Constructs a new InputFieldBySizePatternComponent object.

Parameters:
hostScreen -

InputFieldBySizePatternComponent

public InputFieldBySizePatternComponent(HsrScreen hostScreen,
                                        ConsumableFieldList fieldList)
Constructs a new InputFieldBySizePatternComponent object.

Parameters:
hostScreen -
fieldList - 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 (because its length was equal to the length specified in the settings).

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

recognize

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

Specified by:
recognize in class Component

getPropertyPageCount

public int getPropertyPageCount()
Description copied from interface: ICustomPropertySupplier
Returns the number of property pages associated with this object.

Note: Currently only 0 or 1 pages are supported.

Specified by:
getPropertyPageCount in interface ICustomPropertySupplier
Overrides:
getPropertyPageCount in class Component
Returns:
the number of defined property pages used to configure this object, or 0 if there are none

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

HATS 7.5.1 (201005110649)