visit SOFTPRO GmbH Website

de.softpro.signware.napi.SPNifCompareResult Class Reference

List of all members.

Detailed Description

This class encapsulates an SPCompare object.

This object represents the compare result with all details such as itemized static and dynamic match rates.


Public Member Functions

int getDynamicMatch ()
 query the dynamic match result
int getError ()
 Query finel error code.
boolean getFinalResult ()
int getFlags ()
 Query the compare flags that were used to create this result.
int getMinDynamicMatchRate ()
 query the minimum dynamic match rate
int getMinStaticMatchRate ()
 query the minimum static match rate
int getNumStaticResults ()
 query the number of available static results
int getStaticMatch (int iIndex)
 query a static match result
void readObject (java.io.ObjectInputStream in) throws java.io.IOException, ClassNotFoundException
 SPNifCompareResult ()
 Instantiate a new Compare result object.
String toString ()
void writeObject (java.io.ObjectOutputStream out) throws java.io.IOException

Package Functions

String getLogStr ()
String getResultStr ()
void setDynamicComplexity (int iResult)
void setDynamicResult (int iResult)
void setError (int iError)
void setFlags (int iFlags)
void setMinDynamicMatchRate (int iRate)
void setMinStaticMatchRate (int iRate)
void setResult (boolean bFinal)
void setResult (SPCompare spCompare)
void setStaticComplexity (int iResult)
void setStaticResult (int iResult[])


Constructor & Destructor Documentation

de.softpro.signware.napi.SPNifCompareResult.SPNifCompareResult  ) 
 

Instantiate a new Compare result object.


Member Function Documentation

int de.softpro.signware.napi.SPNifCompareResult.getDynamicMatch  ) 
 

query the dynamic match result

Returns:
int the dynamic match result

int de.softpro.signware.napi.SPNifCompareResult.getError  ) 
 

Query finel error code.

Returns:
int 0: no error, else error code

boolean de.softpro.signware.napi.SPNifCompareResult.getFinalResult  ) 
 

Query the final result

Returns:
bool final result: true signature and reference matched

int de.softpro.signware.napi.SPNifCompareResult.getFlags  ) 
 

Query the compare flags that were used to create this result.

Returns:
int the flags

String de.softpro.signware.napi.SPNifCompareResult.getLogStr  )  [package]
 

int de.softpro.signware.napi.SPNifCompareResult.getMinDynamicMatchRate  ) 
 

query the minimum dynamic match rate

Returns:
int the minimum dynamic match rate that was used to calculate the final result

int de.softpro.signware.napi.SPNifCompareResult.getMinStaticMatchRate  ) 
 

query the minimum static match rate

Returns:
int the minimum static match rate that was used to calculate the final result

int de.softpro.signware.napi.SPNifCompareResult.getNumStaticResults  ) 
 

query the number of available static results

Returns:
int the number of static results

String de.softpro.signware.napi.SPNifCompareResult.getResultStr  )  [package]
 

int de.softpro.signware.napi.SPNifCompareResult.getStaticMatch int  iIndex  ) 
 

query a static match result

Parameters:
iIndex index for the requested result, iIndex must be less than the number of available static results
Returns:
int the static match result

void de.softpro.signware.napi.SPNifCompareResult.readObject java.io.ObjectInputStream  in  )  throws java.io.IOException, ClassNotFoundException
 

Read this Object from a data stream

void de.softpro.signware.napi.SPNifCompareResult.setDynamicComplexity int  iResult  )  [package]
 

void de.softpro.signware.napi.SPNifCompareResult.setDynamicResult int  iResult  )  [package]
 

void de.softpro.signware.napi.SPNifCompareResult.setError int  iError  )  [package]
 

void de.softpro.signware.napi.SPNifCompareResult.setFlags int  iFlags  )  [package]
 

void de.softpro.signware.napi.SPNifCompareResult.setMinDynamicMatchRate int  iRate  )  [package]
 

void de.softpro.signware.napi.SPNifCompareResult.setMinStaticMatchRate int  iRate  )  [package]
 

void de.softpro.signware.napi.SPNifCompareResult.setResult boolean  bFinal  )  [package]
 

void de.softpro.signware.napi.SPNifCompareResult.setResult SPCompare  spCompare  )  [package]
 

void de.softpro.signware.napi.SPNifCompareResult.setStaticComplexity int  iResult  )  [package]
 

void de.softpro.signware.napi.SPNifCompareResult.setStaticResult int  iResult[]  )  [package]
 

String de.softpro.signware.napi.SPNifCompareResult.toString  ) 
 

void de.softpro.signware.napi.SPNifCompareResult.writeObject java.io.ObjectOutputStream  out  )  throws java.io.IOException
 

Write this Object to a data stream


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