org.safs.autoit

Class AutoItRs.DefaultRecognizableAutoIt

java.lang.Object

org.safs.persist.PersistableDefault

org.safs.autoit.AutoItRs.DefaultRecognizable

org.safs.autoit.AutoItRs.DefaultRecognizableAutoIt

All Implemented Interfaces:

AutoItRs.Recognizable, Persistable, Printable

Direct Known Subclasses:

AutoItRs.Control, AutoItRs.Window

Enclosing class:

AutoItRs

protected static class AutoItRs.DefaultRecognizableAutoIt
extends AutoItRs.DefaultRecognizable

This class provides default implementation of interface AutoItRs.Recognizable for AUTOIT engine.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	rs_gen_class the field name is composed of Constants.AutoItConstants.PREFIX_PROPERTY_FOR_RS and Constants.AutoItConstants.RS_KEY_CLASS, the mapping rsKey is Constants.AutoItConstants.RS_KEY_CLASS
protected java.lang.String	rs_gen_h the field name is composed of Constants.AutoItConstants.PREFIX_PROPERTY_FOR_RS and Constants.AutoItConstants.RS_KEY_H, the mapping rsKey is Constants.AutoItConstants.RS_KEY_H
protected java.lang.String	rs_gen_instance the field name is composed of Constants.AutoItConstants.PREFIX_PROPERTY_FOR_RS and Constants.AutoItConstants.RS_KEY_INSTANCE, the mapping rsKey is Constants.AutoItConstants.RS_KEY_INSTANCE
protected java.lang.String	rs_gen_text the field name is composed of Constants.AutoItConstants.PREFIX_PROPERTY_FOR_RS and Constants.AutoItConstants.RS_KEY_TEXT, the mapping rsKey is Constants.AutoItConstants.RS_KEY_TEXT
protected java.lang.String	rs_gen_title the field name is composed of Constants.AutoItConstants.PREFIX_PROPERTY_FOR_RS and Constants.AutoItConstants.RS_KEY_TITLE, the mapping rsKey is Constants.AutoItConstants.RS_KEY_TITLE
protected java.lang.String	rs_gen_w the field name is composed of Constants.AutoItConstants.PREFIX_PROPERTY_FOR_RS and Constants.AutoItConstants.RS_KEY_W, the mapping rsKey is Constants.AutoItConstants.RS_KEY_W
protected java.lang.String	rs_gen_x the field name is composed of Constants.AutoItConstants.PREFIX_PROPERTY_FOR_RS and Constants.AutoItConstants.RS_KEY_X, the mapping rsKey is Constants.AutoItConstants.RS_KEY_X
protected java.lang.String	rs_gen_y the field name is composed of Constants.AutoItConstants.PREFIX_PROPERTY_FOR_RS and Constants.AutoItConstants.RS_KEY_Y, the mapping rsKey is Constants.AutoItConstants.RS_KEY_Y

Fields inherited from class org.safs.autoit.AutoItRs.DefaultRecognizable

engineRS, fieldNameToRsKeyMap, rawRS

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
DefaultRecognizableAutoIt(java.lang.String originalRS)

Method Summary

Modifier and Type	Method and Description
protected void	appendEngineRS(java.lang.StringBuilder rs, java.lang.String rsKey, java.lang.Object value) Append "rsKey:value;" to rs.
protected void	beforeParse() This implementation will: remove AutoItRs.AUTOIT_PREFIX from field AutoItRs.DefaultRecognizable.rawRS
java.lang.String	getEngineRS() This Recognition String is engine specific.
protected java.util.Set<java.lang.String>	getNonRecognizableFields() This implementation will consider all fields (of its own and super-class) not prefixing by Constants.AutoItConstants.PREFIX_PROPERTY_FOR_RS as non-recognizable fields.
protected java.util.Map<java.lang.String,java.lang.String>	getRecognizableFieldToRsKeyMap() Only those fields starting with Constants.AutoItConstants.PREFIX_PROPERTY_FOR_RS are considered as recognizable fields, so those fields not starting with that prefix will be removed from the map.
java.lang.String	getText()
protected void	parsing() This implementation will get pairs of (rsKey, value) from original RS, and set the value to the property of this class.
protected java.lang.String	rsKeyToProperty(java.lang.String rsKey) Convert the rsKey to the class real property name.
boolean	setField(java.lang.String rsKey, java.lang.Object value) Set the field's value of this Persistable object to the persist-key. The field name can be got from Persistable.getPersitableFields() according to the persist-key, then the value will be set to that field.
java.lang.String	setText(java.lang.String rs_gen_text)
java.lang.String	toString()

Methods inherited from class org.safs.autoit.AutoItRs.DefaultRecognizable

afterParse, getPersitableFields, getRawRS, getTopMostClassname, parseRawRS, setEngineRS, setRawRS

Methods inherited from class org.safs.persist.PersistableDefault

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

Methods inherited from class java.lang.Object

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

