org.safs.autoit

Class AutoItRs.DefaultRecognizable

java.lang.Object

org.safs.persist.PersistableDefault

org.safs.autoit.AutoItRs.DefaultRecognizable

All Implemented Interfaces:

AutoItRs.Recognizable, Persistable, Printable

Direct Known Subclasses:

AutoItRs.DefaultRecognizableAutoIt

Enclosing class:

AutoItRs

protected static class AutoItRs.DefaultRecognizable
extends PersistableDefault
implements AutoItRs.Recognizable

This class provides default implementation of interface AutoItRs.Recognizable.
As the field of name starting with Constants.AutoItConstants.PREFIX_PROPERTY_FOR_RS will be used for generating recognition string, please avoid adding new fields of name starting with Constants.AutoItConstants.PREFIX_PROPERTY_FOR_RS to this class when refactoring this class.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	engineRS The recognition string in Native Mode, recognized directly by underlying automation tool.
protected java.util.Map<java.lang.String,java.lang.String>	fieldNameToRsKeyMap a cache holding the Map of (fieldName, rsKey)
protected java.lang.String	rawRS The recognition string provided by user.

Fields inherited from class org.safs.persist.PersistableDefault

enabled, FAILED_RETRIEVE_VALUE, fieldNameToPersistKeyMap, parent, persistKeyToFieldValueMap, tabulation, threshold, thresholdEnabled, UNKNOWN_VALUE

Fields inherited from interface org.safs.persist.Persistable

CONTAINER_ELEMENT

Fields inherited from interface org.safs.Printable

DATA_BIGGER_THAN_THRESHOLD

Constructor Summary

Constructors

Constructor and Description
DefaultRecognizable(java.lang.String rawRS)

Method Summary

Modifier and Type	Method and Description
protected void	afterParse() Do some thing after parsing the raw recognition string.
protected void	beforeParse() Do some thing before parsing the raw recognition string. For example, remove some prefix/suffix or remove leading/ending spaces etc.
java.lang.String	getEngineRS() This Recognition String is engine specific.
protected java.util.Set<java.lang.String>	getNonRecognizableFields()
java.util.Map<java.lang.String,java.lang.String>	getPersitableFields() This default implementation get all the declared fields Class.getDeclaredFields() of this class and its super-classes (NOT super than the class AutoItRs.DefaultRecognizable ), then put the pair ('fieldName', 'fieldName') into the Persistable Map.
java.lang.String	getRawRS() This raw Recognition String is provided by user, it can be in SAFS format, engine format, or any other format which will be parsed into engine RS.
protected java.util.Map<java.lang.String,java.lang.String>	getRecognizableFieldToRsKeyMap()
protected java.lang.String	getTopMostClassname()
void	parseRawRS() This method should parse the raw RS
protected void	parsing() Parse the raw recognition string so that the engine RS will be produced.
void	setEngineRS(java.lang.String engineRS)
void	setRawRS(java.lang.String rawRS)

Methods inherited from class org.safs.persist.PersistableDefault

equals, getContents, getContents, getField, getFlatKey, getParent, getTabulation, getTagName, getThreshold, ignoreFieldForPersist, isEnabled, isIgnoredContentCache, isThresholdEnabled, setEnabled, setField, setIgnoredContentCache, setParent, setTabulation, setThreshold, setThresholdEnabled, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

rawRS

protected java.lang.String rawRS

The recognition string provided by user.

engineRS

protected java.lang.String engineRS

The recognition string in Native Mode, recognized directly by underlying automation tool.

fieldNameToRsKeyMap

protected java.util.Map<java.lang.String,java.lang.String> fieldNameToRsKeyMap

a cache holding the Map of (fieldName, rsKey)

Constructor Detail

DefaultRecognizable

public DefaultRecognizable(java.lang.String rawRS)

Method Detail

getRawRS

public java.lang.String getRawRS()

Description copied from interface: AutoItRs.Recognizable

This raw Recognition String is provided by user, it can be in SAFS format, engine format, or any other format which will be parsed into engine RS.

Specified by:

getRawRS in interface AutoItRs.Recognizable

setRawRS

public void setRawRS(java.lang.String rawRS)

getEngineRS

public java.lang.String getEngineRS()

Description copied from interface: AutoItRs.Recognizable

This Recognition String is engine specific.

Specified by:

getEngineRS in interface AutoItRs.Recognizable

setEngineRS

public void setEngineRS(java.lang.String engineRS)

parseRawRS

public void parseRawRS()

Description copied from interface: AutoItRs.Recognizable

This method should parse the raw RS

Specified by:

parseRawRS in interface AutoItRs.Recognizable

beforeParse

protected void beforeParse()

Do some thing before parsing the raw recognition string.
For example, remove some prefix/suffix or remove leading/ending spaces etc.

parsing

protected void parsing()

Parse the raw recognition string so that the engine RS will be produced.

afterParse

protected void afterParse()

Do some thing after parsing the raw recognition string.

getPersitableFields

public java.util.Map<java.lang.String,java.lang.String> getPersitableFields()

This default implementation get all the declared fields Class.getDeclaredFields() of this class and its super-classes (NOT super than the class AutoItRs.DefaultRecognizable ), then put the pair ('fieldName', 'fieldName') into the Persistable Map.

Specified by:

getPersitableFields in interface Persistable

Overrides:

getPersitableFields in class PersistableDefault

Returns:

Map, a Map containing a pair(fieldName, persistKey) to persist.

See Also:

PersistableDefault.ignoreFieldForPersist(Field)

getTopMostClassname

protected java.lang.String getTopMostClassname()

Returns:

String, the name of the class representing the top most class to check recursively.

See Also:

getPersitableFields(), getNonRecognizableFields()

getNonRecognizableFields

protected java.util.Set<java.lang.String> getNonRecognizableFields()

Returns:

Set, a set containing the fields NOT for generating the "engine RS".

getRecognizableFieldToRsKeyMap

protected java.util.Map<java.lang.String,java.lang.String> getRecognizableFieldToRsKeyMap()

Returns:

Map, a map containing the pairs of (field, RsKey) for generating the "engine RS".