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> 7MarshalledTupleKeyEntity (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="MarshalledTupleKeyEntity (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/MarshalledTupleKeyEntity.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/tuple/MarshalledTupleEntry.html" title="interface in com.sleepycat.bind.tuple"><B>PREV CLASS</B></A> 59 <A HREF="../../../../com/sleepycat/bind/tuple/ShortBinding.html" title="class in com.sleepycat.bind.tuple"><B>NEXT CLASS</B></A></FONT></TD> 60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 61 <A HREF="../../../../index.html?com/sleepycat/bind/tuple/MarshalledTupleKeyEntity.html" target="_top"><B>FRAMES</B></A> 62 <A HREF="MarshalledTupleKeyEntity.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 | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> 80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 81DETAIL: FIELD | CONSTR | <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.tuple</FONT> 92<BR> 93Interface MarshalledTupleKeyEntity</H2> 94<HR> 95<DL> 96<DT><PRE>public interface <B>MarshalledTupleKeyEntity</B></DL> 97</PRE> 98 99<P> 100A marshalling interface implemented by entity classes that represent keys as 101 tuples. Since <code>MarshalledTupleKeyEntity</code> objects are instantiated 102 using Java deserialization, no particular constructor is required by classes 103 that implement this interface. 104 105 <p>Note that a marshalled tuple key extractor is somewhat less efficient 106 than a non-marshalled key tuple extractor because more conversions are 107 needed. A marshalled key extractor must convert the entry to an object in 108 order to extract the key fields, while an unmarshalled key extractor does 109 not.</p> 110<P> 111 112<P> 113<DL> 114<DT><B>See Also:</B><DD><A HREF="../../../../com/sleepycat/bind/tuple/TupleTupleMarshalledBinding.html" title="class in com.sleepycat.bind.tuple"><CODE>TupleTupleMarshalledBinding</CODE></A>, 115<A HREF="../../../../com/sleepycat/bind/serial/TupleSerialMarshalledBinding.html" title="class in com.sleepycat.bind.serial"><CODE>TupleSerialMarshalledBinding</CODE></A></DL> 116<HR> 117 118<P> 119 120<!-- ========== METHOD SUMMARY =========== --> 121 122<A NAME="method_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>Method Summary</B></FONT></TH> 127</TR> 128<TR BGCOLOR="white" CLASS="TableRowColor"> 129<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 130<CODE> void</CODE></FONT></TD> 131<TD><CODE><B><A HREF="../../../../com/sleepycat/bind/tuple/MarshalledTupleKeyEntity.html#marshalPrimaryKey(com.sleepycat.bind.tuple.TupleOutput)">marshalPrimaryKey</A></B>(<A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</A> keyOutput)</CODE> 132 133<BR> 134 Extracts the entity's primary key and writes it to the key output.</TD> 135</TR> 136<TR BGCOLOR="white" CLASS="TableRowColor"> 137<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 138<CODE> boolean</CODE></FONT></TD> 139<TD><CODE><B><A HREF="../../../../com/sleepycat/bind/tuple/MarshalledTupleKeyEntity.html#marshalSecondaryKey(java.lang.String, com.sleepycat.bind.tuple.TupleOutput)">marshalSecondaryKey</A></B>(<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, 140 <A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</A> keyOutput)</CODE> 141 142<BR> 143 Extracts the entity's secondary key and writes it to the key output.</TD> 144</TR> 145<TR BGCOLOR="white" CLASS="TableRowColor"> 146<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 147<CODE> boolean</CODE></FONT></TD> 148<TD><CODE><B><A HREF="../../../../com/sleepycat/bind/tuple/MarshalledTupleKeyEntity.html#nullifyForeignKey(java.lang.String)">nullifyForeignKey</A></B>(<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> 149 150<BR> 151 Clears the entity's secondary key fields for the given key name.</TD> 152</TR> 153<TR BGCOLOR="white" CLASS="TableRowColor"> 154<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 155<CODE> void</CODE></FONT></TD> 156<TD><CODE><B><A HREF="../../../../com/sleepycat/bind/tuple/MarshalledTupleKeyEntity.html#unmarshalPrimaryKey(com.sleepycat.bind.tuple.TupleInput)">unmarshalPrimaryKey</A></B>(<A HREF="../../../../com/sleepycat/bind/tuple/TupleInput.html" title="class in com.sleepycat.bind.tuple">TupleInput</A> keyInput)</CODE> 157 158<BR> 159 Completes construction of the entity by setting its primary key from the 160 stored primary key.</TD> 161</TR> 162</TABLE> 163 164<P> 165 166<!-- ============ METHOD DETAIL ========== --> 167 168<A NAME="method_detail"><!-- --></A> 169<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 170<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 171<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 172<B>Method Detail</B></FONT></TH> 173</TR> 174</TABLE> 175 176<A NAME="marshalPrimaryKey(com.sleepycat.bind.tuple.TupleOutput)"><!-- --></A><H3> 177marshalPrimaryKey</H3> 178<PRE> 179void <B>marshalPrimaryKey</B>(<A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</A> keyOutput)</PRE> 180<DL> 181<DD>Extracts the entity's primary key and writes it to the key output. 182<P> 183<DD><DL> 184<DT><B>Parameters:</B><DD><CODE>keyOutput</CODE> - is the output tuple.</DL> 185</DD> 186</DL> 187<HR> 188 189<A NAME="unmarshalPrimaryKey(com.sleepycat.bind.tuple.TupleInput)"><!-- --></A><H3> 190unmarshalPrimaryKey</H3> 191<PRE> 192void <B>unmarshalPrimaryKey</B>(<A HREF="../../../../com/sleepycat/bind/tuple/TupleInput.html" title="class in com.sleepycat.bind.tuple">TupleInput</A> keyInput)</PRE> 193<DL> 194<DD>Completes construction of the entity by setting its primary key from the 195 stored primary key. 196<P> 197<DD><DL> 198<DT><B>Parameters:</B><DD><CODE>keyInput</CODE> - is the input tuple.</DL> 199</DD> 200</DL> 201<HR> 202 203<A NAME="marshalSecondaryKey(java.lang.String, com.sleepycat.bind.tuple.TupleOutput)"><!-- --></A><H3> 204marshalSecondaryKey</H3> 205<PRE> 206boolean <B>marshalSecondaryKey</B>(<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, 207 <A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</A> keyOutput)</PRE> 208<DL> 209<DD>Extracts the entity's secondary key and writes it to the key output. 210<P> 211<DD><DL> 212<DT><B>Parameters:</B><DD><CODE>keyName</CODE> - identifies the secondary key.<DD><CODE>keyOutput</CODE> - is the output tuple. 213<DT><B>Returns:</B><DD>true if a key was created, or false to indicate that the key is 214 not present.</DL> 215</DD> 216</DL> 217<HR> 218 219<A NAME="nullifyForeignKey(java.lang.String)"><!-- --></A><H3> 220nullifyForeignKey</H3> 221<PRE> 222boolean <B>nullifyForeignKey</B>(<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> 223<DL> 224<DD>Clears the entity's secondary key fields for the given key name. 225 226 <p>The specified index key should be changed by this method such that 227 <A HREF="../../../../com/sleepycat/bind/tuple/MarshalledTupleKeyEntity.html#marshalSecondaryKey(java.lang.String, com.sleepycat.bind.tuple.TupleOutput)"><CODE>marshalSecondaryKey(java.lang.String, com.sleepycat.bind.tuple.TupleOutput)</CODE></A> for the same key name will return false. 228 Other fields in the data object should remain unchanged.</p> 229 230 <p>If <A HREF="../../../../com/sleepycat/db/ForeignKeyDeleteAction.html#NULLIFY"><CODE>ForeignKeyDeleteAction.NULLIFY</CODE></A> was 231 specified when opening the secondary database, this method is called 232 when the entity for this foreign key is deleted. If NULLIFY was not 233 specified, this method will not be called and may always return 234 false.</p> 235<P> 236<DD><DL> 237<DT><B>Parameters:</B><DD><CODE>keyName</CODE> - identifies the secondary key. 238<DT><B>Returns:</B><DD>true if the key was cleared, or false to indicate that the key 239 is not present and no change is necessary.</DL> 240</DD> 241</DL> 242<!-- ========= END OF CLASS DATA ========= --> 243<HR> 244 245 246<!-- ======= START OF BOTTOM NAVBAR ====== --> 247<A NAME="navbar_bottom"><!-- --></A> 248<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 249<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 250<TR> 251<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 252<A NAME="navbar_bottom_firstrow"><!-- --></A> 253<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 254 <TR ALIGN="center" VALIGN="top"> 255 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 256 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 257 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 258 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/MarshalledTupleKeyEntity.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 259 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 260 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 261 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 262 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 263 </TR> 264</TABLE> 265</TD> 266<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 267<b>Berkeley DB</b><br><font size="-1"> version 4.8.30</font></EM> 268</TD> 269</TR> 270 271<TR> 272<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 273 <A HREF="../../../../com/sleepycat/bind/tuple/MarshalledTupleEntry.html" title="interface in com.sleepycat.bind.tuple"><B>PREV CLASS</B></A> 274 <A HREF="../../../../com/sleepycat/bind/tuple/ShortBinding.html" title="class in com.sleepycat.bind.tuple"><B>NEXT CLASS</B></A></FONT></TD> 275<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 276 <A HREF="../../../../index.html?com/sleepycat/bind/tuple/MarshalledTupleKeyEntity.html" target="_top"><B>FRAMES</B></A> 277 <A HREF="MarshalledTupleKeyEntity.html" target="_top"><B>NO FRAMES</B></A> 278 <SCRIPT type="text/javascript"> 279 <!-- 280 if(window==top) { 281 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 282 } 283 //--> 284</SCRIPT> 285<NOSCRIPT> 286 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 287</NOSCRIPT> 288 289 290</FONT></TD> 291</TR> 292<TR> 293<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 294 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> 295<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 296DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> 297</TR> 298</TABLE> 299<A NAME="skip-navbar_bottom"></A> 300<!-- ======== END OF BOTTOM NAVBAR ======= --> 301 302<HR> 303<font size=1>Copyright (c) 1996-2009 Oracle. All rights reserved.</font> 304</BODY> 305</HTML> 306