<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_18) on Thu Dec 02 16:59:42 UTC 2010 -->
<TITLE>
DbSecondaryKeyCreate
</TITLE>
<META NAME="date" CONTENT="2010-12-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DbSecondaryKeyCreate";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" 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_top_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> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../com/sleepycat/db/DbRunRecoveryException.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A>
<A HREF="../../../com/sleepycat/db/Dbt.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?com/sleepycat/db/DbSecondaryKeyCreate.html" target="_top"><B>FRAMES</B></A>
<A HREF="DbSecondaryKeyCreate.html" target="_top"><B>NO FRAMES</B></A>
<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: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sleepycat.db</FONT>
<BR>
Interface DbSecondaryKeyCreate</H2>
<HR>
<DL>
<DT><PRE>public interface <B>DbSecondaryKeyCreate</B></DL>
</PRE>
<P>
An interface specifying a function which constructs secondary keys
from primary key and data items.</p>
<P>
<P>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/db/DbSecondaryKeyCreate.html#secondaryKeyCreate(com.sleepycat.db.Db, com.sleepycat.db.Dbt, com.sleepycat.db.Dbt, com.sleepycat.db.Dbt)">secondaryKeyCreate</A></B>(<A HREF="../../../com/sleepycat/db/Db.html" title="class in com.sleepycat.db">Db</A> secondary,
<A HREF="../../../com/sleepycat/db/Dbt.html" title="class in com.sleepycat.db">Dbt</A> key,
<A HREF="../../../com/sleepycat/db/Dbt.html" title="class in com.sleepycat.db">Dbt</A> data,
<A HREF="../../../com/sleepycat/db/Dbt.html" title="class in com.sleepycat.db">Dbt</A> result)</CODE>
<BR>
The secondaryKeyCreate interface is used by the Db.associate
method.</TD>
</TR>
</TABLE>
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="secondaryKeyCreate(com.sleepycat.db.Db, com.sleepycat.db.Dbt, com.sleepycat.db.Dbt, com.sleepycat.db.Dbt)"><!-- --></A><H3>
secondaryKeyCreate</H3>
<PRE>
int <B>secondaryKeyCreate</B>(<A HREF="../../../com/sleepycat/db/Db.html" title="class in com.sleepycat.db">Db</A> secondary,
<A HREF="../../../com/sleepycat/db/Dbt.html" title="class in com.sleepycat.db">Dbt</A> key,
<A HREF="../../../com/sleepycat/db/Dbt.html" title="class in com.sleepycat.db">Dbt</A> data,
<A HREF="../../../com/sleepycat/db/Dbt.html" title="class in com.sleepycat.db">Dbt</A> result)
throws <A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A></PRE>
<DL>
<DD>The secondaryKeyCreate interface is used by the Db.associate
method. This interface defines the application-specific
function to be called to construct secondary keys from primary
key and data items.</p> </p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>secondary</CODE> - the database handle for the secondary.<DD><CODE>key</CODE> - a <A HREF="../../../com/sleepycat/db/Dbt.html" title="class in com.sleepycat.db"><CODE>Dbt</CODE></A>
referencing the primary key.<DD><CODE>data</CODE> - a <A HREF="../../../com/sleepycat/db/Dbt.html" title="class in com.sleepycat.db"><CODE>Dbt</CODE></A>
referencing the primary data item.<DD><CODE>result</CODE> - a zeroed <A HREF="../../../com/sleepycat/db/Dbt.html" title="class in com.sleepycat.db"><CODE>Dbt</CODE></A>
in which the callback function should fill in <b>data</b>
and <b>size</b> fields that describe the secondary key.
<DT><B>Returns:</B><DD><ul>
<li> <A HREF="../../../com/sleepycat/db/Db.html#DB_DONOTINDEX"><CODE>DB_DONOTINDEX</CODE></A><p>
If any key/data pair in the primary yields a null
secondary key and should be left out of the secondary
index, the callback function may optionally return
<code>Db.DB_DONOTINDEX</code>. Otherwise, the callback
function should return 0 in case of success or an error
outside of the Berkeley DB name space in case of
failure; the error code will be returned from the
Berkeley DB call that initiated the callback.</p> <p>
If the callback function returns <code>Db.DB_DONOTINDEX</code>
for any key/data pairs in the primary database, the
secondary index will not contain any reference to those
key/data pairs, and such operations as cursor iterations
and range queries will reflect only the corresponding
subset of the database. If this is not desirable, the
application should ensure that the callback function is
well-defined for all possible values and never returns
<code>Db.DB_DONOTINDEX</code>.</p> </li>
</ul>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A></CODE> - Signals that an exception of some sort
has occurred.</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> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../com/sleepycat/db/DbRunRecoveryException.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A>
<A HREF="../../../com/sleepycat/db/Dbt.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?com/sleepycat/db/DbSecondaryKeyCreate.html" target="_top"><B>FRAMES</B></A>
<A HREF="DbSecondaryKeyCreate.html" target="_top"><B>NO FRAMES</B></A>
<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: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>
