<!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_0) on Wed Dec 30 04:50:28 EST 2009 --> <TITLE> EntityOutput </TITLE> <META NAME="date" CONTENT="2009-12-30"> <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="EntityOutput"; } } </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/persist/impl/EntityInput.html" title="interface in com.sleepycat.persist.impl"><B>PREV CLASS</B></A> <A HREF="../../../../com/sleepycat/persist/impl/EnumFormat.html" title="class in com.sleepycat.persist.impl"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?com/sleepycat/persist/impl/EntityOutput.html" target="_top"><B>FRAMES</B></A> <A HREF="EntityOutput.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.persist.impl</FONT> <BR> Interface EntityOutput</H2> <HR> <DL> <DT><PRE>public interface <B>EntityOutput</B></DL> </PRE> <P> Used for writing object fields. <p>Unlike TupleOutput, Strings should be passed to <A HREF="../../../../com/sleepycat/persist/impl/EntityOutput.html#writeObject(java.lang.Object, com.sleepycat.persist.impl.Format)"><CODE>writeObject(java.lang.Object, com.sleepycat.persist.impl.Format)</CODE></A> when using this class.</p> <p>Note that currently there is only one implementation of EntityOutput: RecordOutput. There is no RawObjectOutput implemention because we currently have no need to convert from persistent objects to RawObject instances. The EntityOutput interface is only for symmetry with EntityInput and in case we need RawObjectOutput in the future.</p> <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> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/persist/impl/EntityOutput.html#registerPriKeyObject(java.lang.Object)">registerPriKeyObject</A></B>(java.lang.Object o)</CODE> <BR> Called via Accessor.writeSecKeyFields for a primary key field with a reference type.</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/persist/impl/EntityOutput.html#writeArrayLength(int)">writeArrayLength</A></B>(int length)</CODE> <BR> Called by ObjectArrayFormat and PrimitiveArrayFormat to write the array length.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/persist/impl/EntityOutput.html#writeBigInteger(java.math.BigInteger)">writeBigInteger</A></B>(java.math.BigInteger val)</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/persist/impl/EntityOutput.html#writeBoolean(boolean)">writeBoolean</A></B>(boolean val)</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/persist/impl/EntityOutput.html#writeByte(int)">writeByte</A></B>(int val)</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/persist/impl/EntityOutput.html#writeChar(int)">writeChar</A></B>(int val)</CODE> <BR> </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/persist/impl/EntityOutput.html#writeEnumConstant(java.lang.String[], int)">writeEnumConstant</A></B>(java.lang.String[] names, int index)</CODE> <BR> Called by EnumFormat to write the given index of the enum constant.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/persist/impl/EntityOutput.html#writeInt(int)">writeInt</A></B>(int val)</CODE> <BR> </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/persist/impl/EntityOutput.html#writeKeyObject(java.lang.Object, com.sleepycat.persist.impl.Format)">writeKeyObject</A></B>(java.lang.Object o, <A HREF="../../../../com/sleepycat/persist/impl/Format.html" title="class in com.sleepycat.persist.impl">Format</A> fieldFormat)</CODE> <BR> Called for a primary key field or composite key field with a reference type.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/persist/impl/EntityOutput.html#writeLong(long)">writeLong</A></B>(long val)</CODE> <BR> </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/persist/impl/EntityOutput.html#writeObject(java.lang.Object, com.sleepycat.persist.impl.Format)">writeObject</A></B>(java.lang.Object o, <A HREF="../../../../com/sleepycat/persist/impl/Format.html" title="class in com.sleepycat.persist.impl">Format</A> fieldFormat)</CODE> <BR> Called via Accessor to write all fields with reference types, except for the primary key field and composite key fields (see writeKeyObject below).</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/persist/impl/EntityOutput.html#writeShort(int)">writeShort</A></B>(int val)</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/persist/impl/EntityOutput.html#writeSortedDouble(double)">writeSortedDouble</A></B>(double val)</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/persist/impl/EntityOutput.html#writeSortedFloat(float)">writeSortedFloat</A></B>(float val)</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/persist/impl/EntityOutput.html#writeString(java.lang.String)">writeString</A></B>(java.lang.String val)</CODE> <BR> </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="writeObject(java.lang.Object, com.sleepycat.persist.impl.Format)"><!-- --></A><H3> writeObject</H3> <PRE> void <B>writeObject</B>(java.lang.Object o, <A HREF="../../../../com/sleepycat/persist/impl/Format.html" title="class in com.sleepycat.persist.impl">Format</A> fieldFormat)</PRE> <DL> <DD>Called via Accessor to write all fields with reference types, except for the primary key field and composite key fields (see writeKeyObject below). <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="writeKeyObject(java.lang.Object, com.sleepycat.persist.impl.Format)"><!-- --></A><H3> writeKeyObject</H3> <PRE> void <B>writeKeyObject</B>(java.lang.Object o, <A HREF="../../../../com/sleepycat/persist/impl/Format.html" title="class in com.sleepycat.persist.impl">Format</A> fieldFormat)</PRE> <DL> <DD>Called for a primary key field or composite key field with a reference type. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="registerPriKeyObject(java.lang.Object)"><!-- --></A><H3> registerPriKeyObject</H3> <PRE> void <B>registerPriKeyObject</B>(java.lang.Object o)</PRE> <DL> <DD>Called via Accessor.writeSecKeyFields for a primary key field with a reference type. This method must be called before writing any other fields. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="writeArrayLength(int)"><!-- --></A><H3> writeArrayLength</H3> <PRE> void <B>writeArrayLength</B>(int length)</PRE> <DL> <DD>Called by ObjectArrayFormat and PrimitiveArrayFormat to write the array length. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="writeEnumConstant(java.lang.String[], int)"><!-- --></A><H3> writeEnumConstant</H3> <PRE> void <B>writeEnumConstant</B>(java.lang.String[] names, int index)</PRE> <DL> <DD>Called by EnumFormat to write the given index of the enum constant. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="writeString(java.lang.String)"><!-- --></A><H3> writeString</H3> <PRE> <A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</A> <B>writeString</B>(java.lang.String val)</PRE> <DL> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="writeChar(int)"><!-- --></A><H3> writeChar</H3> <PRE> <A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</A> <B>writeChar</B>(int val)</PRE> <DL> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="writeBoolean(boolean)"><!-- --></A><H3> writeBoolean</H3> <PRE> <A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</A> <B>writeBoolean</B>(boolean val)</PRE> <DL> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="writeByte(int)"><!-- --></A><H3> writeByte</H3> <PRE> <A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</A> <B>writeByte</B>(int val)</PRE> <DL> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="writeShort(int)"><!-- --></A><H3> writeShort</H3> <PRE> <A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</A> <B>writeShort</B>(int val)</PRE> <DL> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="writeInt(int)"><!-- --></A><H3> writeInt</H3> <PRE> <A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</A> <B>writeInt</B>(int val)</PRE> <DL> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="writeLong(long)"><!-- --></A><H3> writeLong</H3> <PRE> <A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</A> <B>writeLong</B>(long val)</PRE> <DL> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="writeSortedFloat(float)"><!-- --></A><H3> writeSortedFloat</H3> <PRE> <A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</A> <B>writeSortedFloat</B>(float val)</PRE> <DL> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="writeSortedDouble(double)"><!-- --></A><H3> writeSortedDouble</H3> <PRE> <A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</A> <B>writeSortedDouble</B>(double val)</PRE> <DL> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="writeBigInteger(java.math.BigInteger)"><!-- --></A><H3> writeBigInteger</H3> <PRE> <A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</A> <B>writeBigInteger</B>(java.math.BigInteger val)</PRE> <DL> <DD><DL> </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/persist/impl/EntityInput.html" title="interface in com.sleepycat.persist.impl"><B>PREV CLASS</B></A> <A HREF="../../../../com/sleepycat/persist/impl/EnumFormat.html" title="class in com.sleepycat.persist.impl"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?com/sleepycat/persist/impl/EntityOutput.html" target="_top"><B>FRAMES</B></A> <A HREF="EntityOutput.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>