visit Kofax web site

de.softpro.signware.SPTemplate Class Reference

Inheritance diagram for de.softpro.signware.SPTemplate:

de.softpro.signware.SPSignwareObject List of all members.

Detailed Description

Represent a template.

Both templates and references are used to compare a signature against. The major difference between a reference and a template is that a template is optimized for minimum size with a minor reduction in comparison quality. The template objects are suitable for saving them on a smartcard, where space is limited.

Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)


Public Member Functions

void addOption (SPTemplateOption value) throws SPSignwareException
 Add an optional parameter to a Template object.
void addOptionId (SPTemplateOption value, int id) throws SPSignwareException
 Add an optional parameter to a Template object.
SPTemplate createClone () throws SPSignwareException
 Create a clone of this template.
void delOptionId (int id) throws SPSignwareException
 Delete an optional parameter (described by its ID) from a Template object.
byte[] getImage (double dZoom, int iImageFormat) throws SPSignwareException
 Query an image on this template object.
Dimension getImageSize () throws SPSignwareException
 Query the size of an image created by this template object.
SPTemplateOption getOption (int index) throws SPSignwareException
 Get an optional parameter from a template object.
SPTemplateOption getOptionId (int id) throws SPSignwareException
 Get an optional parameter from a template object.
 SPTemplate (SPTemplate pTemplate) throws SPSignwareException
 Create a copy of a Template.
 SPTemplate (SPSmartcard pSmartcard) throws SPSignwareException
 Load a Template from a Smartcard.
 SPTemplate (byte[] baFlatFile) throws SPSignwareException
 Create a template object from a flatfile.
 SPTemplate (SPReference pReference, int iMaxTemplateSize) throws SPSignwareException
 Create a template object from a SPReference object.

Static Public Attributes

static final int SP_TEMPLATE_OPTION_BYTE = 4
static final int SP_TEMPLATE_OPTION_INT = 2
static final int SP_TEMPLATE_OPTION_SHORT = 3
static final int SP_TEMPLATE_OPTION_STR = 1

Package Functions

native final int jniFree ()


Constructor & Destructor Documentation

de.softpro.signware.SPTemplate.SPTemplate SPReference  pReference,
int  iMaxTemplateSize
throws SPSignwareException
 

Create a template object from a SPReference object.

The parameter iMaxTemplateSize limits the template size but reduces resolution when too small. It typically ranges from 2 KByte to 10 KByte, depending on limitations that may arise e.g. from maximum available space on a smartcard.

Parameters:
pReference [i] SPReference object
iMaxTemplateSize [i] Max size of FlatFile, when creating a FlatFile from the resulting Template
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPTemplateCreateFromReference

de.softpro.signware.SPTemplate.SPTemplate byte[]  baFlatFile  )  throws SPSignwareException
 

Create a template object from a flatfile.

Parameters:
baFlatFile [i] flatfile byte array
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPTemplateCreateFromFlatfile

de.softpro.signware.SPTemplate.SPTemplate SPSmartcard  pSmartcard  )  throws SPSignwareException
 

Load a Template from a Smartcard.

Parameters:
pSmartcard [i] the SPSmartcard object
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SPTemplateCreateFromSmartcard

de.softpro.signware.SPTemplate.SPTemplate SPTemplate  pTemplate  )  throws SPSignwareException
 

Create a copy of a Template.

Parameters:
pTemplate [i] the SPTemplate object
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPTemplateClone


Member Function Documentation

void de.softpro.signware.SPTemplate.addOption SPTemplateOption  value  )  throws SPSignwareException
 

Add an optional parameter to a Template object.

Parameters:
value [i] Value of the option.
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPTemplateAddOption, getOption

void de.softpro.signware.SPTemplate.addOptionId SPTemplateOption  value,
int  id
throws SPSignwareException
 

Add an optional parameter to a Template object.

Parameters:
value [i] Value of the option.
id [i] identifier of the option
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPTemplateAddOption, getOption

SPTemplate de.softpro.signware.SPTemplate.createClone  )  throws SPSignwareException
 

Create a clone of this template.

Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPTemplateClone

void de.softpro.signware.SPTemplate.delOptionId int  id  )  throws SPSignwareException
 

Delete an optional parameter (described by its ID) from a Template object.

Parameters:
id [i] Identification of the Option queried, range 0 .. 65535
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)

byte [] de.softpro.signware.SPTemplate.getImage double  dZoom,
int  iImageFormat
throws SPSignwareException
 

Query an image on this template object.

Parameters:
dZoom [i] zoom rate [1.0 typically creates an image with 300 dpi]
iImageFormat [i] requested image format
Returns:
byte[] the image in the requested format
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPTemplateGetImage

SPBitmap.SP_IMAGE_GIF, SPBitmap.SP_IMAGE_CCITT4, SPBitmap.SP_IMAGE_TIFF, SPBitmap.SP_IMAGE_BMP_WIN

SPBitmap.SP_IMAGE_BLACKWHITE, SPBitmap.SP_IMAGE_BLACKWHITE_1BPP, SPBitmap.SP_IMAGE_CROSSED

Dimension de.softpro.signware.SPTemplate.getImageSize  )  throws SPSignwareException
 

Query the size of an image created by this template object.

Returns:
Dimension the size of the image
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPTemplateGetImageSize

SPTemplateOption de.softpro.signware.SPTemplate.getOption int  index  )  throws SPSignwareException
 

Get an optional parameter from a template object.

Numeric option values are returned in field intValue of the option object. Please convert the values to the range defined by the return value:

  • SP_TEMPLATE_OPTION_INT no conversion
  • SP_TEMPLATE_OPTION_SHORT val = option.intValue & 0xffff;
  • SP_TEMPLATE_OPTION_BYTE val = option.intValue & 0xff;
Parameters:
index [i] 0-based Index of the Option queried
Returns:
SPTemplateOption the option
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
addOption, SPSignwareGetOption

SPTemplateOption de.softpro.signware.SPTemplate.getOptionId int  id  )  throws SPSignwareException
 

Get an optional parameter from a template object.

Parameters:
id [i] Identification of the Option queried
Returns:
SPTemplateOption the option
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
addOptionId, getOption, SPSignwareGetOptionId

native final int de.softpro.signware.SPTemplate.jniFree  )  [package, virtual]
 

Implements de.softpro.signware.SPSignwareObject.


Member Data Documentation

final int de.softpro.signware.SPTemplate.SP_TEMPLATE_OPTION_BYTE = 4 [static]
 

final int de.softpro.signware.SPTemplate.SP_TEMPLATE_OPTION_INT = 2 [static]
 

final int de.softpro.signware.SPTemplate.SP_TEMPLATE_OPTION_SHORT = 3 [static]
 

final int de.softpro.signware.SPTemplate.SP_TEMPLATE_OPTION_STR = 1 [static]
 


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