com.microblink.blinkinput.entities.parsers.topup

Class TopUpParser

java.lang.Object

com.microblink.blinkinput.entities.Entity

com.microblink.blinkinput.entities.parsers.Parser

com.microblink.blinkinput.entities.parsers.topup.TopUpParser

All Implemented Interfaces:

android.os.Parcelable

public final class TopUpParser
extends Parser

A parser that can extract TopUp (mobile phone coupon) codes from OCR result.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TopUpParser.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
TopUpParser()

Method Summary

Modifier and Type	Method and Description
void	clearResult() Clears parser result.
TopUpParser	clone() Create a copy of the entity.
void	consumeResult(TopUpParser.Result resultToConsume) Consumes given result.
void	consumeResultFrom(Entity other) Consume result from other entity.
protected void	deserializeNativeSettings(byte[] serializedSettings)
protected byte[]	serializeNativeSettings()
void	setAllowNoPrefix(boolean allowNoPrefix) Indicates whether USSD codes without prefix are allowed.
void	setPrefixAndUssdCodeLength(java.lang.String prefix, int ussdCodeLength) Sets the given top up prefix and USSD code length.
void	setReturnCodeWithoutPrefix(boolean returnCodeWithoutPrefix) Indicates whether *digits* prefix and # at the end of scanned USSD code will be returned.
void	setTopUpPreset(TopUpPreset preset) Sets the top up prefix and USSD code length based on the given TopUpPreset.
boolean	shouldAllowNoPrefix() Indicates whether USSD codes without prefix are allowed.
boolean	shouldReturnCodeWithoutPrefix() Indicates whether *digits* prefix and # at the end of scanned USSD code will be returned.
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

TopUpParser

public TopUpParser()

Method Detail

setReturnCodeWithoutPrefix

public void setReturnCodeWithoutPrefix(boolean returnCodeWithoutPrefix)

Indicates whether *digits* prefix and # at the end of scanned USSD code will be returned. By default, this is set to 'false'

shouldReturnCodeWithoutPrefix

public boolean shouldReturnCodeWithoutPrefix()

Indicates whether *digits* prefix and # at the end of scanned USSD code will be returned. By default, this is set to 'false'

setAllowNoPrefix

public void setAllowNoPrefix(boolean allowNoPrefix)

Indicates whether USSD codes without prefix are allowed. By default, this is set to 'false'

shouldAllowNoPrefix

public boolean shouldAllowNoPrefix()

Indicates whether USSD codes without prefix are allowed. By default, this is set to 'false'

setTopUpPreset

public void setTopUpPreset(@NonNull
                           TopUpPreset preset)

Sets the top up prefix and USSD code length based on the given TopUpPreset. Only top ups with the chosen prefix and USSD code length in form *<prefixString>*<USSDCodeLength digits># will be parsed. If top up prefix and USSD code length is not set, top ups with any prefix and USSD code length can be parsed.

Parameters:

preset - preset that determines top up prefix and USSD code length that will be set.

setPrefixAndUssdCodeLength

public void setPrefixAndUssdCodeLength(@NonNull
                                       java.lang.String prefix,
                                       int ussdCodeLength)

Sets the given top up prefix and USSD code length. Only top ups with the chosen prefix and USSD code length in form *<prefixString>*<USSDCodeLength digits># will be parsed. If top up prefix and USSD code length is not set, top ups with any prefix and USSD code length can be parsed.

Parameters:

prefix - top up prefix

ussdCodeLength - length of the USSD code

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 TopUpParser 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
                          TopUpParser.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