<!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 May 12 21:54:55 GMT 2011 --> <TITLE> EntityInput </TITLE> <META NAME="date" CONTENT="2011-05-12"> <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="EntityInput"; } } </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/EnhancedAccessor.html" title="class in com.sleepycat.persist.impl"><B>PREV CLASS</B></A> <A HREF="../../../../com/sleepycat/persist/impl/EntityOutput.html" title="interface 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/EntityInput.html" target="_top"><B>FRAMES</B></A> <A HREF="EntityInput.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 EntityInput</H2> <HR> <DL> <DT><PRE>public interface <B>EntityInput</B></DL> </PRE> <P> Used for reading object fields. <p>Unlike TupleInput, Strings are returned by <A HREF="../../../../com/sleepycat/persist/impl/EntityInput.html#readObject()"><CODE>readObject()</CODE></A> when using this class.</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> com.sleepycat.persist.impl.Catalog</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/persist/impl/EntityInput.html#getCatalog()">getCatalog</A></B>()</CODE> <BR> Returns the Catalog associated with this input.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/persist/impl/EntityInput.html#isRawAccess()">isRawAccess</A></B>()</CODE> <BR> Return whether this input is in raw mode, i.e., whether it is returning raw instances.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/persist/impl/EntityInput.html#readArrayLength()">readArrayLength</A></B>()</CODE> <BR> Called by ObjectArrayFormat and PrimitiveArrayFormat to read the array length.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.math.BigInteger</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/persist/impl/EntityInput.html#readBigInteger()">readBigInteger</A></B>()</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/persist/impl/EntityInput.html#readBoolean()">readBoolean</A></B>()</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> byte</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/persist/impl/EntityInput.html#readByte()">readByte</A></B>()</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> char</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/persist/impl/EntityInput.html#readChar()">readChar</A></B>()</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/persist/impl/EntityInput.html#readEnumConstant(java.lang.String[])">readEnumConstant</A></B>(java.lang.String[] names)</CODE> <BR> Called by EnumFormat to read and return index of the enum constant.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/persist/impl/EntityInput.html#readInt()">readInt</A></B>()</CODE> <BR> </TD> </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/persist/impl/EntityInput.html#readKeyObject(com.sleepycat.persist.impl.Format)">readKeyObject</A></B>(<A HREF="../../../../com/sleepycat/persist/impl/Format.html" title="class in com.sleepycat.persist.impl">Format</A> format)</CODE> <BR> Called for a primary key field or a 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> long</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/persist/impl/EntityInput.html#readLong()">readLong</A></B>()</CODE> <BR> </TD> </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/persist/impl/EntityInput.html#readObject()">readObject</A></B>()</CODE> <BR> Called via Accessor to read all fields with reference types, except for the primary key field and composite key fields (see readKeyObject below).</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> short</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/persist/impl/EntityInput.html#readShort()">readShort</A></B>()</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> double</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/persist/impl/EntityInput.html#readSortedDouble()">readSortedDouble</A></B>()</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> float</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/persist/impl/EntityInput.html#readSortedFloat()">readSortedFloat</A></B>()</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/persist/impl/EntityInput.html#readString()">readString</A></B>()</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/EntityInput.html#registerPriKeyObject(java.lang.Object)">registerPriKeyObject</A></B>(java.lang.Object o)</CODE> <BR> Called via Accessor.readSecKeyFields 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> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/persist/impl/EntityInput.html#setRawAccess(boolean)">setRawAccess</A></B>(boolean rawAccessParam)</CODE> <BR> Changes raw mode and returns the original mode, which is normally restored later.</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/EntityInput.html#skipField(com.sleepycat.persist.impl.Format)">skipField</A></B>(<A HREF="../../../../com/sleepycat/persist/impl/Format.html" title="class in com.sleepycat.persist.impl">Format</A> declaredFormat)</CODE> <BR> Called via PersistKeyCreator to skip fields prior to the secondary key field.</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="getCatalog()"><!-- --></A><H3> getCatalog</H3> <PRE> com.sleepycat.persist.impl.Catalog <B>getCatalog</B>()</PRE> <DL> <DD>Returns the Catalog associated with this input. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="isRawAccess()"><!-- --></A><H3> isRawAccess</H3> <PRE> boolean <B>isRawAccess</B>()</PRE> <DL> <DD>Return whether this input is in raw mode, i.e., whether it is returning raw instances. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="setRawAccess(boolean)"><!-- --></A><H3> setRawAccess</H3> <PRE> boolean <B>setRawAccess</B>(boolean rawAccessParam)</PRE> <DL> <DD>Changes raw mode and returns the original mode, which is normally restored later. For temporarily changing the mode during a conversion. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="readObject()"><!-- --></A><H3> readObject</H3> <PRE> java.lang.Object <B>readObject</B>()</PRE> <DL> <DD>Called via Accessor to read all fields with reference types, except for the primary key field and composite key fields (see readKeyObject below). <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="readKeyObject(com.sleepycat.persist.impl.Format)"><!-- --></A><H3> readKeyObject</H3> <PRE> java.lang.Object <B>readKeyObject</B>(<A HREF="../../../../com/sleepycat/persist/impl/Format.html" title="class in com.sleepycat.persist.impl">Format</A> format)</PRE> <DL> <DD>Called for a primary key field or a composite key field with a reference type. <p>For such key fields, no formatId is present nor can the object already be present in the visited object set.</p> <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.readSecKeyFields for a primary key field with a reference type. This method must be called before reading any other fields. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="readArrayLength()"><!-- --></A><H3> readArrayLength</H3> <PRE> int <B>readArrayLength</B>()</PRE> <DL> <DD>Called by ObjectArrayFormat and PrimitiveArrayFormat to read the array length. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="readEnumConstant(java.lang.String[])"><!-- --></A><H3> readEnumConstant</H3> <PRE> int <B>readEnumConstant</B>(java.lang.String[] names)</PRE> <DL> <DD>Called by EnumFormat to read and return index of the enum constant. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="skipField(com.sleepycat.persist.impl.Format)"><!-- --></A><H3> skipField</H3> <PRE> void <B>skipField</B>(<A HREF="../../../../com/sleepycat/persist/impl/Format.html" title="class in com.sleepycat.persist.impl">Format</A> declaredFormat)</PRE> <DL> <DD>Called via PersistKeyCreator to skip fields prior to the secondary key field. Also called during class evolution so skip deleted fields. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="readString()"><!-- --></A><H3> readString</H3> <PRE> java.lang.String <B>readString</B>()</PRE> <DL> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="readChar()"><!-- --></A><H3> readChar</H3> <PRE> char <B>readChar</B>()</PRE> <DL> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="readBoolean()"><!-- --></A><H3> readBoolean</H3> <PRE> boolean <B>readBoolean</B>()</PRE> <DL> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="readByte()"><!-- --></A><H3> readByte</H3> <PRE> byte <B>readByte</B>()</PRE> <DL> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="readShort()"><!-- --></A><H3> readShort</H3> <PRE> short <B>readShort</B>()</PRE> <DL> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="readInt()"><!-- --></A><H3> readInt</H3> <PRE> int <B>readInt</B>()</PRE> <DL> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="readLong()"><!-- --></A><H3> readLong</H3> <PRE> long <B>readLong</B>()</PRE> <DL> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="readSortedFloat()"><!-- --></A><H3> readSortedFloat</H3> <PRE> float <B>readSortedFloat</B>()</PRE> <DL> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="readSortedDouble()"><!-- --></A><H3> readSortedDouble</H3> <PRE> double <B>readSortedDouble</B>()</PRE> <DL> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="readBigInteger()"><!-- --></A><H3> readBigInteger</H3> <PRE> java.math.BigInteger <B>readBigInteger</B>()</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/EnhancedAccessor.html" title="class in com.sleepycat.persist.impl"><B>PREV CLASS</B></A> <A HREF="../../../../com/sleepycat/persist/impl/EntityOutput.html" title="interface 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/EntityInput.html" target="_top"><B>FRAMES</B></A> <A HREF="EntityInput.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>