SignDoc SDK (Java)  5.0.0
SignDocMatchParameters Class Reference

Parameters for SignDocSignatureData.matchSignature(), SignDocSignatureData.matchReference(), SignDocImage.matchSignature(), and SignDocImage.matchReference(). More...

Inheritance diagram for SignDocMatchParameters:

Public Member Functions

 SignDocMatchParameters ()
 Constructor. More...
 
synchronized SignDocMatchParameters clone () throws SignDocException
 Clone this object. More...
 
synchronized void clear () throws SignDocException
 Unset all parameters. More...
 
synchronized void setBoolean (String aName, boolean aValue) throws SignDocException
 Set a boolean parameter. More...
 
synchronized void setInteger (String aName, int aValue) throws SignDocException
 Set an integer parameter. More...
 
synchronized Boolean getBoolean (String aName) throws SignDocException
 Get the value of a boolean parameter. More...
 
synchronized Integer getInteger (String aName) throws SignDocException
 Get the value of an integer parameter. More...
 
synchronized String getErrorMessage () throws SignDocException
 Get an error message for the last function call. More...
 
synchronized void close ()
 Destroy the underlying native object (for java.lang.AutoCloseable). More...
 

Static Public Member Functions

static int getType (String aName) throws SignDocException
 Get the type of a parameter. More...
 

Static Public Attributes

static final int t_undefined = 0
 Return value of getType(): The specified parameter is not defined. More...
 
static final int t_boolean = 1
 Return value of getType(): Boolean. More...
 
static final int t_integer = 2
 Return value of getType(): Integer. More...
 
static final int f_engine_auto = 0x0001
 Flag for integer parameter "Flags": use all matching engines suitable for the data at hand. More...
 
static final int f_engine_static = 0x0002
 Flag for integer parameter "Flags": enable static matching (SIVAL engine). More...
 
static final int f_engine_dynamic = 0x0004
 Flag for integer parameter "Flags": enable dynamic matching (ADSV engine). More...
 
static final int f_engine_dstat = 0x0008
 Flag for integer parameter "Flags": enable statistic matching (DStat engine). More...
 
static final int f_normalize_sample_rates = 0x0100
 Flag for integer parameter "Flags": normalize the sample rates of signatures and references for dynamic matching. More...
 
static final int f_mirror = 0x0200
 Flag for integer parameter "Flags": mirror rendered signature and reference images for static matching. More...
 
static final int f_keep_resolution = 0x0400
 Flag for integer parameter "Flags": do not scale signatures. More...
 

Protected Member Functions

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

Detailed Description

Constructor & Destructor Documentation

Constructor.

No parameters will be set except for integer parameter "%Flags" (which will be zero) and the boolean parameters derived from that parameter.

See also
setInteger()

Member Function Documentation

synchronized void clear ( ) throws SignDocException

Unset all parameters.

After calling this function no parameters will be set except for integer parameter "%Flags" (which will be zero) and the boolean parameters derived from that parameter.

synchronized SignDocMatchParameters 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 Boolean getBoolean ( String  aName) throws SignDocException

Get the value of a boolean parameter.

Parameters
[in]aNameThe name of the parameter (case-sensitive).
Returns
The value of the parameter or null if the parameter is not set or is not a boolean parameter.
See also
setBoolean()
synchronized String getErrorMessage ( ) throws SignDocException

Get an error message for the last function call.

Returns
A string describing the reason for the failure of the last function call. The string is empty if the last call succeeded.
synchronized Integer getInteger ( String  aName) throws SignDocException

Get the value of an integer parameter.

Parameters
[in]aNameThe name of the parameter (case-sensitive).
Returns
The value of the parameter or null if the parameter is not set or is not an integer parameter.
See also
setInteger()
static int getType ( String  aName) throws SignDocException
static

Get the type of a parameter.

Parameters
[in]aNameThe name of the parameter (case-sensitive).
Returns
The type of the parameter: t_undefined, t_boolean, or t_integer.
synchronized void setBoolean ( String  aName,
boolean  aValue 
) throws SignDocException

Set a boolean parameter.

The following boolean parameters are available:

These boolean parameters allow controlling individual bits in integer parameter "%Flags". Initially, all boolean parameters have value false.

This function throws SignDocUnkownParameterException if aName is not the name of a boolean parameter.

Parameters
[in]aNameThe name of the parameter (case-sensitive).
[in]aValueThe value of the parameter.
See also
getBoolean(), setInteger()
synchronized void setInteger ( String  aName,
int  aValue 
) throws SignDocException

Set an integer parameter.

The following integer parameters are available:

  • Flags: set of flags controlling matching behavior:
  • MaxResolution: maximum resolution for f_keep_resolution, set to 0 for no maximum resolution. The default value is 300.
  • MinDStatQuality (0 through 100): minimum acceptable match value from the DStat matching engine. The default value is 80.
  • MinDynamicQuality (0 through 100): minimum acceptable match value from the dynamic matching engine. The default value is 80.
  • MinStaticQuality (0 through 100): minimum acceptable match value from the static matching engine. The default value is 80.

This function throws SignDocUnkownParameterException if aName is not the name of an integer parameter, SignDocInvalidValueException if aValue is invalid.

Parameters
[in]aNameThe name of the parameter (case-sensitive).
[in]aValueThe value of the parameter.
See also
getInteger(), setBoolean()

Member Data Documentation

final int f_engine_auto = 0x0001
static

Flag for integer parameter "Flags": use all matching engines suitable for the data at hand.

The static matching engine will always be used, the DStat matching engine and the dynamic matching engine will be used when matching a signature against a reference with at least 3 signatures.

This flag is equivalent to boolean parameter "EngineAuto".

final int f_engine_dstat = 0x0008
static

Flag for integer parameter "Flags": enable statistic matching (DStat engine).

This flag is equivalent to boolean parameter "EngineDStat".

final int f_engine_dynamic = 0x0004
static

Flag for integer parameter "Flags": enable dynamic matching (ADSV engine).

This flag is equivalent to boolean parameter "EngineDynamic".

final int f_engine_static = 0x0002
static

Flag for integer parameter "Flags": enable static matching (SIVAL engine).

This flag is equivalent to boolean parameter "EngineStatic".

final int f_keep_resolution = 0x0400
static

Flag for integer parameter "Flags": do not scale signatures.

If this flag is set, signatures, references, and signature images will be matched without adjusting their resolutions, even if those resolutions are different.

If this flag is not set, a common resolution will be computed as the smallest resolution encountered in the involved signatures, references, and signature images, and integer parameter "MaxResolution" (that parameter will be ignored if its value is 0). Then, the sample coordinates in signatures and references will be scaled to the computed resolutions and signature images will be resized to that resolution. (The SignDocSignatureData and SignDocImage objects won't be modified.)

See also integer parameter "MaxResolution". This flag is equivalent to boolean parameter "KeepResolution".

final int f_mirror = 0x0200
static

Flag for integer parameter "Flags": mirror rendered signature and reference images for static matching.

Set this flag when matching signatures that have been written in RTL scripts.

This flag is ignored unless the static matching engine is used. This flag is equivalent to boolean parameter "Mirror".

final int f_normalize_sample_rates = 0x0100
static

Flag for integer parameter "Flags": normalize the sample rates of signatures and references for dynamic matching.

This flag is ignored unless the dynamic matching engine is used. This flag is equivalent to boolean parameter "NormalizeSampleRates".

final int t_boolean = 1
static

Return value of getType(): Boolean.

final int t_integer = 2
static

Return value of getType(): Integer.

final int t_undefined = 0
static

Return value of getType(): The specified parameter is not defined.


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