|
HATS 7.5.1 Web API ReferencePublicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product. |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.ibm.hats.transform.components.Component
com.ibm.hats.transform.components.PatternComponent
com.ibm.hats.transform.components.InputFieldBySizePatternComponent
public class InputFieldBySizePatternComponent
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:
| Property | Description | Type | Default Value |
|---|---|---|---|
| fieldSize | Specifies the length (size) each field must be in order to be consumed. | int | 1 |
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 |
|---|
public static final String CLASS_NAME
public static final String PROPERTY_FIELD_SIZE
| Constructor Detail |
|---|
public InputFieldBySizePatternComponent(HsrScreen hostScreen)
InputFieldBySizePatternComponent object.
hostScreen -
public InputFieldBySizePatternComponent(HsrScreen hostScreen,
ConsumableFieldList fieldList)
InputFieldBySizePatternComponent object.
hostScreen - fieldList - list of candidate fields| Method Detail |
|---|
public ComponentElement[] recognize(BlockScreenRegion region,
Properties settings)
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).
recognize in class Componentregion - screen region to search insettings - (see table above)
public ComponentElement[] recognize(com.ibm.hats.transform.regions.LinearScreenRegion region,
Properties settings)
recognize in class Componentpublic int getPropertyPageCount()
ICustomPropertySupplierNote: Currently only 0 or 1 pages are supported.
getPropertyPageCount in interface ICustomPropertySuppliergetPropertyPageCount in class Component
public Vector getCustomProperties(int iPageNumber,
Properties properties,
ResourceBundle bundle)
ICustomPropertySuppliercom.ibm.hats.common.HCustomProperty.
getCustomProperties in interface ICustomPropertySuppliergetCustomProperties in class ComponentiPageNumber - page number containing desired propertiesproperties - existing values for properties defined herebundle - ResourceBundle containing NLS descriptions for the properties
HCustomProperty
|
HATS 7.5.1 (201005110649) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||