|
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.common.customlogic.HatsHpCustomListener
public class HatsHpCustomListener
Class Name: HatsHpCustomListener This class supports custom logic as working in the HostPublisher release to work within HATS.
Class Type: Normal
Base Class: None
Intf Class: ECLCustomRecoListener, MacroCustomActionListener
Description:
Format for ScreenToValue Parms are:
HPubRegionToVal | COMPARISONOPERATOR | COMPARISONDATATYPE |TOP | LEFT | BOTTOM | RIGHT | COMPARISONTEXT
COMPARISONOPERATOR = { <, <=, =, >, >= }
COMPARISONTYPE = {TEXT, TEXTIGNORECASE, NUMERIC, }
Separator is | (shift \ on keypad), and there is no final termination character
Example:
HPubRegionToVal | <= | NUMERIC | 10 | 10 | 20 | 22 | 150
HPubRegionToVal | = | TEXT | 5 | 5 | 5 | 10 | RALVMS
Format for ScreentoScreeenParms:
HPubRegionToRegion | COMPARISONOPERATOR | COMPARISONDATATYPE | TOP | LEFT | BOTTOM | RIGHT | TOP2 | LEFT2 | BOTTOM2 | RIGHT2 |
Note: other customreco ids may not have all these separators, but should have at least 1 - i.e, <customreco id="HPubExtractFieldAttributes|" optional="false" invertmatch="false" />
ECLCustomRecoListener,
MacroCustomActionListener,
Serialized Form| Field Summary | |
|---|---|
boolean |
debugON
Boolean for whether in debug mode or not. |
static String |
FIXEDLOOP_CUSTOM_ID
String constant for custom ID for fixed iteration looping. |
static String |
FIXEDLOOP_INCREMENT_ID
String constant for ID for fixed iteration loop incrementing. |
static String |
HPUBREGIONTOREGION_CUSTOM_ID
String constant for custom ID for region to region. |
static String |
HPUBREGIONTOVAL_CUSTOM_ID
String constant for custom ID for region to value. |
| Constructor Summary | |
|---|---|
HatsHpCustomListener()
|
|
| Method Summary | |
|---|---|
static String |
convertDBCStoSBCS(String text,
String codePageString,
boolean unicodeField,
boolean bUseAccentedCharacters)
A method used to convert a DBCS string to its SBCS equivalent by removing the doubled-up DBCS characters. |
boolean |
DoReco(ECLCustomRecoEvent e)
This is the code that handles the fixed iteration looping and the advanced recognition that existed in Host Publisher. |
void |
execute(MacroCustomActionEvent mcaEv)
We need this for fixed iteration looping - a custom action is used to increment the loop. |
int |
getLoopIterationCount()
Loop iteration count, tracked iteration count via the Custom Action. |
void |
halt(MacroCustomActionEvent e)
Halt. |
int |
incrementLoopIterationCount()
Increments loop iteration count. |
boolean |
isBIDIReverse()
This fuction is used to check if the orientation of the terminal is different than the orientation of the screen captured, if so it will reverse the descriptior for the screen captured to match those coming from the host. |
static String |
massageString(String text)
Adjusts strings before comparisons to account for DBCS spaces and SO/SI characters. |
void |
setBIDIReverse(boolean flag)
Sets the BIDI reverse. |
static boolean |
stringIsHPubCustomID(String id)
Evaluates whether or not the given string is a known entity by this code. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final String HPUBREGIONTOVAL_CUSTOM_ID
public static final String HPUBREGIONTOREGION_CUSTOM_ID
public static final String FIXEDLOOP_CUSTOM_ID
public static final String FIXEDLOOP_INCREMENT_ID
public boolean debugON
| Constructor Detail |
|---|
public HatsHpCustomListener()
| Method Detail |
|---|
public static boolean stringIsHPubCustomID(String id)
id - The ID from the tag.
public int getLoopIterationCount()
public int incrementLoopIterationCount()
public void execute(MacroCustomActionEvent mcaEv)
execute in interface MacroCustomActionListenermcaEv - The MacroCustonActionEvent object.MacroCustomActionListener.execute(MacroCustomActionEvent)public void halt(MacroCustomActionEvent e)
halt in interface MacroCustomActionListenere - The MacroCustomActionEvent object.MacroCustomActionListener.halt(MacroCustomActionEvent)public boolean DoReco(ECLCustomRecoEvent e)
DoReco in interface ECLCustomRecoListenere - The ECLCustomRecoEvent object.ECLCustomRecoListener.DoReco( ECLCustomRecoEvent )
public static String convertDBCStoSBCS(String text,
String codePageString,
boolean unicodeField,
boolean bUseAccentedCharacters)
EXAMPLE: Input: "abc(SO)##$$%%(SI)abc..." (here '#' '$' and '%' represent DBCS chars) Output: "abc(SO)#$%(SI)abc..."The "(SO)" symbol represents the transition from SBCS to DBCS, and the "(SI)" symbol represents the transition from DBCS to SBCS.
text - The DBCS String to convert to SBCS.codePageString - The String that represents EBCDIC code page.unicodeField - The Boolean for Unicode Field.bUseAccentedCharacters - The Boolean that represents the switch for accented character support.
public static String massageString(String text)
text - The text to readjust.
public boolean isBIDIReverse()
public void setBIDIReverse(boolean flag)
flag - Boolean flag setting BIDI reverse.
|
HATS 7.5.1 (201005110649) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||