SignDoc SDK (Java)  5.0.0
SignDocMatchResult Class Reference

Result of SignDocSignatureData.matchSignature(), SignDocSignatureData.matchReference(), SignDocImage.matchSignature(), and SignDocImage.matchReference(). More...

Inheritance diagram for SignDocMatchResult:

Public Member Functions

 SignDocMatchResult ()
 Constructor. More...
 
synchronized SignDocMatchResult clone () throws SignDocException
 Clone this object. More...
 
synchronized int getNumberOfStaticResults () throws SignDocException
 Get the number of results for the static matching engine. More...
 
synchronized boolean getResult () throws SignDocException
 Get the overall match result. More...
 
synchronized boolean getDynamicResult () throws SignDocException
 Get the dynamic match result. More...
 
synchronized boolean getStaticResult (int aIndex) throws SignDocException
 Get a static match result. More...
 
synchronized boolean getDStatResult () throws SignDocException
 Get the match result for the DStat matching engine. More...
 
synchronized int getDynamicMatchQuality () throws SignDocException
 Get the dynamic match quality. More...
 
synchronized int getStaticMatchQuality (int aIndex) throws SignDocException
 Get the static match quality. More...
 
synchronized int getDStatMatchQuality () throws SignDocException
 Get the match quality for the DStat matching engine. More...
 
synchronized void close ()
 Destroy the underlying native object (for java.lang.AutoCloseable). More...
 

Protected Member Functions

void finalize () throws Throwable
 Finalize this object. More...
 

Detailed Description

Constructor & Destructor Documentation

Constructor.

No results will be set.

Member Function Documentation

synchronized SignDocMatchResult clone ( ) throws SignDocException

Clone this object.

Returns
A clone of this object.
synchronized void close ( )

Destroy the underlying native object (for java.lang.AutoCloseable).

After calling this method, all methods but close() will throw SignDocUnexpectedErrorException.

void finalize ( ) throws Throwable
protected

Finalize this object.

Do not call this method unless you know what you are doing.

synchronized int getDStatMatchQuality ( ) throws SignDocException

Get the match quality for the DStat matching engine.

Returns
The match quality (0 through 100) computed by the DStat matching engine or a negative value if the DStat match quality has not been computed.
See also
getDStatMatchResult(), getDynamicMatchQuality(), getStaticicMatchQuality()
synchronized boolean getDStatResult ( ) throws SignDocException

Get the match result for the DStat matching engine.

Returns
true for a match reported by the DStat matching engine, false for a non-match reported by the DStat matching engine or on error.
See also
getDStatMatchQuality(), getDynamicResult(), getStaticResult()
synchronized int getDynamicMatchQuality ( ) throws SignDocException

Get the dynamic match quality.

Returns
The match quality (0 through 100) computed by the dynamic matching engine or a negative value if the dynamic match quality has not been computed.
See also
getDStatMatchQuality(), getDynamicResult(), getStaticMatchQuality()
synchronized boolean getDynamicResult ( ) throws SignDocException

Get the dynamic match result.

Returns
true for a match reported by the dynamic matching engine, false otherwise.
See also
getDynamicMatchQuality(), getResult()
synchronized int getNumberOfStaticResults ( ) throws SignDocException

Get the number of results for the static matching engine.

References contain more than one signature, therefore there are multiple results for the static matching engine, one per signature in the reference.

Returns
The number of results.
See also
getStaticMatchQuality(), getStaticResult()
synchronized boolean getResult ( ) throws SignDocException

Get the overall match result.

Returns
true if all signatures match for all enabled matching engines, false otherwise.
See also
getDStatResult(), getDynamicResult(), getStaticResult()
synchronized int getStaticMatchQuality ( int  aIndex) throws SignDocException

Get the static match quality.

References contain more than one signature, therefore there are multiple results for the static matching engine, one per signature in the reference.

Parameters
[in]aIndex0-based index of the match result.
Returns
The match quality (0 through 100) computed by the static matching engine or a negative value if the static match quality has not been computed.
See also
getDStatMatchQuality(), getDynamicMatchQuality(), getStaticResult(), getNumberOfStaticResults()
synchronized boolean getStaticResult ( int  aIndex) throws SignDocException

Get a static match result.

References contain more than one signature, therefore there are multiple results, one per signature in the reference.

Parameters
[in]aIndex0-based index of the match result.
Returns
true for a match reported by the static matching engine, false for a non-match reported by the static matching engine or on error.
See also
getStaticMatchQuality(), getNumberOfStaticResults(), getResult()

The documentation for this class was generated from the following file: