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.6.0_03) on Mon Apr 12 16:25:48 EDT 2010 --> 6<TITLE> 7TupleSerialMarshalledKeyCreator (Oracle - Berkeley DB Java API) 8</TITLE> 9 10<META NAME="date" CONTENT="2010-04-12"> 11 12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../style.css" TITLE="Style"> 13 14<SCRIPT type="text/javascript"> 15function windowTitle() 16{ 17 if (location.href.indexOf('is-external=true') == -1) { 18 parent.document.title="TupleSerialMarshalledKeyCreator (Oracle - Berkeley DB Java API)"; 19 } 20} 21</SCRIPT> 22<NOSCRIPT> 23</NOSCRIPT> 24 25</HEAD> 26 27<BODY BGCOLOR="white" onload="windowTitle();"> 28<HR> 29 30 31<!-- ========= START OF TOP NAVBAR ======= --> 32<A NAME="navbar_top"><!-- --></A> 33<A HREF="#skip-navbar_top" title="Skip navigation links"></A> 34<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 35<TR> 36<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 37<A NAME="navbar_top_firstrow"><!-- --></A> 38<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 39 <TR ALIGN="center" VALIGN="top"> 40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 42 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/TupleSerialMarshalledKeyCreator.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 48 </TR> 49</TABLE> 50</TD> 51<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 52<b>Berkeley DB</b><br><font size="-1"> version 4.8.30</font></EM> 53</TD> 54</TR> 55 56<TR> 57<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 58 <A HREF="../../../../com/sleepycat/bind/serial/TupleSerialMarshalledBinding.html" title="class in com.sleepycat.bind.serial"><B>PREV CLASS</B></A> 59 NEXT CLASS</FONT></TD> 60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 61 <A HREF="../../../../index.html?com/sleepycat/bind/serial/TupleSerialMarshalledKeyCreator.html" target="_top"><B>FRAMES</B></A> 62 <A HREF="TupleSerialMarshalledKeyCreator.html" target="_top"><B>NO FRAMES</B></A> 63 <SCRIPT type="text/javascript"> 64 <!-- 65 if(window==top) { 66 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 67 } 68 //--> 69</SCRIPT> 70<NOSCRIPT> 71 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 72</NOSCRIPT> 73 74 75</FONT></TD> 76</TR> 77<TR> 78<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 79 SUMMARY: NESTED | <A HREF="#fields_inherited_from_class_com.sleepycat.bind.serial.TupleSerialKeyCreator">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 81DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 82</TR> 83</TABLE> 84<A NAME="skip-navbar_top"></A> 85<!-- ========= END OF TOP NAVBAR ========= --> 86 87<HR> 88<!-- ======== START OF CLASS DATA ======== --> 89<H2> 90<FONT SIZE="-1"> 91com.sleepycat.bind.serial</FONT> 92<BR> 93Class TupleSerialMarshalledKeyCreator<D extends <A HREF="../../../../com/sleepycat/bind/tuple/MarshalledTupleKeyEntity.html" title="interface in com.sleepycat.bind.tuple">MarshalledTupleKeyEntity</A>></H2> 94<PRE> 95<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> 96 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../com/sleepycat/bind/tuple/TupleBase.html" title="class in com.sleepycat.bind.tuple">com.sleepycat.bind.tuple.TupleBase</A> 97 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../com/sleepycat/bind/serial/TupleSerialKeyCreator.html" title="class in com.sleepycat.bind.serial">com.sleepycat.bind.serial.TupleSerialKeyCreator</A><D> 98 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.sleepycat.bind.serial.TupleSerialMarshalledKeyCreator<D></B> 99</PRE> 100<DL> 101<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> 102</DL> 103<HR> 104<DL> 105<DT><PRE>public class <B>TupleSerialMarshalledKeyCreator<D extends <A HREF="../../../../com/sleepycat/bind/tuple/MarshalledTupleKeyEntity.html" title="interface in com.sleepycat.bind.tuple">MarshalledTupleKeyEntity</A>></B><DT>extends <A HREF="../../../../com/sleepycat/bind/serial/TupleSerialKeyCreator.html" title="class in com.sleepycat.bind.serial">TupleSerialKeyCreator</A><D></DL> 106</PRE> 107 108<P> 109A concrete key creator that works in conjunction with a <A HREF="../../../../com/sleepycat/bind/serial/TupleSerialMarshalledBinding.html" title="class in com.sleepycat.bind.serial"><CODE>TupleSerialMarshalledBinding</CODE></A>. This key creator works by calling the 110 methods of the <A HREF="../../../../com/sleepycat/bind/tuple/MarshalledTupleKeyEntity.html" title="interface in com.sleepycat.bind.tuple"><CODE>MarshalledTupleKeyEntity</CODE></A> interface to create and 111 clear the index key fields. 112<P> 113 114<P> 115<DL> 116<DT><B>See Also:</B><DD><a href="SerialBinding.html#evolution">Class Evolution</a></DL> 117<HR> 118 119<P> 120<!-- =========== FIELD SUMMARY =========== --> 121 122<A NAME="field_summary"><!-- --></A> 123<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 124<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 125<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 126<B>Field Summary</B></FONT></TH> 127</TR> 128</TABLE> 129 <A NAME="fields_inherited_from_class_com.sleepycat.bind.serial.TupleSerialKeyCreator"><!-- --></A> 130<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 131<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 132<TH ALIGN="left"><B>Fields inherited from class com.sleepycat.bind.serial.<A HREF="../../../../com/sleepycat/bind/serial/TupleSerialKeyCreator.html" title="class in com.sleepycat.bind.serial">TupleSerialKeyCreator</A></B></TH> 133</TR> 134<TR BGCOLOR="white" CLASS="TableRowColor"> 135<TD><CODE><A HREF="../../../../com/sleepycat/bind/serial/TupleSerialKeyCreator.html#dataBinding">dataBinding</A></CODE></TD> 136</TR> 137</TABLE> 138 139<!-- ======== CONSTRUCTOR SUMMARY ======== --> 140 141<A NAME="constructor_summary"><!-- --></A> 142<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 143<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 144<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 145<B>Constructor Summary</B></FONT></TH> 146</TR> 147<TR BGCOLOR="white" CLASS="TableRowColor"> 148<TD><CODE><B><A HREF="../../../../com/sleepycat/bind/serial/TupleSerialMarshalledKeyCreator.html#TupleSerialMarshalledKeyCreator(com.sleepycat.bind.serial.TupleSerialMarshalledBinding, java.lang.String)">TupleSerialMarshalledKeyCreator</A></B>(<A HREF="../../../../com/sleepycat/bind/serial/TupleSerialMarshalledBinding.html" title="class in com.sleepycat.bind.serial">TupleSerialMarshalledBinding</A><<A HREF="../../../../com/sleepycat/bind/serial/TupleSerialMarshalledKeyCreator.html" title="type parameter in TupleSerialMarshalledKeyCreator">D</A>> binding, 149 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> keyName)</CODE> 150 151<BR> 152 Creates a tuple-serial marshalled key creator.</TD> 153</TR> 154</TABLE> 155 156<!-- ========== METHOD SUMMARY =========== --> 157 158<A NAME="method_summary"><!-- --></A> 159<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 160<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 161<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 162<B>Method Summary</B></FONT></TH> 163</TR> 164<TR BGCOLOR="white" CLASS="TableRowColor"> 165<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 166<CODE> boolean</CODE></FONT></TD> 167<TD><CODE><B><A HREF="../../../../com/sleepycat/bind/serial/TupleSerialMarshalledKeyCreator.html#createSecondaryKey(com.sleepycat.bind.tuple.TupleInput, D, com.sleepycat.bind.tuple.TupleOutput)">createSecondaryKey</A></B>(<A HREF="../../../../com/sleepycat/bind/tuple/TupleInput.html" title="class in com.sleepycat.bind.tuple">TupleInput</A> primaryKeyInput, 168 <A HREF="../../../../com/sleepycat/bind/serial/TupleSerialMarshalledKeyCreator.html" title="type parameter in TupleSerialMarshalledKeyCreator">D</A> dataInput, 169 <A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</A> indexKeyOutput)</CODE> 170 171<BR> 172 Creates the index key entry from primary key tuple entry and 173 deserialized data entry.</TD> 174</TR> 175<TR BGCOLOR="white" CLASS="TableRowColor"> 176<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 177<CODE> <A HREF="../../../../com/sleepycat/bind/serial/TupleSerialMarshalledKeyCreator.html" title="type parameter in TupleSerialMarshalledKeyCreator">D</A></CODE></FONT></TD> 178<TD><CODE><B><A HREF="../../../../com/sleepycat/bind/serial/TupleSerialMarshalledKeyCreator.html#nullifyForeignKey(D)">nullifyForeignKey</A></B>(<A HREF="../../../../com/sleepycat/bind/serial/TupleSerialMarshalledKeyCreator.html" title="type parameter in TupleSerialMarshalledKeyCreator">D</A> dataInput)</CODE> 179 180<BR> 181 Clears the index key in the deserialized data entry.</TD> 182</TR> 183</TABLE> 184 <A NAME="methods_inherited_from_class_com.sleepycat.bind.serial.TupleSerialKeyCreator"><!-- --></A> 185<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 186<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 187<TH ALIGN="left"><B>Methods inherited from class com.sleepycat.bind.serial.<A HREF="../../../../com/sleepycat/bind/serial/TupleSerialKeyCreator.html" title="class in com.sleepycat.bind.serial">TupleSerialKeyCreator</A></B></TH> 188</TR> 189<TR BGCOLOR="white" CLASS="TableRowColor"> 190<TD><CODE><A HREF="../../../../com/sleepycat/bind/serial/TupleSerialKeyCreator.html#createSecondaryKey(com.sleepycat.db.SecondaryDatabase, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)">createSecondaryKey</A>, <A HREF="../../../../com/sleepycat/bind/serial/TupleSerialKeyCreator.html#nullifyForeignKey(com.sleepycat.db.SecondaryDatabase, com.sleepycat.db.DatabaseEntry)">nullifyForeignKey</A></CODE></TD> 191</TR> 192</TABLE> 193 <A NAME="methods_inherited_from_class_com.sleepycat.bind.tuple.TupleBase"><!-- --></A> 194<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 195<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 196<TH ALIGN="left"><B>Methods inherited from class com.sleepycat.bind.tuple.<A HREF="../../../../com/sleepycat/bind/tuple/TupleBase.html" title="class in com.sleepycat.bind.tuple">TupleBase</A></B></TH> 197</TR> 198<TR BGCOLOR="white" CLASS="TableRowColor"> 199<TD><CODE><A HREF="../../../../com/sleepycat/bind/tuple/TupleBase.html#entryToInput(com.sleepycat.db.DatabaseEntry)">entryToInput</A>, <A HREF="../../../../com/sleepycat/bind/tuple/TupleBase.html#getTupleBufferSize()">getTupleBufferSize</A>, <A HREF="../../../../com/sleepycat/bind/tuple/TupleBase.html#getTupleOutput(E)">getTupleOutput</A>, <A HREF="../../../../com/sleepycat/bind/tuple/TupleBase.html#inputToEntry(com.sleepycat.bind.tuple.TupleInput, com.sleepycat.db.DatabaseEntry)">inputToEntry</A>, <A HREF="../../../../com/sleepycat/bind/tuple/TupleBase.html#newOutput()">newOutput</A>, <A HREF="../../../../com/sleepycat/bind/tuple/TupleBase.html#newOutput(byte[])">newOutput</A>, <A HREF="../../../../com/sleepycat/bind/tuple/TupleBase.html#outputToEntry(com.sleepycat.bind.tuple.TupleOutput, com.sleepycat.db.DatabaseEntry)">outputToEntry</A>, <A HREF="../../../../com/sleepycat/bind/tuple/TupleBase.html#setTupleBufferSize(int)">setTupleBufferSize</A></CODE></TD> 200</TR> 201</TABLE> 202 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> 203<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 204<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 205<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?is-external=true" title="class or interface in java.lang">Object</A></B></TH> 206</TR> 207<TR BGCOLOR="white" CLASS="TableRowColor"> 208<TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#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?is-external=true#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?is-external=true#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?is-external=true#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?is-external=true#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?is-external=true#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?is-external=true#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?is-external=true#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?is-external=true#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?is-external=true#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?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> 209</TR> 210</TABLE> 211 212<P> 213 214<!-- ========= CONSTRUCTOR DETAIL ======== --> 215 216<A NAME="constructor_detail"><!-- --></A> 217<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 218<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 219<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 220<B>Constructor Detail</B></FONT></TH> 221</TR> 222</TABLE> 223 224<A NAME="TupleSerialMarshalledKeyCreator(com.sleepycat.bind.serial.TupleSerialMarshalledBinding, java.lang.String)"><!-- --></A><H3> 225TupleSerialMarshalledKeyCreator</H3> 226<PRE> 227public <B>TupleSerialMarshalledKeyCreator</B>(<A HREF="../../../../com/sleepycat/bind/serial/TupleSerialMarshalledBinding.html" title="class in com.sleepycat.bind.serial">TupleSerialMarshalledBinding</A><<A HREF="../../../../com/sleepycat/bind/serial/TupleSerialMarshalledKeyCreator.html" title="type parameter in TupleSerialMarshalledKeyCreator">D</A>> binding, 228 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> keyName)</PRE> 229<DL> 230<DD>Creates a tuple-serial marshalled key creator. 231<P> 232<DL> 233<DT><B>Parameters:</B><DD><CODE>binding</CODE> - is the binding used for the tuple-serial entity.<DD><CODE>keyName</CODE> - is the key name passed to the <A HREF="../../../../com/sleepycat/bind/tuple/MarshalledTupleKeyEntity.html#marshalSecondaryKey(java.lang.String, com.sleepycat.bind.tuple.TupleOutput)"><CODE>MarshalledTupleKeyEntity.marshalSecondaryKey(java.lang.String, com.sleepycat.bind.tuple.TupleOutput)</CODE></A> method to identify the 234 index key.</DL> 235</DL> 236 237<!-- ============ METHOD DETAIL ========== --> 238 239<A NAME="method_detail"><!-- --></A> 240<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 241<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 242<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 243<B>Method Detail</B></FONT></TH> 244</TR> 245</TABLE> 246 247<A NAME="createSecondaryKey(com.sleepycat.bind.tuple.TupleInput,com.sleepycat.bind.tuple.MarshalledTupleKeyEntity,com.sleepycat.bind.tuple.TupleOutput)"><!-- --></A><A NAME="createSecondaryKey(com.sleepycat.bind.tuple.TupleInput, D, com.sleepycat.bind.tuple.TupleOutput)"><!-- --></A><H3> 248createSecondaryKey</H3> 249<PRE> 250public boolean <B>createSecondaryKey</B>(<A HREF="../../../../com/sleepycat/bind/tuple/TupleInput.html" title="class in com.sleepycat.bind.tuple">TupleInput</A> primaryKeyInput, 251 <A HREF="../../../../com/sleepycat/bind/serial/TupleSerialMarshalledKeyCreator.html" title="type parameter in TupleSerialMarshalledKeyCreator">D</A> dataInput, 252 <A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</A> indexKeyOutput)</PRE> 253<DL> 254<DD><B>Description copied from class: <CODE><A HREF="../../../../com/sleepycat/bind/serial/TupleSerialKeyCreator.html#createSecondaryKey(com.sleepycat.bind.tuple.TupleInput, D, com.sleepycat.bind.tuple.TupleOutput)">TupleSerialKeyCreator</A></CODE></B></DD> 255<DD>Creates the index key entry from primary key tuple entry and 256 deserialized data entry. 257<P> 258<DD><DL> 259<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/sleepycat/bind/serial/TupleSerialKeyCreator.html#createSecondaryKey(com.sleepycat.bind.tuple.TupleInput, D, com.sleepycat.bind.tuple.TupleOutput)">createSecondaryKey</A></CODE> in class <CODE><A HREF="../../../../com/sleepycat/bind/serial/TupleSerialKeyCreator.html" title="class in com.sleepycat.bind.serial">TupleSerialKeyCreator</A><<A HREF="../../../../com/sleepycat/bind/serial/TupleSerialMarshalledKeyCreator.html" title="type parameter in TupleSerialMarshalledKeyCreator">D</A> extends <A HREF="../../../../com/sleepycat/bind/tuple/MarshalledTupleKeyEntity.html" title="interface in com.sleepycat.bind.tuple">MarshalledTupleKeyEntity</A>></CODE></DL> 260</DD> 261<DD><DL> 262<DT><B>Parameters:</B><DD><CODE>primaryKeyInput</CODE> - is the <A HREF="../../../../com/sleepycat/bind/tuple/TupleInput.html" title="class in com.sleepycat.bind.tuple"><CODE>TupleInput</CODE></A> for the primary key 263 entry, or null if no primary key entry is used to construct the index 264 key.<DD><CODE>dataInput</CODE> - is the deserialized data entry, or null if no data 265 entry is used to construct the index key.<DD><CODE>indexKeyOutput</CODE> - is the destination index key tuple. For index 266 keys which are optionally present, no tuple entry should be output to 267 indicate that the key is not present or null. 268<DT><B>Returns:</B><DD>true if a key was created, or false to indicate that the key is 269 not present.</DL> 270</DD> 271</DL> 272<HR> 273 274<A NAME="nullifyForeignKey(com.sleepycat.bind.tuple.MarshalledTupleKeyEntity)"><!-- --></A><A NAME="nullifyForeignKey(D)"><!-- --></A><H3> 275nullifyForeignKey</H3> 276<PRE> 277public <A HREF="../../../../com/sleepycat/bind/serial/TupleSerialMarshalledKeyCreator.html" title="type parameter in TupleSerialMarshalledKeyCreator">D</A> <B>nullifyForeignKey</B>(<A HREF="../../../../com/sleepycat/bind/serial/TupleSerialMarshalledKeyCreator.html" title="type parameter in TupleSerialMarshalledKeyCreator">D</A> dataInput)</PRE> 278<DL> 279<DD><B>Description copied from class: <CODE><A HREF="../../../../com/sleepycat/bind/serial/TupleSerialKeyCreator.html#nullifyForeignKey(D)">TupleSerialKeyCreator</A></CODE></B></DD> 280<DD>Clears the index key in the deserialized data entry. 281 282 <p>On entry the data parameter contains the index key to be cleared. It 283 should be changed by this method such that <A HREF="../../../../com/sleepycat/bind/serial/TupleSerialKeyCreator.html#createSecondaryKey(com.sleepycat.db.SecondaryDatabase, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)"><CODE>TupleSerialKeyCreator.createSecondaryKey(com.sleepycat.db.SecondaryDatabase, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)</CODE></A> 284 will return false. Other fields in the data object should remain 285 unchanged.</p> 286<P> 287<DD><DL> 288<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/sleepycat/bind/serial/TupleSerialKeyCreator.html#nullifyForeignKey(D)">nullifyForeignKey</A></CODE> in class <CODE><A HREF="../../../../com/sleepycat/bind/serial/TupleSerialKeyCreator.html" title="class in com.sleepycat.bind.serial">TupleSerialKeyCreator</A><<A HREF="../../../../com/sleepycat/bind/serial/TupleSerialMarshalledKeyCreator.html" title="type parameter in TupleSerialMarshalledKeyCreator">D</A> extends <A HREF="../../../../com/sleepycat/bind/tuple/MarshalledTupleKeyEntity.html" title="interface in com.sleepycat.bind.tuple">MarshalledTupleKeyEntity</A>></CODE></DL> 289</DD> 290<DD><DL> 291<DT><B>Parameters:</B><DD><CODE>dataInput</CODE> - is the source and destination deserialized data 292 entry. 293<DT><B>Returns:</B><DD>the destination data object, or null to indicate that the 294 key is not present and no change is necessary. The data returned may 295 be the same object passed as the data parameter or a newly created 296 object.</DL> 297</DD> 298</DL> 299<!-- ========= END OF CLASS DATA ========= --> 300<HR> 301 302 303<!-- ======= START OF BOTTOM NAVBAR ====== --> 304<A NAME="navbar_bottom"><!-- --></A> 305<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 306<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 307<TR> 308<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 309<A NAME="navbar_bottom_firstrow"><!-- --></A> 310<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 311 <TR ALIGN="center" VALIGN="top"> 312 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 313 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 314 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 315 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/TupleSerialMarshalledKeyCreator.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 316 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 317 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 318 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 319 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 320 </TR> 321</TABLE> 322</TD> 323<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 324<b>Berkeley DB</b><br><font size="-1"> version 4.8.30</font></EM> 325</TD> 326</TR> 327 328<TR> 329<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 330 <A HREF="../../../../com/sleepycat/bind/serial/TupleSerialMarshalledBinding.html" title="class in com.sleepycat.bind.serial"><B>PREV CLASS</B></A> 331 NEXT CLASS</FONT></TD> 332<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 333 <A HREF="../../../../index.html?com/sleepycat/bind/serial/TupleSerialMarshalledKeyCreator.html" target="_top"><B>FRAMES</B></A> 334 <A HREF="TupleSerialMarshalledKeyCreator.html" target="_top"><B>NO FRAMES</B></A> 335 <SCRIPT type="text/javascript"> 336 <!-- 337 if(window==top) { 338 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 339 } 340 //--> 341</SCRIPT> 342<NOSCRIPT> 343 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 344</NOSCRIPT> 345 346 347</FONT></TD> 348</TR> 349<TR> 350<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 351 SUMMARY: NESTED | <A HREF="#fields_inherited_from_class_com.sleepycat.bind.serial.TupleSerialKeyCreator">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 352<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 353DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 354</TR> 355</TABLE> 356<A NAME="skip-navbar_bottom"></A> 357<!-- ======== END OF BOTTOM NAVBAR ======= --> 358 359<HR> 360<font size=1>Copyright (c) 1996-2009 Oracle. All rights reserved.</font> 361</BODY> 362</HTML> 363
