<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!--NewPage--> <HTML> <HEAD> <!-- Generated by javadoc (build 1.6.0_18) on Thu Dec 02 16:59:38 UTC 2010 --> <TITLE> EntityBinding </TITLE> <META NAME="date" CONTENT="2010-12-02"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> <SCRIPT type="text/javascript"> function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { parent.document.title="EntityBinding"; } } </SCRIPT> <NOSCRIPT> </NOSCRIPT> </HEAD> <BODY BGCOLOR="white" onload="windowTitle();"> <HR> <!-- ========= START OF TOP NAVBAR ======= --> <A NAME="navbar_top"><!-- --></A> <A HREF="#skip-navbar_top" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_top_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../com/sleepycat/bdb/bind/DataType.html" title="interface in com.sleepycat.bdb.bind"><B>PREV CLASS</B></A> <A HREF="../../../../com/sleepycat/bdb/bind/KeyExtractor.html" title="interface in com.sleepycat.bdb.bind"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?com/sleepycat/bdb/bind/EntityBinding.html" target="_top"><B>FRAMES</B></A> <A HREF="EntityBinding.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_top"></A> <!-- ========= END OF TOP NAVBAR ========= --> <HR> <!-- ======== START OF CLASS DATA ======== --> <H2> <FONT SIZE="-1"> com.sleepycat.bdb.bind</FONT> <BR> Interface EntityBinding</H2> <DL> <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../com/sleepycat/bdb/bind/serial/SerialSerialBinding.html" title="class in com.sleepycat.bdb.bind.serial">SerialSerialBinding</A>, <A HREF="../../../../com/sleepycat/bdb/bind/serial/TupleSerialBinding.html" title="class in com.sleepycat.bdb.bind.serial">TupleSerialBinding</A>, <A HREF="../../../../com/sleepycat/bdb/bind/serial/TupleSerialMarshalledBinding.html" title="class in com.sleepycat.bdb.bind.serial">TupleSerialMarshalledBinding</A>, <A HREF="../../../../com/sleepycat/bdb/bind/tuple/TupleTupleBinding.html" title="class in com.sleepycat.bdb.bind.tuple">TupleTupleBinding</A>, <A HREF="../../../../com/sleepycat/bdb/bind/tuple/TupleTupleMarshalledBinding.html" title="class in com.sleepycat.bdb.bind.tuple">TupleTupleMarshalledBinding</A></DD> </DL> <HR> <DL> <DT><PRE>public interface <B>EntityBinding</B></DL> </PRE> <P> The interface implemented by all entity or key/data-to-object bindings. <P> <P> <HR> <P> <!-- ========== METHOD SUMMARY =========== --> <A NAME="method_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Method Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.lang.Object</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/bdb/bind/EntityBinding.html#dataToObject(com.sleepycat.bdb.bind.DataBuffer, com.sleepycat.bdb.bind.DataBuffer)">dataToObject</A></B>(<A HREF="../../../../com/sleepycat/bdb/bind/DataBuffer.html" title="interface in com.sleepycat.bdb.bind">DataBuffer</A> key, <A HREF="../../../../com/sleepycat/bdb/bind/DataBuffer.html" title="interface in com.sleepycat.bdb.bind">DataBuffer</A> value)</CODE> <BR> Converts key and value data buffers into an entity Object.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../com/sleepycat/bdb/bind/DataFormat.html" title="interface in com.sleepycat.bdb.bind">DataFormat</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/bdb/bind/EntityBinding.html#getKeyFormat()">getKeyFormat</A></B>()</CODE> <BR> Returns the format used for the key data of this binding.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../com/sleepycat/bdb/bind/DataFormat.html" title="interface in com.sleepycat.bdb.bind">DataFormat</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/bdb/bind/EntityBinding.html#getValueFormat()">getValueFormat</A></B>()</CODE> <BR> Returns the format used for the value data of this binding.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/bdb/bind/EntityBinding.html#objectToKey(java.lang.Object, com.sleepycat.bdb.bind.DataBuffer)">objectToKey</A></B>(java.lang.Object object, <A HREF="../../../../com/sleepycat/bdb/bind/DataBuffer.html" title="interface in com.sleepycat.bdb.bind">DataBuffer</A> key)</CODE> <BR> Extracts the key data from an entity Object.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/bdb/bind/EntityBinding.html#objectToValue(java.lang.Object, com.sleepycat.bdb.bind.DataBuffer)">objectToValue</A></B>(java.lang.Object object, <A HREF="../../../../com/sleepycat/bdb/bind/DataBuffer.html" title="interface in com.sleepycat.bdb.bind">DataBuffer</A> value)</CODE> <BR> Extracts the value data from an entity Object.</TD> </TR> </TABLE> <P> <!-- ============ METHOD DETAIL ========== --> <A NAME="method_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Method Detail</B></FONT></TH> </TR> </TABLE> <A NAME="dataToObject(com.sleepycat.bdb.bind.DataBuffer, com.sleepycat.bdb.bind.DataBuffer)"><!-- --></A><H3> dataToObject</H3> <PRE> java.lang.Object <B>dataToObject</B>(<A HREF="../../../../com/sleepycat/bdb/bind/DataBuffer.html" title="interface in com.sleepycat.bdb.bind">DataBuffer</A> key, <A HREF="../../../../com/sleepycat/bdb/bind/DataBuffer.html" title="interface in com.sleepycat.bdb.bind">DataBuffer</A> value) throws java.io.IOException</PRE> <DL> <DD>Converts key and value data buffers into an entity Object. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>key</CODE> - is the source key data.<DD><CODE>value</CODE> - is the source value data. <DT><B>Returns:</B><DD>the resulting Object. <DT><B>Throws:</B> <DD><CODE>java.io.IOException</CODE></DL> </DD> </DL> <HR> <A NAME="objectToKey(java.lang.Object, com.sleepycat.bdb.bind.DataBuffer)"><!-- --></A><H3> objectToKey</H3> <PRE> void <B>objectToKey</B>(java.lang.Object object, <A HREF="../../../../com/sleepycat/bdb/bind/DataBuffer.html" title="interface in com.sleepycat.bdb.bind">DataBuffer</A> key) throws java.io.IOException</PRE> <DL> <DD>Extracts the key data from an entity Object. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>object</CODE> - is the source Object.<DD><CODE>key</CODE> - is the destination data buffer. <DT><B>Throws:</B> <DD><CODE>java.io.IOException</CODE></DL> </DD> </DL> <HR> <A NAME="objectToValue(java.lang.Object, com.sleepycat.bdb.bind.DataBuffer)"><!-- --></A><H3> objectToValue</H3> <PRE> void <B>objectToValue</B>(java.lang.Object object, <A HREF="../../../../com/sleepycat/bdb/bind/DataBuffer.html" title="interface in com.sleepycat.bdb.bind">DataBuffer</A> value) throws java.io.IOException</PRE> <DL> <DD>Extracts the value data from an entity Object. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>object</CODE> - is the source Object.<DD><CODE>value</CODE> - is the destination data buffer. <DT><B>Throws:</B> <DD><CODE>java.io.IOException</CODE></DL> </DD> </DL> <HR> <A NAME="getKeyFormat()"><!-- --></A><H3> getKeyFormat</H3> <PRE> <A HREF="../../../../com/sleepycat/bdb/bind/DataFormat.html" title="interface in com.sleepycat.bdb.bind">DataFormat</A> <B>getKeyFormat</B>()</PRE> <DL> <DD>Returns the format used for the key data of this binding. <P> <DD><DL> <DT><B>Returns:</B><DD>the key data format.</DL> </DD> </DL> <HR> <A NAME="getValueFormat()"><!-- --></A><H3> getValueFormat</H3> <PRE> <A HREF="../../../../com/sleepycat/bdb/bind/DataFormat.html" title="interface in com.sleepycat.bdb.bind">DataFormat</A> <B>getValueFormat</B>()</PRE> <DL> <DD>Returns the format used for the value data of this binding. <P> <DD><DL> <DT><B>Returns:</B><DD>the value data format.</DL> </DD> </DL> <!-- ========= END OF CLASS DATA ========= --> <HR> <!-- ======= START OF BOTTOM NAVBAR ====== --> <A NAME="navbar_bottom"><!-- --></A> <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_bottom_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../com/sleepycat/bdb/bind/DataType.html" title="interface in com.sleepycat.bdb.bind"><B>PREV CLASS</B></A> <A HREF="../../../../com/sleepycat/bdb/bind/KeyExtractor.html" title="interface in com.sleepycat.bdb.bind"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?com/sleepycat/bdb/bind/EntityBinding.html" target="_top"><B>FRAMES</B></A> <A HREF="EntityBinding.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_bottom"></A> <!-- ======== END OF BOTTOM NAVBAR ======= --> <HR> </BODY> </HTML>