de.softpro.signware.SPFlatFile Class Reference
List of all members.Detailed Description
a flatfile representation of a reference or templateThe flatfile representation may be used to save a reference or a template as a blob in a database or in a file.
- Operating Systems:
- Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
Static Public Member Functions | |
| static byte[] | createFromCleanParameter (SPCleanParameter pCleanParameter) throws SPSignwareException |
| Serialize a SPCleanParameter object to a byte array. | |
| static byte[] | createFromPropertyMap (SPPropertyMap pPropertyMap) throws SPSignwareException |
| Serialize a SPPropertyMap object to a byte array. | |
| static byte[] | createFromReference (SPReference pReference, int iFormat) throws SPSignwareException |
| Serialize a SPReference object to a byte array. | |
| static byte[] | createFromReference (SPReference pReference) throws SPSignwareException |
| Serialize a SPReference object to a byte array. | |
| static byte[] | createFromReference3 (SPReference pReference, int iFormat) throws SPSignwareException |
| Serialize a SPReference object to a byte array. | |
| static byte[] | createFromSignature (SPSignature pSignature, int iFormat) throws SPSignwareException |
| Serialize a SPSignature object to a byte array. | |
| static byte[] | createFromSignature (SPSignature pSignature) throws SPSignwareException |
| Serialize a SPSignature object to a byte array. | |
| static byte[] | createFromSignature3 (SPSignature pSignature, int iFormat) throws SPSignwareException |
| Serialize a SPSignature object to a byte array. | |
| static byte[] | createFromTemplate (SPTemplate pTemplate) throws SPSignwareException |
| Serialize a SPTemplate object to a byte array. | |
| static byte[] | createFromTicket (SPTicket pTicket) throws SPSignwareException |
| Serialize a SPTicket object to a byte array. | |
| static boolean | isCleanParameter (byte[] flatfile) throws SPSignwareException |
| Check if the flatfile contains a CleanParameter. | |
| static boolean | isPropertyMap (byte[] flatfile) throws SPSignwareException |
| Check if the flatfile contains a PropertyMap. | |
| static boolean | isReference (byte[] flatfile) throws SPSignwareException |
| Check if the flatfile contains a reference. | |
| static boolean | isSignature (byte[] flatfile) throws SPSignwareException |
| Check if the flatfile contains a signature. | |
| static boolean | isTemplate (byte[] flatfile) throws SPSignwareException |
| Check if the flatfile contains a template. | |
| static boolean | isTicket (byte[] flatfile) throws SPSignwareException |
| Check if the flatfile contains a ticket. | |
Static Public Attributes | |
| static final int | iSP_FF_ISO_19785_3_FORMAT2 = 0x00000200 |
| Flat file format: Use ISO/IEC 19785-3:2015 patron format type 2 ("minimum simple byte-oriented patron format") CBEFF wrapper. | |
| static final int | iSP_FF_ISO_19785_3_FORMAT3 = 0x00000300 |
| Flat file format: Use ISO/IEC 19785-3:2015 patron format type 3 ("maximum simple patron format (byte oriented) using presence bitmap") CBEFF wrapper. | |
| static final int | iSP_FF_ISO_19785_3_FORMAT6 = 0x00000600 |
| Flat file format: Use ISO/IEC 19785-3:2015 patron format type 6 ("complex patron format") CBEFF wrapper. | |
| static final int | iSP_FF_ISO_19785_3_NONE = 0x00000000 |
| Flat file format: No ISO/IEC 19785-3:2015 (CBEFF) wrapper. | |
| static final int | iSP_FF_ISO_19794_7_2007TC1 = 0x00001000 |
| Flat file format: ISO/IEC 19794-7:2007 (with Technical Corrigendum 1) Biometric Data Block (version 1). | |
| static final int | iSP_FF_ISO_19794_7_2014 = 0x00002000 |
| Flat file format: ISO/IEC 19794-7:2014 Biometric Data Block (version 2). | |
| static final int | iSP_FF_ISO_19794_7_FULL = 0x00000000 |
| Flat file format: ISO/IEC 19794-7 full format. | |
| static final int | iSP_FF_ISO_19794_COMPLEX = 3 |
| Flat file format: ISO/IEC 19794-7:2007 (with Technical Corrigendum 1) full format biometric signature / reference data (version 1) embedded in a CBEFF (ISO/IEC 19785-3:2015) structure having patron format type 6 ("complex patron format"). | |
| static final int | iSP_FF_ISO_19794_MINIMUM = 1 |
| Flat file format: ISO/IEC 19794-7:2007 (with Technical Corrigendum 1) full format biometric signature data (version 1) embedded in a CBEFF (ISO/IEC 19785-3:2015) structure having patron format type 2 ("minimum simple byte-oriented patron format"). | |
| static final int | iSP_FF_ISO_19794_SIMPLE = 2 |
| Flat file format: ISO/IEC 19794-7:2007 (with Technical Corrigendum 1) full format biometric signature data (version 1) embedded in a CBEFF (ISO/IEC 19785-3:2015) structure having patron format type 3 ("maximum simple patron format (byte oriented) using presence bitmap"). | |
| static final int | iSP_FF_ISO_FLAG_COMPAT1 = 0x00400000 |
| Flat file format flag: write with bug compatibility with SignWare before version 3.2.9.0. | |
| static final int | iSP_FF_ISO_FLAG_METERS = 0x00100000 |
| Flat file format flag: Use meters rather than millimeters for X and Y coordinates. | |
| static final int | iSP_FF_ISO_FLAG_NO_EXT_DATA = 0x00800000 |
| Flat file format flag: Omit or ignore extended data. | |
| static final int | iSP_FF_ISO_FLAG_NO_FIX = 0x00200000 |
| Flat file format flag: do not attempt to automatically fix ISO-format signatures that have been written by SignWare before version 3.2.9.0. | |
| static final int | iSP_FF_ISO_MASK_BDB = 0x0000f000 |
| Mask for flat file format: BDB format. | |
| static final int | iSP_FF_ISO_MASK_DATA = 0x000f0000 |
| Mask for flat file format: data format. | |
| static final int | iSP_FF_ISO_MASK_FLAGS = 0xfff00000 |
| Mask for flat file format: flags. | |
| static final int | iSP_FF_ISO_MASK_SINGLE = 0x000000ff |
| Mask for flat file format: formats specified by a single value. | |
| static final int | iSP_FF_ISO_MASK_WRAPPER = 0x00000f00 |
| Mask for flat file format: CBEFF wrapper. | |
| static final int | iSP_FF_SOFTPRO = 0 |
| SOFTPRO Flatfile format for dynamic signatures / references. | |
Member Function Documentation
|
|
Serialize a SPCleanParameter object to a byte array.
|
|
|
Serialize a SPPropertyMap object to a byte array.
|
|
||||||||||||
|
Serialize a SPReference object to a byte array. Flags can be specified by environment variable SIGNWARE_ISO_SAVE. Its value is either a decimal number or a hexadecimal number (prefixed by "0x"). The number will be shifted left 20 bits and bitwise or-ed into iFormat, that is, the following values (and combinations thereof) are defined:
|
|
|
Serialize a SPReference object to a byte array. The default biometric data format is iSP_FF_SOFTPRO.
|
|
||||||||||||
|
Serialize a SPReference object to a byte array. This function does not use environment variable SIGNWARE_ISO_SAVE.
|
|
||||||||||||
|
Serialize a SPSignature object to a byte array. Flags can be specified by environment variable SIGNWARE_ISO_SAVE. Its value is either a decimal number or a hexadecimal number (prefixed by "0x"). The number will be shifted left 20 bits and bitwise or-ed into iFormat, that is, the following values (and combinations thereof) are defined:
|
|
|
Serialize a SPSignature object to a byte array. The default biometric data format is iSP_FF_SOFTPRO.
|
|
||||||||||||
|
Serialize a SPSignature object to a byte array. This function does not use environment variable SIGNWARE_ISO_SAVE.
|
|
|
Serialize a SPTemplate object to a byte array.
|
|
|
Serialize a SPTicket object to a byte array.
|
|
|
Check if the flatfile contains a CleanParameter.
|
|
|
Check if the flatfile contains a PropertyMap.
|
|
|
Check if the flatfile contains a reference.
|
|
|
Check if the flatfile contains a signature.
|
|
|
Check if the flatfile contains a template.
|
|
|
Check if the flatfile contains a ticket.
|
Member Data Documentation
|
|
Flat file format: Use ISO/IEC 19785-3:2015 patron format type 2 ("minimum simple byte-oriented patron format") CBEFF wrapper. This can be used with iSP_FF_ISO_19794_7_2007TC1 or iSP_FF_ISO_19794_7_2014. With iSP_FF_ISO_19794_7_2007TC1, this patron format cannot be used for saving references.
|
|
|
Flat file format: Use ISO/IEC 19785-3:2015 patron format type 3 ("maximum simple patron format (byte oriented) using presence bitmap") CBEFF wrapper. This can be used with iSP_FF_ISO_19794_7_2007TC1 or iSP_FF_ISO_19794_7_2014. With iSP_FF_ISO_19794_7_2007TC1, this patron format cannot be used for saving references.
|
|
|
Flat file format: Use ISO/IEC 19785-3:2015 patron format type 6 ("complex patron format") CBEFF wrapper. This can be used with iSP_FF_ISO_19794_7_2007TC1 or iSP_FF_ISO_19794_7_2014. Both signatures and references can be saved with this patron format.
|
|
|
Flat file format: No ISO/IEC 19785-3:2015 (CBEFF) wrapper. This should be used with iSP_FF_ISO_19794_7_2014 (version 2) only as ISO/IEC 19794-7:2007 (version 1) requires a CBEFF wrapper. However, some products accept only unwrapped version 1 BDBs.
|
|
|
Flat file format: ISO/IEC 19794-7:2007 (with Technical Corrigendum 1) Biometric Data Block (version 1). Please also use iSP_FF_ISO_19785_3_FORMAT2, iSP_FF_ISO_19785_3_FORMAT3, or iSP_FF_ISO_19785_3_FORMAT6 to specify the ISO/IEC 19785-3 wrapper. Alternateively, use iSP_FF_ISO_19785_3_NONE (signature) to omit the CBEFF wrapper; the CBEFF wrapper is mandatory in ISO/IEC 19794-7:2007, but some products accept only unwrapped BDBs. iSP_FF_ISO_19785_3_FORMAT6 is required for saving references, signatures can be saved with any of these constants. Please also use iSP_FF_ISO_19794_7_FULL (default) to select the data format. You can include flag iSP_FF_ISO_FLAG_METERS for using ISO/IEC 19794-7:2007 without Technical Corrigendum 1. You can include flag iSP_FF_ISO_FLAG_COMPAT1 for bug compatibility with SignWare before version 3.2.9.0. You can include flag iSP_FF_ISO_FLAG_NO_EXT_DATA to omit extended data. |
|
|
Flat file format: ISO/IEC 19794-7:2014 Biometric Data Block (version 2). Please also use iSP_FF_ISO_19785_3_NONE, iSP_FF_ISO_19785_3_FORMAT2, iSP_FF_ISO_19785_3_FORMAT3, or iSP_FF_ISO_19785_3_FORMAT6 to specify the ISO/IEC 19785-3 wrapper. Unlike ISO/IEC 19794-7:2007, ISO/IEC 19794-7:2014 allows BDBs without CBEFF wrapper. Both signatures and references can be saved with any of these constants. Please also use iSP_FF_ISO_19794_7_FULL (default) to select the data format. |
|
|
Flat file format: ISO/IEC 19794-7 full format. To be used with either iSP_FF_ISO_19794_7_2007TC1 or iSP_FF_ISO_19794_7_2014. Contrast with compact format, compression format, and XML, all of which are not yet supported.
|
|
|
Flat file format: ISO/IEC 19794-7:2007 (with Technical Corrigendum 1) full format biometric signature / reference data (version 1) embedded in a CBEFF (ISO/IEC 19785-3:2015) structure having patron format type 6 ("complex patron format"). This format can be used for signatures and references, not for templates. You can include flag iSP_FF_ISO_FLAG_METERS for using ISO/IEC 19794-7:2007 without Technical Corrigendum 1. You can include flag iSP_FF_ISO_FLAG_COMPAT1 for bug compatibility with SignWare before version 3.2.9.0. You can include flag iSP_FF_ISO_FLAG_NO_EXT_DATA to omit extended data. This value is equivalent to (but does not have the same value as)
|
|
|
Flat file format: ISO/IEC 19794-7:2007 (with Technical Corrigendum 1) full format biometric signature data (version 1) embedded in a CBEFF (ISO/IEC 19785-3:2015) structure having patron format type 2 ("minimum simple byte-oriented patron format"). This format can be used for signatures only, not for references and templates. You can include flag iSP_FF_ISO_FLAG_METERS for using ISO/IEC 19794-7:2007 without Technical Corrigendum 1. You can include flag iSP_FF_ISO_FLAG_COMPAT1 for bug compatibility with SignWare before version 3.2.9.0. You can include flag iSP_FF_ISO_FLAG_NO_EXT_DATA to omit extended data. This value is equivalent to (but does not have the same value as)
|
|
|
Flat file format: ISO/IEC 19794-7:2007 (with Technical Corrigendum 1) full format biometric signature data (version 1) embedded in a CBEFF (ISO/IEC 19785-3:2015) structure having patron format type 3 ("maximum simple patron format (byte oriented) using presence bitmap"). This format can be used for signatures only, not for references and templates. You can include flag iSP_FF_ISO_FLAG_METERS for using ISO/IEC 19794-7:2007 without Technical Corrigendum 1. You can include flag iSP_FF_ISO_FLAG_COMPAT1 for bug compatibility with SignWare before version 3.2.9.0. You can include flag iSP_FF_ISO_FLAG_NO_EXT_DATA to omit extended data. This value is equivalent to (but does not have the same value as)
|
|
|
Flat file format flag: write with bug compatibility with SignWare before version 3.2.9.0. ISO-format signatures written by SignWare before version 3.2.9.0 have multiple issues:
Use this flag for saving signatures in a format that is bug-compatible with old versions of SignWare (except for the bdbCreationDate bug). Extended data will be omitted (see iSP_FF_ISO_FLAG_NO_EXT_DATA). When saving a signature or reference, this flag takes effect only if the Biometric Data Block is in ISO/IEC 19794-7:2007 format (version 1) with a patron format type 2, 3, or 6 CBEFF wrapper, that is, for formats iSP_FF_ISO_19794_MINIMUM, iSP_FF_ISO_19794_SIMPLE, iSP_FF_ISO_19794_COMPLEX, and iSP_FF_ISO_19794_7_2007TC1 (with iSP_FF_ISO_19785_3_FORMAT2, iSP_FF_ISO_19785_3_FORMAT3, or iSP_FF_ISO_19785_3_FORMAT6). When loading a signature or reference, this flag must not be set. This flag is ignored for non-ISO formats.
|
|
|
Flat file format flag: Use meters rather than millimeters for X and Y coordinates. ISO-format signatures written by SignWare before version 3.2.9.0 use meters as units for the X and Y coordinates as specified by the original version of ISO/IEC 19794-7:2007. Technical Corrigendum for ISO/IEC 19794-7:2007 changed the units to millimeters. Set this flag for compatibility with software that implements ISO/IEC 19794-7:2007 without Technical Corrigendum 1. This flag takes effect only if the Biometric Data Block is in ISO/IEC 19794-7:2007 format (version 1). For loading signatures or references written by SignWare before version 3.2.9.0, just leave iSP_FF_ISO_FLAG_NO_FIX unset rather than setting this flag. For saving signatures or references to be read by SignWare before version 3.2.9.0, set iSP_FF_ISO_FLAG_COMPAT1 rather than this flag. This flag is ignored for non-ISO formats.
|
|
|
Flat file format flag: Omit or ignore extended data. By default, extended data will be written that includes the following information:
This flag is ignored for non-ISO formats.
|
|
|
Flat file format flag: do not attempt to automatically fix ISO-format signatures that have been written by SignWare before version 3.2.9.0. ISO-format signatures written by SignWare before version 3.2.9.0 have multiple issues:
When loading a signature or reference, all of these issues will be fixed automatically if data written by SignWare before version 3.2.9.0 is detected, unless this flag (iSP_FF_ISO_FLAG_NO_FIX) is set. If this flag is set, no attempt is made to fix the data. If the signature or reference was indeed written by SignWare before version 3.2.9.0, loading will fail or the data read will be incorrect. When saving a signature or reference, this flag must not be set. This flag is ignored for non-ISO formats.
|
|
|
Mask for flat file format: BDB format.
|
|
|
Mask for flat file format: data format.
|
|
|
Mask for flat file format: flags.
|
|
|
Mask for flat file format: formats specified by a single value.
|
|
|
Mask for flat file format: CBEFF wrapper.
|
|
|
SOFTPRO Flatfile format for dynamic signatures / references. This format can be used for signatures and references, not for templates.
|
The documentation for this class was generated from the following file: