com.microblink.blinkinput.entities.parsers.raw

Class RawParser

java.lang.Object

com.microblink.blinkinput.entities.Entity

com.microblink.blinkinput.entities.parsers.Parser

com.microblink.blinkinput.entities.parsers.raw.RawParser

All Implemented Interfaces:

android.os.Parcelable

public final class RawParser
extends Parser

A parser that simply returns the string version of raw OCR result, without performing any smart parsing operations.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RawParser.Result

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator, android.os.Parcelable.Creator

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator	CREATOR

Fields inherited from class com.microblink.blinkinput.entities.parsers.Parser

CLASS_NAME

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
RawParser()

Method Summary

Modifier and Type	Method and Description
void	clearResult() Clears parser result.
RawParser	clone() Create a copy of the entity.
void	consumeResult(RawParser.Result resultToConsume) Consumes given result.
void	consumeResultFrom(Entity other) Consume result from other entity.
protected void	deserializeNativeSettings(byte[] serializedSettings)
AbstractOCREngineOptions	getOcrEngineOptions() Returns the OCR engine options used in Regex OCR parser.
protected byte[]	serializeNativeSettings()
void	setOcrEngineOptions(AbstractOCREngineOptions ocrEngineOptions) Sets the OCR engine options used in Regex OCR parser.
void	setUseSieve(boolean useSieve) Enable the usage of algorithm for combining consecutive OCR results between video frames for improving OCR quality.
boolean	shouldUseSieve() Returns true if algorithm for combining consecutive OCR results between video frames for improving OCR quality is used.
protected void	terminateNative(long nativeContext)

Methods inherited from class com.microblink.blinkinput.entities.parsers.Parser

getPriority, isRequired, setRequired

Methods inherited from class com.microblink.blinkinput.entities.Entity

describeContents, finalize, getNativeContext, getResult, nativeGetNativeResultContext, readFromParcel, writeToParcel

Methods inherited from class java.lang.Object

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

Field Detail

CREATOR

public static final android.os.Parcelable.Creator CREATOR

Constructor Detail

RawParser

public RawParser()

Method Detail

setOcrEngineOptions

public void setOcrEngineOptions(@NonNull
                                AbstractOCREngineOptions ocrEngineOptions)

Sets the OCR engine options used in Regex OCR parser. By default, this is set to 'default instance of BlinkOCREngineOptions'.

Parameters:

ocrEngineOptions - OCR engine options used in Regex OCR parser

getOcrEngineOptions

@NonNull
public AbstractOCREngineOptions getOcrEngineOptions()

Returns the OCR engine options used in Regex OCR parser. By default, this is set to 'default instance of BlinkOCREngineOptions'.

Returns:

OCR engine options used in Regex OCR parser

setUseSieve

public void setUseSieve(boolean useSieve)

Enable the usage of algorithm for combining consecutive OCR results between video frames for improving OCR quality. By default, this is set to 'false'. Note: This option works together only with if instance of BlinkOCREngineOptions is given to RawParser.setOcrEngineOptions(com.microblink.blinkinput.entities.ocrengine.AbstractOCREngineOptions). Otherwise, it will not be enabled and IllegalArgumentException will be thrown.

Parameters:

useSieve - whether or not sieve algorithm should be used

shouldUseSieve

public boolean shouldUseSieve()

Returns true if algorithm for combining consecutive OCR results between video frames for improving OCR quality is used. By default, this is set to 'false'

Returns:

true if sieve algorithm is used

terminateNative

protected void terminateNative(long nativeContext)

Specified by:

terminateNative in class Entity

serializeNativeSettings

@Nullable
protected byte[] serializeNativeSettings()

Specified by:

serializeNativeSettings in class Entity

deserializeNativeSettings

protected void deserializeNativeSettings(@NonNull
                                         byte[] serializedSettings)

Specified by:

deserializeNativeSettings in class Entity

clone

public RawParser clone()

Description copied from class: Entity

Create a copy of the entity. This is required if properties of the entity must be modified while background thread performs processing. In order to avoid race conditions, changing properties is not allowed while entity is used in background processing. However, you are able to make a copy of the entity, change properties of it and then update the RecognizerRunnerView or RecognizerRunner with the updated entity hierarchy.

Specified by:

clone in class Entity

Returns:

a copy of the entity

consumeResultFrom

public void consumeResultFrom(@NonNull
                              Entity other)

Description copied from class: Entity

Consume result from other entity. The result from other will be put instead current result of this entity. This method is used inside com.microblink.blinkinput.entities.recognizers.RecognizerBundle#loadFromIntent(Intent) and similar methods to replace the result content of the saved entities with results that have arrived over Intent

Specified by:

consumeResultFrom in class Entity

Parameters:

other - Entity from which result should be consumed.

consumeResult

public void consumeResult(@NonNull
                          RawParser.Result resultToConsume)

Description copied from class: Parser

Consumes given result. The given result will be put instead current result of this entity.

Specified by:

consumeResult in class Parser

Parameters:

resultToConsume - Result that should be consumed.

clearResult

public void clearResult()

Description copied from class: Parser

Clears parser result.

Specified by:

clearResult in class Parser