biotemplate.html

JAVA CARD 开发包规格说明,版本为2.2.2

<PRE>
boolean <B>isInitialized</B>()</PRE>
<DL>
<DD>Returns true if the reference template is completely loaded and ready 
 for matching functions. This is independent of whether or not the match 
 process has been initialized (see <CODE>initMatch</CODE>).
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if initialized, false otherwise.</DL>
</DD>
</DL>
<HR>

<A NAME="isValidated()"><!-- --></A><H3>
isValidated</H3>
<PRE>
boolean <B>isValidated</B>()</PRE>
<DL>
<DD>Returns true if the template has been successfully checked since the last 
 card reset or last call to <CODE>reset()</CODE>.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if validated, false otherwise.</DL>
</DD>
</DL>
<HR>

<A NAME="reset()"><!-- --></A><H3>
reset</H3>
<PRE>
void <B>reset</B>()</PRE>
<DL>
<DD>Resets the validated flag associated with the reference template.
 This could be appropriate as a last 
 action after an access is completed.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getTriesRemaining()"><!-- --></A><H3>
getTriesRemaining</H3>
<PRE>
byte <B>getTriesRemaining</B>()</PRE>
<DL>
<DD>Returns the number of times remaining that an incorrect candidate 
 template can be presented before the reference template is blocked.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the number of tries remaining
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../javacardx/biometry/BioException.html" title="class in javacardx.biometry">BioException</A></CODE> - with the following reason codes:<ul>
 <li><code>BioException.NO_TEMPLATES_ENROLLED</code> if the reference template is 
  uninitialized.
 </ul></DL>
</DD>
</DL>
<HR>

<A NAME="getBioType()"><!-- --></A><H3>
getBioType</H3>
<PRE>
byte <B>getBioType</B>()</PRE>
<DL>
<DD>Get the biometric type. Valid type are described in <CODE>BioBuilder</CODE>.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>biometric general type.</DL>
</DD>
</DL>
<HR>

<A NAME="getVersion(byte[], short)"><!-- --></A><H3>
getVersion</H3>
<PRE>
short <B>getVersion</B>(byte[]&nbsp;dest,
                 short&nbsp;offset)</PRE>
<DL>
<DD>Get the matching algorithm version and ID.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>dest</CODE> - destination byte array.<DD><CODE>offset</CODE> - starting offset within the destination byte array.
<DT><B>Returns:</B><DD>number of bytes written in the destination byte array.</DL>
</DD>
</DL>
<HR>

<A NAME="getPublicTemplateData(short, byte[], short, short)"><!-- --></A><H3>
getPublicTemplateData</H3>
<PRE>
short <B>getPublicTemplateData</B>(short&nbsp;publicOffset,
                            byte[]&nbsp;dest,
                            short&nbsp;destOffset,
                            short&nbsp;length)
                            throws <A HREF="../../javacardx/biometry/BioException.html" title="class in javacardx.biometry">BioException</A></PRE>
<DL>
<DD>Get public part of the reference template. This method copies all or a portion of 
 the reference public data to the destination array.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>publicOffset</CODE> - starting offset within the public data.<DD><CODE>dest</CODE> - destination byte array.<DD><CODE>destOffset</CODE> - starting offset within the destination byte array.<DD><CODE>length</CODE> - maximum length in bytes of the requested data.
<DT><B>Returns:</B><DD>number of bytes written to the destination byte array. 
  0 if public data are not available.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../javacardx/biometry/BioException.html" title="class in javacardx.biometry">BioException</A></CODE> - with the following reason codes:<ul>
 <li><code>BioException.NO_TEMPLATES_ENROLLED</code> if the reference template is 
  uninitialized.
 </ul></DL>
</DD>
</DL>
<HR>

<A NAME="initMatch(byte[], short, short)"><!-- --></A><H3>
initMatch</H3>
<PRE>
short <B>initMatch</B>(byte[]&nbsp;candidate,
                short&nbsp;offset,
                short&nbsp;length)
                throws <A HREF="../../javacardx/biometry/BioException.html" title="class in javacardx.biometry">BioException</A></PRE>