Field Detail

rs_gen_title

protected java.lang.String rs_gen_title

the field name is composed of Constants.AutoItConstants.PREFIX_PROPERTY_FOR_RS and Constants.AutoItConstants.RS_KEY_TITLE, the mapping rsKey is Constants.AutoItConstants.RS_KEY_TITLE

rs_gen_class

protected java.lang.String rs_gen_class

the field name is composed of Constants.AutoItConstants.PREFIX_PROPERTY_FOR_RS and Constants.AutoItConstants.RS_KEY_CLASS, the mapping rsKey is Constants.AutoItConstants.RS_KEY_CLASS

rs_gen_text

protected java.lang.String rs_gen_text

the field name is composed of Constants.AutoItConstants.PREFIX_PROPERTY_FOR_RS and Constants.AutoItConstants.RS_KEY_TEXT, the mapping rsKey is Constants.AutoItConstants.RS_KEY_TEXT

rs_gen_x

protected java.lang.String rs_gen_x

the field name is composed of Constants.AutoItConstants.PREFIX_PROPERTY_FOR_RS and Constants.AutoItConstants.RS_KEY_X, the mapping rsKey is Constants.AutoItConstants.RS_KEY_X

rs_gen_y

protected java.lang.String rs_gen_y

the field name is composed of Constants.AutoItConstants.PREFIX_PROPERTY_FOR_RS and Constants.AutoItConstants.RS_KEY_Y, the mapping rsKey is Constants.AutoItConstants.RS_KEY_Y

rs_gen_w

protected java.lang.String rs_gen_w

the field name is composed of Constants.AutoItConstants.PREFIX_PROPERTY_FOR_RS and Constants.AutoItConstants.RS_KEY_W, the mapping rsKey is Constants.AutoItConstants.RS_KEY_W

rs_gen_h

protected java.lang.String rs_gen_h

the field name is composed of Constants.AutoItConstants.PREFIX_PROPERTY_FOR_RS and Constants.AutoItConstants.RS_KEY_H, the mapping rsKey is Constants.AutoItConstants.RS_KEY_H

rs_gen_instance

protected java.lang.String rs_gen_instance

the field name is composed of Constants.AutoItConstants.PREFIX_PROPERTY_FOR_RS and Constants.AutoItConstants.RS_KEY_INSTANCE, the mapping rsKey is Constants.AutoItConstants.RS_KEY_INSTANCE

Constructor Detail

DefaultRecognizableAutoIt

public DefaultRecognizableAutoIt(java.lang.String originalRS)

Method Detail

beforeParse

protected void beforeParse()

This implementation will:

• remove AutoItRs.AUTOIT_PREFIX from field AutoItRs.DefaultRecognizable.rawRS

Overrides:

beforeParse in class AutoItRs.DefaultRecognizable

parsing

protected void parsing()

This implementation will get pairs of (rsKey, value) from original RS, and set the value to the property of this class.

Overrides:

parsing in class AutoItRs.DefaultRecognizable

setField

public boolean setField(java.lang.String rsKey,
                        java.lang.Object value)

Description copied from interface: Persistable

Set the field's value of this Persistable object to the persist-key.
The field name can be got from Persistable.getPersitableFields() according to the persist-key, then the value will be set to that field.

Specified by:

setField in interface Persistable

Overrides:

setField in class PersistableDefault

Parameters:

rsKey - String, the persist-key (it can be tag-name in XML, key-string in JSON etc.). refer to Persistable.getPersitableFields().

value - Object, the value to set

Returns:

boolean true if successful.

getNonRecognizableFields

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

This implementation will consider all fields (of its own and super-class) not prefixing by Constants.AutoItConstants.PREFIX_PROPERTY_FOR_RS as non-recognizable fields.

Overrides:

getNonRecognizableFields in class AutoItRs.DefaultRecognizable

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()

Only those fields starting with Constants.AutoItConstants.PREFIX_PROPERTY_FOR_RS are considered as recognizable fields, so those fields not starting with that prefix will be removed from the map.

Overrides:

getRecognizableFieldToRsKeyMap in class AutoItRs.DefaultRecognizable

Returns:

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

rsKeyToProperty

protected java.lang.String rsKeyToProperty(java.lang.String rsKey)

Convert the rsKey to the class real property name.

Parameters:

rsKey - String, the key name in original RS, such as 'title', 'Title', 'TITLE'.

Returns:

String, the class real property name.

appendEngineRS

protected void appendEngineRS(java.lang.StringBuilder rs,
                              java.lang.String rsKey,
                              java.lang.Object value)

Append "rsKey:value;" to rs.

Parameters:

rs - StringBuilder

rsKey - String

value - Object

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

Overrides:

getEngineRS in class AutoItRs.DefaultRecognizable

getText

public java.lang.String getText()

setText

public java.lang.String setText(java.lang.String rs_gen_text)

toString

public java.lang.String toString()

Overrides:

toString in class PersistableDefault