com.microblink.blinkinput.entities.parsers

Class Parser

java.lang.Object

com.microblink.blinkinput.entities.Entity

com.microblink.blinkinput.entities.parsers.Parser

All Implemented Interfaces:

android.os.Parcelable

Direct Known Subclasses:

AmountParser, DateParser, EmailParser, IbanParser, LicensePlatesParser, RawParser, RegexParser, TopUpParser, VinParser

public abstract class Parser
extends Entity

Base class for all parsers which are used for data extraction.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Parser.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 java.lang.String	CLASS_NAME

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Parser(long nativeRecognizer, Parser.Result concreteResult)
protected	Parser(long nativeRecognizer, Parser.Result concreteResult, android.os.Parcel in)

Method Summary

Modifier and Type	Method and Description
abstract void	clearResult() Clears parser result.
abstract void	consumeResult(Parser.Result resultToConsume) Consumes given result.
int	getPriority()
boolean	isRequired() Returns whether parser configured with this parser settings object will be required
void	setRequired(boolean required) Defines whether the parser configured with this parser settings object will be required or optional.

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

clone, consumeResultFrom, describeContents, deserializeNativeSettings, finalize, getNativeContext, getResult, nativeGetNativeResultContext, readFromParcel, serializeNativeSettings, terminateNative, writeToParcel

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_NAME

@NonNull
public static final java.lang.String CLASS_NAME

See Also:

Constant Field Values

Constructor Detail

Parser

protected Parser(long nativeRecognizer,
                 @NonNull
                 Parser.Result concreteResult)

Parser

protected Parser(long nativeRecognizer,
                 @NonNull
                 Parser.Result concreteResult,
                 @NonNull
                 android.os.Parcel in)

Method Detail

setRequired

public void setRequired(boolean required)

Defines whether the parser configured with this parser settings object will be required or optional. Data will not be returned via ScanResultListener.onScanningDone(RecognitionSuccessType) until all parsers that are required have produced result. By default, every parser is required. Set this to false in cases when you will manually manage which parser has produced result, and which did not (for example in random scan use case).

Parameters:

required - whether this parser is required or not

isRequired

public boolean isRequired()

Returns whether parser configured with this parser settings object will be required

Returns:

whether parser configured with this parser settings object will be required

getPriority

public int getPriority()

consumeResult

public abstract void consumeResult(@NonNull
                                   Parser.Result resultToConsume)

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

Parameters:

resultToConsume - Result that should be consumed.

clearResult

public abstract void clearResult()

Clears parser result.