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 PatternComponent

java.lang.Object
  extended by com.ibm.hats.transform.components.Component
      extended by com.ibm.hats.transform.components.PatternComponent
All Implemented Interfaces:
ICustomPropertySupplier
Direct Known Subclasses:
AllInputFieldsPatternComponent, InputFieldByPositionPatternComponent, InputFieldBySizePatternComponent, InputFieldByTextPatternComponent

public abstract class PatternComponent
extends Component

This class is the superclass for all pattern component classes. Pattern component classes are used within the Global Rules architecture to recognize specific fields.

See Also:
ConsumableFieldList

Field Summary
protected  ConsumableFieldList consumableFieldList
          List of candidate fields to match on.
 
Fields inherited from class com.ibm.hats.transform.components.Component
CLASS_NAME, contextAttributes, flag, hostScreen
 
Fields inherited from interface com.ibm.hats.common.ICustomPropertySupplier
CLASSNAME
 
Constructor Summary
PatternComponent(HsrScreen hostScreen)
          Constructs a new PatternComponent object.
PatternComponent(HsrScreen hostScreen, ConsumableFieldList consumableFieldList)
          Constructs a new PatternComponent object which will search on the specified consumableFieldList for matches.
 
Method Summary
 ConsumableFieldList getConsumableFieldList()
          Returns the ConsumableFieldList for this pattern component.
static PatternComponent newInstance(String className, ClassLoader classLoader, HsrScreen hs, ConsumableFieldList fieldList)
          Convenience method to construct a new pattern component with the specified class name.
 void setConsumableFieldList(ConsumableFieldList list)
          Sets the ConsumableFieldList for this pattern component.
 
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, recognize, recognize, setContextAttribute, setContextAttributes, setHostScreen
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

consumableFieldList

protected ConsumableFieldList consumableFieldList
List of candidate fields to match on.

Constructor Detail

PatternComponent

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

Parameters:
hostScreen -

PatternComponent

public PatternComponent(HsrScreen hostScreen,
                        ConsumableFieldList consumableFieldList)
Constructs a new PatternComponent object which will search on the specified consumableFieldList for matches.

Parameters:
hostScreen -
Method Detail

getConsumableFieldList

public ConsumableFieldList getConsumableFieldList()
Returns the ConsumableFieldList for this pattern component. This object may have been updated by the recognize() methods.

Returns:
The ConsumableFieldList for this pattern component. This object may have been updated by the recognize() methods.

setConsumableFieldList

public void setConsumableFieldList(ConsumableFieldList list)
Sets the ConsumableFieldList for this pattern component. This list will be used to search for matching fields.

Parameters:
list -

newInstance

public static PatternComponent newInstance(String className,
                                           ClassLoader classLoader,
                                           HsrScreen hs,
                                           ConsumableFieldList fieldList)
Convenience method to construct a new pattern component with the specified class name.

Parameters:
className - Fully-qualified class name of the pattern component.
classLoader - Classloader to use (or null for default).
hs - Host screen to pass to the constructor of the pattern component.
fieldList - Consumable field list to pass to the constructor of the pattern component.
Returns:
The newly constructed pattern component.

HATS 7.5.1 (201005110649)