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> 7EntityBinding (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="EntityBinding (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/EntityBinding.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/ByteArrayBinding.html" title="class in com.sleepycat.bind"><B>PREV CLASS</B></A> 59 <A HREF="../../../com/sleepycat/bind/EntryBinding.html" title="interface in com.sleepycat.bind"><B>NEXT CLASS</B></A></FONT></TD> 60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 61 <A HREF="../../../index.html?com/sleepycat/bind/EntityBinding.html" target="_top"><B>FRAMES</B></A> 62 <A HREF="EntityBinding.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</FONT> 92<BR> 93Interface EntityBinding<E></H2> 94<DL> 95<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../com/sleepycat/bind/serial/SerialSerialBinding.html" title="class in com.sleepycat.bind.serial">SerialSerialBinding</A>, <A HREF="../../../com/sleepycat/bind/serial/TupleSerialBinding.html" title="class in com.sleepycat.bind.serial">TupleSerialBinding</A>, <A HREF="../../../com/sleepycat/bind/serial/TupleSerialMarshalledBinding.html" title="class in com.sleepycat.bind.serial">TupleSerialMarshalledBinding</A>, <A HREF="../../../com/sleepycat/bind/tuple/TupleTupleBinding.html" title="class in com.sleepycat.bind.tuple">TupleTupleBinding</A>, <A HREF="../../../com/sleepycat/bind/tuple/TupleTupleMarshalledBinding.html" title="class in com.sleepycat.bind.tuple">TupleTupleMarshalledBinding</A></DD> 96</DL> 97<HR> 98<DL> 99<DT><PRE>public interface <B>EntityBinding<E></B></DL> 100</PRE> 101 102<P> 103A binding between a key-value entry pair and an entity object. 104 105 <p><em>WARNING:</em> Binding instances are typically shared by multiple 106 threads and binding methods are called without any special synchronization. 107 Therefore, bindings must be thread safe. In general no shared state should 108 be used and any caching of computed values must be done with proper 109 synchronization.</p> 110<P> 111 112<P> 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> <A HREF="../../../com/sleepycat/bind/EntityBinding.html" title="type parameter in EntityBinding">E</A></CODE></FONT></TD> 128<TD><CODE><B><A HREF="../../../com/sleepycat/bind/EntityBinding.html#entryToObject(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)">entryToObject</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key, 129 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data)</CODE> 130 131<BR> 132 Converts key and data entry buffers into an entity Object.</TD> 133</TR> 134<TR BGCOLOR="white" CLASS="TableRowColor"> 135<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 136<CODE> void</CODE></FONT></TD> 137<TD><CODE><B><A HREF="../../../com/sleepycat/bind/EntityBinding.html#objectToData(E, com.sleepycat.db.DatabaseEntry)">objectToData</A></B>(<A HREF="../../../com/sleepycat/bind/EntityBinding.html" title="type parameter in EntityBinding">E</A> object, 138 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data)</CODE> 139 140<BR> 141 Extracts the data entry from an entity Object.</TD> 142</TR> 143<TR BGCOLOR="white" CLASS="TableRowColor"> 144<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 145<CODE> void</CODE></FONT></TD> 146<TD><CODE><B><A HREF="../../../com/sleepycat/bind/EntityBinding.html#objectToKey(E, com.sleepycat.db.DatabaseEntry)">objectToKey</A></B>(<A HREF="../../../com/sleepycat/bind/EntityBinding.html" title="type parameter in EntityBinding">E</A> object, 147 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key)</CODE> 148 149<BR> 150 Extracts the key entry from an entity Object.</TD> 151</TR> 152</TABLE> 153 154<P> 155 156<!-- ============ METHOD DETAIL ========== --> 157 158<A NAME="method_detail"><!-- --></A> 159<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 160<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 161<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 162<B>Method Detail</B></FONT></TH> 163</TR> 164</TABLE> 165 166<A NAME="entryToObject(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)"><!-- --></A><H3> 167entryToObject</H3> 168<PRE> 169<A HREF="../../../com/sleepycat/bind/EntityBinding.html" title="type parameter in EntityBinding">E</A> <B>entryToObject</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key, 170 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data)</PRE> 171<DL> 172<DD>Converts key and data entry buffers into an entity Object. 173<P> 174<DD><DL> 175<DT><B>Parameters:</B><DD><CODE>key</CODE> - is the source key entry.<DD><CODE>data</CODE> - is the source data entry. 176<DT><B>Returns:</B><DD>the resulting Object.</DL> 177</DD> 178</DL> 179<HR> 180 181<A NAME="objectToKey(java.lang.Object,com.sleepycat.db.DatabaseEntry)"><!-- --></A><A NAME="objectToKey(E, com.sleepycat.db.DatabaseEntry)"><!-- --></A><H3> 182objectToKey</H3> 183<PRE> 184void <B>objectToKey</B>(<A HREF="../../../com/sleepycat/bind/EntityBinding.html" title="type parameter in EntityBinding">E</A> object, 185 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key)</PRE> 186<DL> 187<DD>Extracts the key entry from an entity Object. 188<P> 189<DD><DL> 190<DT><B>Parameters:</B><DD><CODE>object</CODE> - is the source Object.<DD><CODE>key</CODE> - is the destination entry buffer.</DL> 191</DD> 192</DL> 193<HR> 194 195<A NAME="objectToData(java.lang.Object,com.sleepycat.db.DatabaseEntry)"><!-- --></A><A NAME="objectToData(E, com.sleepycat.db.DatabaseEntry)"><!-- --></A><H3> 196objectToData</H3> 197<PRE> 198void <B>objectToData</B>(<A HREF="../../../com/sleepycat/bind/EntityBinding.html" title="type parameter in EntityBinding">E</A> object, 199 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data)</PRE> 200<DL> 201<DD>Extracts the data entry from an entity Object. 202<P> 203<DD><DL> 204<DT><B>Parameters:</B><DD><CODE>object</CODE> - is the source Object.<DD><CODE>data</CODE> - is the destination entry buffer.</DL> 205</DD> 206</DL> 207<!-- ========= END OF CLASS DATA ========= --> 208<HR> 209 210 211<!-- ======= START OF BOTTOM NAVBAR ====== --> 212<A NAME="navbar_bottom"><!-- --></A> 213<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 214<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 215<TR> 216<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 217<A NAME="navbar_bottom_firstrow"><!-- --></A> 218<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 219 <TR ALIGN="center" VALIGN="top"> 220 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 221 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 222 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 223 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/EntityBinding.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 224 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 225 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 226 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 227 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 228 </TR> 229</TABLE> 230</TD> 231<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 232<b>Berkeley DB</b><br><font size="-1"> version 4.8.30</font></EM> 233</TD> 234</TR> 235 236<TR> 237<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 238 <A HREF="../../../com/sleepycat/bind/ByteArrayBinding.html" title="class in com.sleepycat.bind"><B>PREV CLASS</B></A> 239 <A HREF="../../../com/sleepycat/bind/EntryBinding.html" title="interface in com.sleepycat.bind"><B>NEXT CLASS</B></A></FONT></TD> 240<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 241 <A HREF="../../../index.html?com/sleepycat/bind/EntityBinding.html" target="_top"><B>FRAMES</B></A> 242 <A HREF="EntityBinding.html" target="_top"><B>NO FRAMES</B></A> 243 <SCRIPT type="text/javascript"> 244 <!-- 245 if(window==top) { 246 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); 247 } 248 //--> 249</SCRIPT> 250<NOSCRIPT> 251 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> 252</NOSCRIPT> 253 254 255</FONT></TD> 256</TR> 257<TR> 258<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 259 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> 260<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 261DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> 262</TR> 263</TABLE> 264<A NAME="skip-navbar_bottom"></A> 265<!-- ======== END OF BOTTOM NAVBAR ======= --> 266 267<HR> 268<font size=1>Copyright (c) 1996-2009 Oracle. All rights reserved.</font> 269</BODY> 270</HTML> 271