1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<!--NewPage--> 3<HTML> 4<HEAD> 5<!-- Generated by javadoc (build 1.5.0) on Thu May 15 17:17:32 EDT 2008 --> 6<TITLE> 7SerialSerialKeyCreator (Oracle - Berkeley DB Java API) 8</TITLE> 9 10<META NAME="keywords" CONTENT="com.sleepycat.bind.serial.SerialSerialKeyCreator class"> 11 12<LINK REL ="stylesheet" TYPE="text/css" HREF="/style.css" TITLE="Style"> 13 14<SCRIPT type="text/javascript"> 15function windowTitle() 16{ 17 parent.document.title="SerialSerialKeyCreator (Oracle - Berkeley DB Java API)"; 18} 19</SCRIPT> 20<NOSCRIPT> 21</NOSCRIPT> 22 23</HEAD> 24 25<BODY BGCOLOR="white" onload="windowTitle();"> 26 27 28<!-- ========= START OF TOP NAVBAR ======= --> 29<A NAME="navbar_top"><!-- --></A> 30<A HREF="#skip-navbar_top" title="Skip navigation links"></A> 31<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 32<TR> 33<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 34<A NAME="navbar_top_firstrow"><!-- --></A> 35<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 36 <TR ALIGN="center" VALIGN="top"> 37 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 39 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SerialSerialKeyCreator.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 45 </TR> 46</TABLE> 47</TD> 48<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 49<b>Berkeley DB</b><br><font size="-1"> version 4.7.25</font></EM> 50</TD> 51</TR> 52 53<TR> 54<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 55 <A HREF="/com/sleepycat/bind/serial/SerialSerialBinding.html" title="class in com.sleepycat.bind.serial"><B>PREV CLASS</B></A> 56 <A HREF="/com/sleepycat/bind/serial/StoredClassCatalog.html" title="class in com.sleepycat.bind.serial"><B>NEXT CLASS</B></A></FONT></TD> 57<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 58 <A HREF="/index.html?com/sleepycat/bind/serial/SerialSerialKeyCreator.html" target="_top"><B>FRAMES</B></A> 59 <A HREF="SerialSerialKeyCreator.html" target="_top"><B>NO FRAMES</B></A> 60 <SCRIPT type="text/javascript"> 61 <!-- 62 if(window==top) { 63 document.writeln('<A HREF="/allclasses-noframe.html"><B>All Classes</B></A>'); 64 } 65 //--> 66</SCRIPT> 67<NOSCRIPT> 68 <A HREF="/allclasses-noframe.html"><B>All Classes</B></A> 69</NOSCRIPT> 70 71 72</FONT></TD> 73</TR> 74<TR> 75<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 76 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 77<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 78DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 79</TR> 80</TABLE> 81<A NAME="skip-navbar_top"></A> 82<!-- ========= END OF TOP NAVBAR ========= --> 83 84<HR> 85<!-- ======== START OF CLASS DATA ======== --> 86<H2> 87<FONT SIZE="-1"> 88com.sleepycat.bind.serial</FONT> 89<BR> 90Class SerialSerialKeyCreator</H2> 91<PRE> 92<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A> 93 <IMG SRC="/resources/inherit.gif" ALT="extended by "><B>com.sleepycat.bind.serial.SerialSerialKeyCreator</B> 94</PRE> 95<DL> 96<DT><B>All Implemented Interfaces:</B> <DD><A HREF="/com/sleepycat/db/ForeignKeyNullifier.html" title="interface in com.sleepycat.db">ForeignKeyNullifier</A>, <A HREF="/com/sleepycat/db/SecondaryKeyCreator.html" title="interface in com.sleepycat.db">SecondaryKeyCreator</A></DD> 97</DL> 98<HR> 99<DL> 100<DT><PRE>public abstract class <B>SerialSerialKeyCreator</B><DT>extends <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A><DT>implements <A HREF="/com/sleepycat/db/SecondaryKeyCreator.html" title="interface in com.sleepycat.db">SecondaryKeyCreator</A>, <A HREF="/com/sleepycat/db/ForeignKeyNullifier.html" title="interface in com.sleepycat.db">ForeignKeyNullifier</A></DL> 101</PRE> 102 103<P> 104A abstract key creator that uses a serial key and a serial data entry. 105 This class takes care of serializing and deserializing the key and data 106 entry automatically. 107 The following abstract method must be implemented by a concrete subclass 108 to create the index key using these objects 109 <ul> 110 <li> <A HREF="/com/sleepycat/bind/serial/SerialSerialKeyCreator.html#createSecondaryKey(java.lang.Object, java.lang.Object)"><CODE>createSecondaryKey(Object,Object)</CODE></A> </li> 111 </ul> 112 <p>If <A HREF="/com/sleepycat/db/ForeignKeyDeleteAction.html#NULLIFY"><CODE>ForeignKeyDeleteAction.NULLIFY</CODE></A> was 113 specified when opening the secondary database, the following method must be 114 overridden to nullify the foreign index key. If NULLIFY was not specified, 115 this method need not be overridden.</p> 116 <ul> 117 <li> <A HREF="/com/sleepycat/bind/serial/SerialSerialKeyCreator.html#nullifyForeignKey(java.lang.Object)"><CODE>nullifyForeignKey(Object)</CODE></A> </li> 118 </ul> 119<P> 120 121<P> 122<HR> 123 124<P> 125<!-- =========== FIELD SUMMARY =========== --> 126 127<A NAME="field_summary"><!-- --></A> 128<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 129<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 130<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 131<B>Field Summary</B></FONT></TH> 132</TR> 133<TR BGCOLOR="white" CLASS="TableRowColor"> 134<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 135<CODE>protected <A HREF="/com/sleepycat/bind/serial/SerialBinding.html" title="class in com.sleepycat.bind.serial">SerialBinding</A></CODE></FONT></TD> 136<TD><CODE><B><A HREF="/com/sleepycat/bind/serial/SerialSerialKeyCreator.html#dataBinding">dataBinding</A></B></CODE> 137 138<BR> 139 </TD> 140</TR> 141<TR BGCOLOR="white" CLASS="TableRowColor"> 142<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 143<CODE>protected <A HREF="/com/sleepycat/bind/serial/SerialBinding.html" title="class in com.sleepycat.bind.serial">SerialBinding</A></CODE></FONT></TD> 144<TD><CODE><B><A HREF="/com/sleepycat/bind/serial/SerialSerialKeyCreator.html#indexKeyBinding">indexKeyBinding</A></B></CODE> 145 146<BR> 147 </TD> 148</TR> 149<TR BGCOLOR="white" CLASS="TableRowColor"> 150<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 151<CODE>protected <A HREF="/com/sleepycat/bind/serial/SerialBinding.html" title="class in com.sleepycat.bind.serial">SerialBinding</A></CODE></FONT></TD> 152<TD><CODE><B><A HREF="/com/sleepycat/bind/serial/SerialSerialKeyCreator.html#primaryKeyBinding">primaryKeyBinding</A></B></CODE> 153 154<BR> 155 </TD> 156</TR> 157</TABLE> 158 159<!-- ======== CONSTRUCTOR SUMMARY ======== --> 160 161<A NAME="constructor_summary"><!-- --></A> 162<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 163<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 164<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 165<B>Constructor Summary</B></FONT></TH> 166</TR> 167<TR BGCOLOR="white" CLASS="TableRowColor"> 168<TD><CODE><B><A HREF="/com/sleepycat/bind/serial/SerialSerialKeyCreator.html#SerialSerialKeyCreator(com.sleepycat.bind.serial.ClassCatalog, java.lang.Class, java.lang.Class, java.lang.Class)">SerialSerialKeyCreator</A></B>(<A HREF="/com/sleepycat/bind/serial/ClassCatalog.html" title="interface in com.sleepycat.bind.serial">ClassCatalog</A> classCatalog, 169 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A> primaryKeyClass, 170 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A> dataClass, 171 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A> indexKeyClass)</CODE> 172 173<BR> 174 Creates a serial-serial key creator.</TD> 175</TR> 176<TR BGCOLOR="white" CLASS="TableRowColor"> 177<TD><CODE><B><A HREF="/com/sleepycat/bind/serial/SerialSerialKeyCreator.html#SerialSerialKeyCreator(com.sleepycat.bind.serial.SerialBinding, com.sleepycat.bind.serial.SerialBinding, com.sleepycat.bind.serial.SerialBinding)">SerialSerialKeyCreator</A></B>(<A HREF="/com/sleepycat/bind/serial/SerialBinding.html" title="class in com.sleepycat.bind.serial">SerialBinding</A> primaryKeyBinding, 178 <A HREF="/com/sleepycat/bind/serial/SerialBinding.html" title="class in com.sleepycat.bind.serial">SerialBinding</A> dataBinding, 179 <A HREF="/com/sleepycat/bind/serial/SerialBinding.html" title="class in com.sleepycat.bind.serial">SerialBinding</A> indexKeyBinding)</CODE> 180 181<BR> 182 Creates a serial-serial entity binding.</TD> 183</TR> 184</TABLE> 185 186<!-- ========== METHOD SUMMARY =========== --> 187 188<A NAME="method_summary"><!-- --></A> 189<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 190<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 191<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 192<B>Method Summary</B></FONT></TH> 193</TR> 194<TR BGCOLOR="white" CLASS="TableRowColor"> 195<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 196<CODE>abstract <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></CODE></FONT></TD> 197<TD><CODE><B><A HREF="/com/sleepycat/bind/serial/SerialSerialKeyCreator.html#createSecondaryKey(java.lang.Object, java.lang.Object)">createSecondaryKey</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> primaryKey, 198 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> data)</CODE> 199 200<BR> 201 Creates the index key object from primary key and entry objects.</TD> 202</TR> 203<TR BGCOLOR="white" CLASS="TableRowColor"> 204<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 205<CODE> boolean</CODE></FONT></TD> 206<TD><CODE><B><A HREF="/com/sleepycat/bind/serial/SerialSerialKeyCreator.html#createSecondaryKey(com.sleepycat.db.SecondaryDatabase, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)">createSecondaryKey</A></B>(<A HREF="/com/sleepycat/db/SecondaryDatabase.html" title="class in com.sleepycat.db">SecondaryDatabase</A> db, 207 <A HREF="/com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> primaryKeyEntry, 208 <A HREF="/com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> dataEntry, 209 <A HREF="/com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> indexKeyEntry)</CODE> 210 211<BR> 212 Creates a secondary key entry, given a primary key and data entry.</TD> 213</TR> 214<TR BGCOLOR="white" CLASS="TableRowColor"> 215<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 216<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></CODE></FONT></TD> 217<TD><CODE><B><A HREF="/com/sleepycat/bind/serial/SerialSerialKeyCreator.html#nullifyForeignKey(java.lang.Object)">nullifyForeignKey</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> data)</CODE> 218 219<BR> 220 Clears the index key in a data object.</TD> 221</TR> 222<TR BGCOLOR="white" CLASS="TableRowColor"> 223<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 224<CODE> boolean</CODE></FONT></TD> 225<TD><CODE><B><A HREF="/com/sleepycat/bind/serial/SerialSerialKeyCreator.html#nullifyForeignKey(com.sleepycat.db.SecondaryDatabase, com.sleepycat.db.DatabaseEntry)">nullifyForeignKey</A></B>(<A HREF="/com/sleepycat/db/SecondaryDatabase.html" title="class in com.sleepycat.db">SecondaryDatabase</A> db, 226 <A HREF="/com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> dataEntry)</CODE> 227 228<BR> 229 </TD> 230</TR> 231</TABLE> 232 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> 233<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 234<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 235<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TH> 236</TR> 237<TR BGCOLOR="white" CLASS="TableRowColor"> 238<TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> 239</TR> 240</TABLE> 241 242<P> 243 244<!-- ============ FIELD DETAIL =========== --> 245 246<A NAME="field_detail"><!-- --></A> 247<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 248<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 249<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 250<B>Field Detail</B></FONT></TH> 251</TR> 252</TABLE> 253 254<A NAME="primaryKeyBinding"><!-- --></A><H3> 255primaryKeyBinding</H3> 256<PRE> 257protected <A HREF="/com/sleepycat/bind/serial/SerialBinding.html" title="class in com.sleepycat.bind.serial">SerialBinding</A> <B>primaryKeyBinding</B></PRE> 258<DL> 259<DL> 260</DL> 261</DL> 262<HR> 263 264<A NAME="dataBinding"><!-- --></A><H3> 265dataBinding</H3> 266<PRE> 267protected <A HREF="/com/sleepycat/bind/serial/SerialBinding.html" title="class in com.sleepycat.bind.serial">SerialBinding</A> <B>dataBinding</B></PRE> 268<DL> 269<DL> 270</DL> 271</DL> 272<HR> 273 274<A NAME="indexKeyBinding"><!-- --></A><H3> 275indexKeyBinding</H3> 276<PRE> 277protected <A HREF="/com/sleepycat/bind/serial/SerialBinding.html" title="class in com.sleepycat.bind.serial">SerialBinding</A> <B>indexKeyBinding</B></PRE> 278<DL> 279<DL> 280</DL> 281</DL> 282 283<!-- ========= CONSTRUCTOR DETAIL ======== --> 284 285<A NAME="constructor_detail"><!-- --></A> 286<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 287<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 288<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 289<B>Constructor Detail</B></FONT></TH> 290</TR> 291</TABLE> 292 293<A NAME="SerialSerialKeyCreator(com.sleepycat.bind.serial.ClassCatalog, java.lang.Class, java.lang.Class, java.lang.Class)"><!-- --></A><H3> 294SerialSerialKeyCreator</H3> 295<PRE> 296public <B>SerialSerialKeyCreator</B>(<A HREF="/com/sleepycat/bind/serial/ClassCatalog.html" title="interface in com.sleepycat.bind.serial">ClassCatalog</A> classCatalog, 297 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A> primaryKeyClass, 298 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A> dataClass, 299 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A> indexKeyClass)</PRE> 300<DL> 301<DD>Creates a serial-serial key creator. 302<P> 303<DL> 304<DT><B>Parameters:</B><DD><CODE>classCatalog</CODE> - is the catalog to hold shared class information and 305 for a database should be a <A HREF="/com/sleepycat/bind/serial/StoredClassCatalog.html" title="class in com.sleepycat.bind.serial"><CODE>StoredClassCatalog</CODE></A>.<DD><CODE>primaryKeyClass</CODE> - is the primary key base class.<DD><CODE>dataClass</CODE> - is the data base class.<DD><CODE>indexKeyClass</CODE> - is the index key base class.</DL> 306</DL> 307<HR> 308 309<A NAME="SerialSerialKeyCreator(com.sleepycat.bind.serial.SerialBinding, com.sleepycat.bind.serial.SerialBinding, com.sleepycat.bind.serial.SerialBinding)"><!-- --></A><H3> 310SerialSerialKeyCreator</H3> 311<PRE> 312public <B>SerialSerialKeyCreator</B>(<A HREF="/com/sleepycat/bind/serial/SerialBinding.html" title="class in com.sleepycat.bind.serial">SerialBinding</A> primaryKeyBinding, 313 <A HREF="/com/sleepycat/bind/serial/SerialBinding.html" title="class in com.sleepycat.bind.serial">SerialBinding</A> dataBinding, 314 <A HREF="/com/sleepycat/bind/serial/SerialBinding.html" title="class in com.sleepycat.bind.serial">SerialBinding</A> indexKeyBinding)</PRE> 315<DL> 316<DD>Creates a serial-serial entity binding. 317<P> 318<DL> 319<DT><B>Parameters:</B><DD><CODE>primaryKeyBinding</CODE> - is the primary key binding.<DD><CODE>dataBinding</CODE> - is the data binding.<DD><CODE>indexKeyBinding</CODE> - is the index key binding.</DL> 320</DL> 321 322<!-- ============ METHOD DETAIL ========== --> 323 324<A NAME="method_detail"><!-- --></A> 325<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 326<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 327<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 328<B>Method Detail</B></FONT></TH> 329</TR> 330</TABLE> 331 332<A NAME="createSecondaryKey(com.sleepycat.db.SecondaryDatabase, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)"><!-- --></A><H3> 333createSecondaryKey</H3> 334<PRE> 335public boolean <B>createSecondaryKey</B>(<A HREF="/com/sleepycat/db/SecondaryDatabase.html" title="class in com.sleepycat.db">SecondaryDatabase</A> db, 336 <A HREF="/com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> primaryKeyEntry, 337 <A HREF="/com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> dataEntry, 338 <A HREF="/com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> indexKeyEntry) 339 throws <A HREF="/com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 340<DL> 341<DD><B>Description copied from interface: <CODE><A HREF="/com/sleepycat/db/SecondaryKeyCreator.html#createSecondaryKey(com.sleepycat.db.SecondaryDatabase, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)">SecondaryKeyCreator</A></CODE></B></DD> 342<DD>Creates a secondary key entry, given a primary key and data entry. 343 <p> 344 A secondary key may be derived from the primary key, primary data, or a 345 combination of the primary key and data. For secondary keys that are 346 optional, the key creator method may return false and the key/data pair 347 will not be indexed. To ensure the integrity of a secondary database the 348 key creator method must always return the same result for a given set of 349 input parameters. 350 <p> 351<P> 352<DD><DL> 353<DT><B>Specified by:</B><DD><CODE><A HREF="/com/sleepycat/db/SecondaryKeyCreator.html#createSecondaryKey(com.sleepycat.db.SecondaryDatabase, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)">createSecondaryKey</A></CODE> in interface <CODE><A HREF="/com/sleepycat/db/SecondaryKeyCreator.html" title="interface in com.sleepycat.db">SecondaryKeyCreator</A></CODE></DL> 354</DD> 355<DD><DL> 356<DT><B>Parameters:</B><DD><CODE>db</CODE> - the database to which the secondary key will be added. 357 This parameter is passed for informational purposes but is not commonly 358 used. 359 <p><DD><CODE>primaryKeyEntry</CODE> - the primary key entry. This parameter must not be modified 360 by this method. 361 <p><DD><CODE>dataEntry</CODE> - the primary data entry. This parameter must not be modified 362 by this method. 363 <p><DD><CODE>indexKeyEntry</CODE> - the secondary key created by this method. 364 <p> 365<DT><B>Returns:</B><DD>true if a key was created, or false to indicate that the key is 366 not present. 367 <p> 368<DT><B>Throws:</B> 369<DD><CODE><A HREF="/com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if an error occurs attempting to create the 370 secondary key.</DL> 371</DD> 372</DL> 373<HR> 374 375<A NAME="nullifyForeignKey(com.sleepycat.db.SecondaryDatabase, com.sleepycat.db.DatabaseEntry)"><!-- --></A><H3> 376nullifyForeignKey</H3> 377<PRE> 378public boolean <B>nullifyForeignKey</B>(<A HREF="/com/sleepycat/db/SecondaryDatabase.html" title="class in com.sleepycat.db">SecondaryDatabase</A> db, 379 <A HREF="/com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> dataEntry) 380 throws <A HREF="/com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 381<DL> 382<DD><DL> 383<DT><B>Specified by:</B><DD><CODE><A HREF="/com/sleepycat/db/ForeignKeyNullifier.html#nullifyForeignKey(com.sleepycat.db.SecondaryDatabase, com.sleepycat.db.DatabaseEntry)">nullifyForeignKey</A></CODE> in interface <CODE><A HREF="/com/sleepycat/db/ForeignKeyNullifier.html" title="interface in com.sleepycat.db">ForeignKeyNullifier</A></CODE></DL> 384</DD> 385<DD><DL> 386 387<DT><B>Throws:</B> 388<DD><CODE><A HREF="/com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 389</DD> 390</DL> 391<HR> 392 393<A NAME="createSecondaryKey(java.lang.Object, java.lang.Object)"><!-- --></A><H3> 394createSecondaryKey</H3> 395<PRE> 396public abstract <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> <B>createSecondaryKey</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> primaryKey, 397 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> data)</PRE> 398<DL> 399<DD>Creates the index key object from primary key and entry objects. 400<P> 401<DD><DL> 402</DL> 403</DD> 404<DD><DL> 405<DT><B>Parameters:</B><DD><CODE>primaryKey</CODE> - is the deserialized source primary key entry, or 406 null if no primary key entry is used to construct the index key.<DD><CODE>data</CODE> - is the deserialized source data entry, or null if no 407 data entry is used to construct the index key. 408<DT><B>Returns:</B><DD>the destination index key object, or null to indicate that 409 the key is not present.</DL> 410</DD> 411</DL> 412<HR> 413 414<A NAME="nullifyForeignKey(java.lang.Object)"><!-- --></A><H3> 415nullifyForeignKey</H3> 416<PRE> 417public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> <B>nullifyForeignKey</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> data)</PRE> 418<DL> 419<DD>Clears the index key in a data object. 420 421 <p>On entry the data parameter contains the index key to be cleared. It 422 should be changed by this method such that <A HREF="/com/sleepycat/bind/serial/SerialSerialKeyCreator.html#createSecondaryKey(com.sleepycat.db.SecondaryDatabase, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)"><CODE>createSecondaryKey(com.sleepycat.db.SecondaryDatabase, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)</CODE></A> 423 will return false. Other fields in the data object should remain 424 unchanged.</p> 425<P> 426<DD><DL> 427</DL> 428</DD> 429<DD><DL> 430<DT><B>Parameters:</B><DD><CODE>data</CODE> - is the source and destination data object. 431<DT><B>Returns:</B><DD>the destination data object, or null to indicate that the 432 key is not present and no change is necessary. The data returned may 433 be the same object passed as the data parameter or a newly created 434 object.</DL> 435</DD> 436</DL> 437<!-- ========= END OF CLASS DATA ========= --> 438<HR> 439 440 441<!-- ======= START OF BOTTOM NAVBAR ====== --> 442<A NAME="navbar_bottom"><!-- --></A> 443<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 444<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 445<TR> 446<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 447<A NAME="navbar_bottom_firstrow"><!-- --></A> 448<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 449 <TR ALIGN="center" VALIGN="top"> 450 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 451 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 452 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 453 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SerialSerialKeyCreator.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 454 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 455 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 456 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 457 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 458 </TR> 459</TABLE> 460</TD> 461<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 462<b>Berkeley DB</b><br><font size="-1"> version 4.7.25</font></EM> 463</TD> 464</TR> 465 466<TR> 467<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 468 <A HREF="/com/sleepycat/bind/serial/SerialSerialBinding.html" title="class in com.sleepycat.bind.serial"><B>PREV CLASS</B></A> 469 <A HREF="/com/sleepycat/bind/serial/StoredClassCatalog.html" title="class in com.sleepycat.bind.serial"><B>NEXT CLASS</B></A></FONT></TD> 470<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 471 <A HREF="/index.html?com/sleepycat/bind/serial/SerialSerialKeyCreator.html" target="_top"><B>FRAMES</B></A> 472 <A HREF="SerialSerialKeyCreator.html" target="_top"><B>NO FRAMES</B></A> 473 <SCRIPT type="text/javascript"> 474 <!-- 475 if(window==top) { 476 document.writeln('<A HREF="/allclasses-noframe.html"><B>All Classes</B></A>'); 477 } 478 //--> 479</SCRIPT> 480<NOSCRIPT> 481 <A HREF="/allclasses-noframe.html"><B>All Classes</B></A> 482</NOSCRIPT> 483 484 485</FONT></TD> 486</TR> 487<TR> 488<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 489 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 490<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 491DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 492</TR> 493</TABLE> 494<A NAME="skip-navbar_bottom"></A> 495<!-- ======== END OF BOTTOM NAVBAR ======= --> 496 497<HR> 498<font size=1>Copyright (c) 1996,2008 Oracle. All rights reserved.</font> 499</BODY> 500</HTML> 501
