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