eu.id3.document

Class MrzReadingResult

java.lang.Object

eu.id3.document.MrzReadingResult

All Implemented Interfaces:

java.io.Serializable, java.lang.AutoCloseable

public class MrzReadingResult
extends java.lang.Object
implements java.lang.AutoCloseable, java.io.Serializable

Represents the result of MRZ reading.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MrzReadingResult() Creates a new instance of the MrzReadingResult class.
MrzReadingResult(long handle) Creates a new instance of the MrzReadingResult class.

Method Summary

Modifier and Type	Method and Description
MrzReadingResult	clone() Creates a copy of the MrzReadingResult object.
void	close() Releases all resources used by this MrzReadingResult.
protected void	finalize() Finalizer for this class.
PointList	getBounds() Gets the boundaries of the MRZ detected, in following order: top-left, top-right, bottom-right, bottom-left.
float	getConfidence() Gets the confidence score for the MRZ detected.
long	getHandle() Gets the native handle.
java.lang.String	getMrz() Gets the value of the MRZ detected.
MrzType	getMrzType() Gets the type of the MRZ detected.

Methods inherited from class java.lang.Object

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

Constructor Detail

MrzReadingResult

public MrzReadingResult()
                 throws DocumentException

Creates a new instance of the MrzReadingResult class.

Throws:

DocumentException - An error has occurred during Document Library execution.

MrzReadingResult

public MrzReadingResult(long handle)
                 throws DocumentException

Creates a new instance of the MrzReadingResult class.

Parameters:

handle - Handle to the MrzReadingResult.

Throws:

DocumentException - An error has occurred during Document Library execution.

Method Detail

close

public void close()

Releases all resources used by this MrzReadingResult.

Specified by:

close in interface java.lang.AutoCloseable

finalize

protected void finalize()

Finalizer for this class. Finalizers are deprecated since Java 9+. This method is not guaranteed to be called. To release all memory held by this class please be sure to call the close() method.

Overrides:

finalize in class java.lang.Object

getHandle

public long getHandle()

Gets the native handle.

Returns:

The native handle.

clone

public MrzReadingResult clone()
                       throws DocumentException

Creates a copy of the MrzReadingResult object.

Overrides:

clone in class java.lang.Object

Returns:

The newly created MrzReadingResult object.

Throws:

DocumentException - An error has occurred during Document Library execution.

getBounds

public PointList getBounds()
                    throws DocumentException

Gets the boundaries of the MRZ detected, in following order: top-left, top-right, bottom-right, bottom-left.

Returns:

Boundaries of the MRZ detected, in following order: top-left, top-right, bottom-right, bottom-left.

Throws:

DocumentException - An error has occurred during Document Library execution.

getConfidence

public float getConfidence()
                    throws DocumentException

Gets the confidence score for the MRZ detected.

Returns:

Confidence score for the MRZ detected.

Throws:

DocumentException - An error has occurred during Document Library execution.

getMrz

public java.lang.String getMrz()
                        throws DocumentException

Gets the value of the MRZ detected.

Returns:

Value of the MRZ detected.

Throws:

DocumentException - An error has occurred during Document Library execution.

getMrzType

public MrzType getMrzType()
                   throws DocumentException

Gets the type of the MRZ detected.

Returns:

Type of the MRZ detected.

Throws:

DocumentException - An error has occurred during Document Library execution.