com.auxiliary.sikuli.event

Class SikuliOcrEvent

java.lang.Object

com.auxiliary.sikuli.event.SikuliAbstractEvent

com.auxiliary.sikuli.event.SikuliOcrEvent

public class SikuliOcrEvent
extends SikuliAbstractEvent

文件名：SikuliOcrEvent.java

用途： 封装sikuli工具的OCR事件，可设置FindSikuliElement类对象，用以元素名称来进行操作

注意：通过元素名称对元素进行查找的方式不支持外链词语

编码时间：2022年2月16日 下午5:54:31

修改时间：2022年2月16日 下午5:54:31

Since:

JDK 1.8, autest 3.1.0

Version:

Ver1.0

Author:

彭宇琦

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_LANGUAGE_NAME 默认语言包路径下的语言包名称
static String	LANGUAGE_FILE_SUFFIX 语言包文件的后缀名称

Fields inherited from class com.auxiliary.sikuli.event.SikuliAbstractEvent

DEFAULT_REGION, find, log, operateTime

Constructor Summary

Constructors

Constructor and Description
SikuliOcrEvent() 构造对象

Method Summary

Modifier and Type	Method and Description
String	readText(SikuliElement element) 该方法用于识别指定元素中的文本内容
String	readText(String elementName) 该方法用于根据元素信息，通过指定的元素查找类，查找到目标元素后，识别目标元素中的文本内容
String	readText(String elementName, int index) 该方法用于根据元素信息，通过指定的元素查找类，查找到目标元素后，识别目标元素中的文本内容
void	setDataPath(File dataPathFolder) 该方法用于设置OCR语言包的文件所在路径
void	setDefaultLanguage(String languageName) 该方法用于设置语言包的名称

Methods inherited from class com.auxiliary.sikuli.event.SikuliAbstractEvent

actionOperate, recordLog, setFindElementTool, setLogRecordTool, setOperateTime

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LANGUAGE_NAME

public static final String DEFAULT_LANGUAGE_NAME

默认语言包路径下的语言包名称

See Also:

Constant Field Values

LANGUAGE_FILE_SUFFIX

public static final String LANGUAGE_FILE_SUFFIX

语言包文件的后缀名称

See Also:

Constant Field Values

Constructor Detail

SikuliOcrEvent

public SikuliOcrEvent()

构造对象

Since:

autest 3.1.0

Method Detail

setDefaultLanguage

public void setDefaultLanguage(String languageName)

该方法用于设置语言包的名称

语言包名称一般为traineddata文件后缀前的内容，如中文语言包的文件名称为“chi_sim.traineddata”，则传入的语言包名称为“chi_sim”。

Parameters:

languageName - 语言包名称

Throws:

IncorrectFileException - 当语言包名称为空或指向的语言包文件不存在时，抛出的异常

Since:

autest 3.1.0

setDataPath

public void setDataPath(File dataPathFolder)

该方法用于设置OCR语言包的文件所在路径

Parameters:

dataPathFolder - 语言包文件所在路径

Throws:

IncorrectFileException - 当文件对象为null或不存在时抛出的异常

Since:

autest 3.1.0

readText

public String readText(SikuliElement element)

该方法用于识别指定元素中的文本内容

注意：该工具调用Tess4J的OCR工具包，其英文与数字的识别率较高，而对于中文，其识别率较低，且每个中文间均用空格分开，需要自行处理

Parameters:

element - 元素类对象

Returns:

元素中的文本内容

Throws:

OperateTimeoutException - 操作超时时，抛出的异常

Since:

autest 3.1.0

readText

public String readText(String elementName,
                       int index)

该方法用于根据元素信息，通过指定的元素查找类，查找到目标元素后，识别目标元素中的文本内容

Parameters:

elementName - 元素名称

index - 多元素时的下标，允许传入负数，参考FindSikuliElement.findElement(String, int, String...)方法

Returns:

元素中的文本内容

Throws:

ElementOperateException - 未指定元素查找类时，抛出的异常

TimeoutException - 元素查找超时时，抛出的异常

OperateTimeoutException - 操作超时时，抛出的异常

Since:

autest 3.1.0

readText

public String readText(String elementName)

该方法用于根据元素信息，通过指定的元素查找类，查找到目标元素后，识别目标元素中的文本内容

Parameters:

elementName - 元素名称

Returns:

元素中的文本内容

Throws:

ElementOperateException - 未指定元素查找类时，抛出的异常

TimeoutException - 元素查找超时时，抛出的异常

OperateTimeoutException - 操作超时时，抛出的异常

Since:

autest 3.1.0