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
Class ConsumableFieldList

java.lang.Object
  extended by com.ibm.hats.transform.ConsumableFieldList

public class ConsumableFieldList
extends Object

The ConsumableFieldList class represents a list of HsrScreenField objects. Each field can be marked as consumed or not consumed.

This class is exclusively used by the Pattern components as a way to mark fields that have been consumed by a higher priority global rule.

See Also:
PatternComponent

Constructor Summary
ConsumableFieldList(HsrScreen hostScreen, boolean includeInputFields, boolean includeProtectedFields)
          Constructs a new ConsumableFieldList object.
 
Method Summary
 int getConsumedCount()
          Returns the number of fields that have been consumed.
 HsrScreenField getField(int index)
          Returns the HsrScreenField at the specified (0-based) index.
 int getFieldIndex(HsrScreenField field)
          Returns the 0-based index of the specified field.
 boolean isFieldConsumed(int index)
          Returns true if the field has been consumed.
 void setIsFieldConsumed(int index, boolean b)
          Sets whether a field has been consumed.
 int size()
          Returns the number of fields in the list.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ConsumableFieldList

public ConsumableFieldList(HsrScreen hostScreen,
                           boolean includeInputFields,
                           boolean includeProtectedFields)
Constructs a new ConsumableFieldList object.

Parameters:
hostScreen - The host screen used to build the list of fields.
includeInputFields - Flag to indicate whether or not to include input (non-protected) fields in the list.
includeProtectedFields - Flag to indicate whether or not to include protected fields in the list
Method Detail

getField

public HsrScreenField getField(int index)
Returns the HsrScreenField at the specified (0-based) index.

Parameters:
index - 0-based index of the field to get
Returns:
a HsrScreenField object or null if the index did not exist in the list

getFieldIndex

public int getFieldIndex(HsrScreenField field)
Returns the 0-based index of the specified field.

Parameters:
field - host screen field to retrieve the 0-based index of
Returns:
The 0-based index of the specified field.

isFieldConsumed

public boolean isFieldConsumed(int index)
Returns true if the field has been consumed.

Parameters:
index -
Returns:
Returns true if the field has been consumed, false otherwise.

setIsFieldConsumed

public void setIsFieldConsumed(int index,
                               boolean b)
Sets whether a field has been consumed.

Parameters:
index - 0-based index of the field
b - value of consumed

size

public int size()
         throws NullPointerException
Returns the number of fields in the list.

Returns:
The number of fields in the list.
Throws:
NullPointerException

getConsumedCount

public int getConsumedCount()
Returns the number of fields that have been consumed.

Returns:
number of consumed fields

HATS 7.5.1 (201005110649)