<DL>
<DD>Initialize or re-initialize a biometric matching session. The exact return 
 score value is implementation dependent and can be used, for example, to 
 code a confidence rate. If the reference is not blocked, a matching 
 session starts and, before any other processing, the validated flag is 
 reset and the try counter is decremented if the try counter has reached zero, the 
 reference is blocked. This method results in one of the following:<ul>
   <li>The matching session ends with success state if the templates match.
   The validated flag is set and the try counter is reset to its maximum.  
   <li>The matching session ends with failed state if the templates don't match.
   <li>The matching session continues if the matching needs more data.
   The <CODE>match</CODE> method has to be called to continue the matching session.</ul>
 <p>If the reference is blocked, no matching session starts and this method returns 0.
 Notes:<ul>
   <li>A correct matching sequence is : <CODE>initMatch</CODE>,[<CODE>match</CODE>].
   Calling <CODE>initMatch</CODE> is mandatory, calling <CODE>match</CODE> is optional.
   <li>If a matching session is in progress (case needs more data), a call to 
   <CODE>initMatch</CODE> makes the current session to fail and starts a new matching 
   session.
   <li>Even if a transaction is in progress, internal state such as the try 
   counter, the validated flag and the blocking state must not be 
   conditionally updated. </ul>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>candidate</CODE> - - the data or part of the data of the candidate 
  template.<DD><CODE>offset</CODE> - - starting offset into the candidate array where the 
  candidate data is to be found.<DD><CODE>length</CODE> - - number of bytes to be taken from the candidate array.
<DT><B>Returns:</B><DD>the matching score with the following meaning :<ul>
  <li> >= MINIMUM_SUCCESSFUL_MATCH_SCORE : the matching session is successful 
  <li> >= 0 and < MINIMUM_SUCCESSFUL_MATCH_SCORE : the matching session has 
   failed
  <li> = MATCH_NEEDS_MORE_DATA : the matching session needs more data 
  </ul>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../javacardx/biometry/BioException.html" title="class in javacardx.biometry">BioException</A></CODE> - with the following reason codes:<ul>
 <li><code>BioException.INVALID_DATA</code> if the submitted candidate template 
  data does not have the required format.
 <li><code>BioException.NO_TEMPLATES_ENROLLED</code> if the reference template is 
  uninitialized.
  </ul></DL>
</DD>
</DL>
<HR>

<A NAME="match(byte[], short, short)"><!-- --></A><H3>
match</H3>
<PRE>
short <B>match</B>(byte[]&nbsp;candidate,
            short&nbsp;offset,
            short&nbsp;length)
            throws <A HREF="../../javacardx/biometry/BioException.html" title="class in javacardx.biometry">BioException</A></PRE>
<DL>
<DD>Continues a biometric matching session. The exact return score value is 
 implementation dependent and can be used, for example, to code a 
 confidence rate. If a matching session is in progress, this method results
 in one of the following:<ul>
   <li>The matching session ends with success state if the templates match.
   The validated flag is set and the try counter is reset to its maximum.  
   <li>The matching session ends with failed state if the templates don't match.
   <li>The matching session continues if the matching needs more data.
   The <CODE>match</CODE> method has to be called to continue the matching session.</ul>
 Notes:<ul>
   <li>A correct matching sequence is : <CODE>initMatch</CODE>,[<CODE>match</CODE>].
   Calling <CODE>initMatch</CODE> is mandatory, calling <CODE>match</CODE> is optional. 
   <li>Even if a transaction is in progress, internal state such as the try 
   counter, the validated flag and the blocking state must not be 
   conditionally updated.</ul>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>candidate</CODE> - - the data or part of the data of the candidate 
  template.<DD><CODE>offset</CODE> - - starting offset into the candidate array where the 
  candidate data is to be found.<DD><CODE>length</CODE> - - number of bytes to be taken from the candidate array.
<DT><B>Returns:</B><DD>the matching score with the following meaning :<ul>
  <li> >= MINIMUM_SUCCESSFUL_MATCH_SCORE : the matching session is successful 
  <li> >= 0 and < MINIMUM_SUCCESSFUL_MATCH_SCORE : the matching session has 
   failed
  <li> = MATCH_NEEDS_MORE_DATA : the matching session needs more data 
  </ul>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../javacardx/biometry/BioException.html" title="class in javacardx.biometry">BioException</A></CODE> - with the following reason codes:<ul>
 <li><code>BioException.ILLEGAL_USE</code> if used outside a matching session.
 <li><code>BioException.INVALID_DATA</code> if the submitted candidate template 
  data does not have the required format.
 <li><code>BioException.NO_TEMPLATES_ENROLLED</code> if the reference template is 
  uninitialized.
  </ul></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/BioTemplate.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<b>Java Card </b><br><font size="-1">v2.2.2</font></EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../javacardx/biometry/BioException.html" title="class in javacardx.biometry"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../javacardx/biometry/OwnerBioTemplate.html" title="interface in javacardx.biometry"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../index.html?javacardx/biometry/BioTemplate.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="BioTemplate.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>
<i>Copyright &#169; 1993-2005 Sun Microsystems, Inc. 4150 Network Circle,<br>Santa Clara, CA, 95054, U.S.A.  All Rights Reserved.</i>
</BODY>
</HTML>