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