<!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:39 UTC 2010 --> <TITLE> DataView </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="DataView"; } } </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/DataThang.html" title="class in com.sleepycat.bdb"><B>PREV CLASS</B></A> <A HREF="../../../com/sleepycat/bdb/ForeignKeyIndex.html" title="class in com.sleepycat.bdb"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../index.html?com/sleepycat/bdb/DataView.html" target="_top"><B>FRAMES</B></A> <A HREF="DataView.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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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</FONT> <BR> Class DataView</H2> <PRE> java.lang.Object <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.sleepycat.bdb.DataView</B> </PRE> <DL> <DT><B>All Implemented Interfaces:</B> <DD>java.lang.Cloneable</DD> </DL> <HR> <DL> <DT><PRE>public final class <B>DataView</B><DT>extends java.lang.Object<DT>implements java.lang.Cloneable</DL> </PRE> <P> (<em>internal</em>) Represents a Berkeley DB database and adds support for indices, bindings and key ranges. <p><b>NOTE:</b> This classes is internal and may be changed incompatibly or deleted in the future. It is public only so it may be used by subpackages.</p> <p>This class defines a view and takes care of reading and updating indices, calling bindings, constraining access to a key range, etc.</p> <P> <P> <HR> <P> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <A NAME="constructor_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>Constructor Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><B><A HREF="../../../com/sleepycat/bdb/DataView.html#DataView(com.sleepycat.bdb.DataStore, com.sleepycat.bdb.DataIndex, com.sleepycat.bdb.bind.DataBinding, com.sleepycat.bdb.bind.DataBinding, com.sleepycat.bdb.bind.EntityBinding, boolean)">DataView</A></B>(<A HREF="../../../com/sleepycat/bdb/DataStore.html" title="class in com.sleepycat.bdb">DataStore</A> store, <A HREF="../../../com/sleepycat/bdb/DataIndex.html" title="class in com.sleepycat.bdb">DataIndex</A> index, <A HREF="../../../com/sleepycat/bdb/bind/DataBinding.html" title="interface in com.sleepycat.bdb.bind">DataBinding</A> keyBinding, <A HREF="../../../com/sleepycat/bdb/bind/DataBinding.html" title="interface in com.sleepycat.bdb.bind">DataBinding</A> valueBinding, <A HREF="../../../com/sleepycat/bdb/bind/EntityBinding.html" title="interface in com.sleepycat.bdb.bind">EntityBinding</A> entityBinding, boolean writeAllowed)</CODE> <BR> Creates a view for a given store/index and bindings.</TD> </TR> </TABLE> <!-- ========== 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> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/sleepycat/bdb/DataView.html#addValue(com.sleepycat.bdb.DataThang, java.lang.Object, int)">addValue</A></B>(<A HREF="../../../com/sleepycat/bdb/DataThang.html" title="class in com.sleepycat.bdb">DataThang</A> primaryKeyThang, java.lang.Object value, int flags)</CODE> <BR> Adds a duplicate value for a specified key.</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/bdb/DataView.html#append(java.lang.Object, java.lang.Object[], java.lang.Object[])">append</A></B>(java.lang.Object value, java.lang.Object[] retPrimaryKey, java.lang.Object[] retValue)</CODE> <BR> Appends a value and returns the new key.</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/bdb/DataView.html#areDuplicatesAllowed()">areDuplicatesAllowed</A></B>()</CODE> <BR> Returns whether duplicates are allowed for the index or store.</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/bdb/DataView.html#areDuplicatesOrdered()">areDuplicatesOrdered</A></B>()</CODE> <BR> Returns whether duplicates are ordered for the index or store.</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/bdb/DataView.html#areKeysRenumbered()">areKeysRenumbered</A></B>()</CODE> <BR> Returns whether keys (record numbers) are renumbered for the index or store.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../com/sleepycat/bdb/DataView.html" title="class in com.sleepycat.bdb">DataView</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/sleepycat/bdb/DataView.html#autoCommitView(boolean)">autoCommitView</A></B>(boolean enable)</CODE> <BR> Returns a new view with a specified autoCommit setting.</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/bdb/DataView.html#canDeriveKeyFromValue()">canDeriveKeyFromValue</A></B>()</CODE> <BR> Returns whether data keys can be derived from the value/entity binding of this view, which determines whether a value/entity object alone is sufficient for operations that require keys.</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/DataView.html#clear(java.util.Collection)">clear</A></B>(java.util.Collection oldValues)</CODE> <BR> Deletes all records in the current range, optionally returning the values for the deleted records.</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/bdb/DataView.html#consume(int, java.lang.Object[], java.lang.Object[])">consume</A></B>(int flags, java.lang.Object[] retPrimaryKey, java.lang.Object[] retValue)</CODE> <BR> Performs a database 'get and consume' operation.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../com/sleepycat/bdb/DataView.html" title="class in com.sleepycat.bdb">DataView</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/sleepycat/bdb/DataView.html#dirtyReadView(boolean)">dirtyReadView</A></B>(boolean enable)</CODE> <BR> Returns a new view with a specified dirtyRead setting.</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/bdb/DataView.html#get(java.lang.Object, java.lang.Object, int, boolean, java.lang.Object[])">get</A></B>(java.lang.Object key, java.lang.Object value, int flags, boolean lockForWrite, java.lang.Object[] retValue)</CODE> <BR> Performs a general database 'get' operation.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../com/sleepycat/bdb/CurrentTransaction.html" title="class in com.sleepycat.bdb">CurrentTransaction</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/sleepycat/bdb/DataView.html#getCurrentTxn()">getCurrentTxn</A></B>()</CODE> <BR> Returns the current transaction for the view or null if the environment is non-transactional.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../com/sleepycat/bdb/DataDb.html" title="class in com.sleepycat.bdb">DataDb</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/sleepycat/bdb/DataView.html#getDb()">getDb</A></B>()</CODE> <BR> Returns the database for the index, if one is used, or store, if no index is used.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../com/sleepycat/db/DbEnv.html" title="class in com.sleepycat.db">DbEnv</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/sleepycat/bdb/DataView.html#getEnv()">getEnv</A></B>()</CODE> <BR> Returns the environment for the store and index.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../com/sleepycat/bdb/DataIndex.html" title="class in com.sleepycat.bdb">DataIndex</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/sleepycat/bdb/DataView.html#getIndex()">getIndex</A></B>()</CODE> <BR> Returns the index, as specified to the constructor.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../com/sleepycat/bdb/bind/DataBinding.html" title="interface in com.sleepycat.bdb.bind">DataBinding</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/sleepycat/bdb/DataView.html#getKeyBinding()">getKeyBinding</A></B>()</CODE> <BR> Returns the key binding that is used.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../com/sleepycat/bdb/DataThang.html" title="class in com.sleepycat.bdb">DataThang</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/sleepycat/bdb/DataView.html#getSingleKeyThang()">getSingleKeyThang</A></B>()</CODE> <BR> Returns the key thang for a single key range, or null if a single key range is not used.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../com/sleepycat/bdb/DataStore.html" title="class in com.sleepycat.bdb">DataStore</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/sleepycat/bdb/DataView.html#getStore()">getStore</A></B>()</CODE> <BR> Returns the store, as specified to the constructor.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../com/sleepycat/bdb/bind/DataBinding.html" title="interface in com.sleepycat.bdb.bind">DataBinding</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/sleepycat/bdb/DataView.html#getValueBinding()">getValueBinding</A></B>()</CODE> <BR> Returns the value binding that is used.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../com/sleepycat/bdb/bind/EntityBinding.html" title="interface in com.sleepycat.bdb.bind">EntityBinding</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/sleepycat/bdb/DataView.html#getValueEntityBinding()">getValueEntityBinding</A></B>()</CODE> <BR> Returns the entity binding that is used.</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/bdb/DataView.html#isAutoCommit()">isAutoCommit</A></B>()</CODE> <BR> Returns whether auto-commit is set for this view or for the transactional environment of the store and index.</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/bdb/DataView.html#isDirtyReadAllowed()">isDirtyReadAllowed</A></B>()</CODE> <BR> Returns whether DIRTY_READ was specified for both the Store and Index.</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/bdb/DataView.html#isDirtyReadEnabled()">isDirtyReadEnabled</A></B>()</CODE> <BR> Returns whether DIRTY_READ will be used for all read operations.</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/bdb/DataView.html#isEmpty()">isEmpty</A></B>()</CODE> <BR> Returns whether no records are present in the view.</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/bdb/DataView.html#isOrdered()">isOrdered</A></B>()</CODE> <BR> Returns whether keys are ordered for the index or store.</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/bdb/DataView.html#isTransactional()">isTransactional</A></B>()</CODE> <BR> Returns whether the store and index are transactional.</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/bdb/DataView.html#isWriteAllowed()">isWriteAllowed</A></B>()</CODE> <BR> Returns whether write operations are allowed.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../com/sleepycat/bdb/DataCursor.html" title="class in com.sleepycat.bdb">DataCursor</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/sleepycat/bdb/DataView.html#join(com.sleepycat.bdb.DataCursor[], boolean)">join</A></B>(<A HREF="../../../com/sleepycat/bdb/DataCursor.html" title="class in com.sleepycat.bdb">DataCursor</A>[] indexCursors, boolean presorted)</CODE> <BR> Returns a cursor for this view that reads only records having the index key values at the specified cursors.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../com/sleepycat/bdb/DataCursor.html" title="class in com.sleepycat.bdb">DataCursor</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/sleepycat/bdb/DataView.html#join(com.sleepycat.bdb.DataView[], java.lang.Object[], boolean)">join</A></B>(<A HREF="../../../com/sleepycat/bdb/DataView.html" title="class in com.sleepycat.bdb">DataView</A>[] indexViews, java.lang.Object[] indexKeys, boolean presorted)</CODE> <BR> Returns a cursor for this view that reads only records having the specified index key values.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../com/sleepycat/bdb/DataView.html" title="class in com.sleepycat.bdb">DataView</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/sleepycat/bdb/DataView.html#keySetView()">keySetView</A></B>()</CODE> <BR> Return a new key-set view derived from this view by setting the entity and value binding to null.</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/bdb/DataView.html#put(java.lang.Object, java.lang.Object, int, java.lang.Object[])">put</A></B>(java.lang.Object primaryKey, java.lang.Object value, int flags, java.lang.Object[] oldValue)</CODE> <BR> Performs a database 'put' operation, optionally returning the old value.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../com/sleepycat/bdb/DataView.html" title="class in com.sleepycat.bdb">DataView</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/sleepycat/bdb/DataView.html#subView(java.lang.Object, boolean, java.lang.Object, boolean, com.sleepycat.bdb.bind.DataBinding)">subView</A></B>(java.lang.Object beginKey, boolean beginInclusive, java.lang.Object endKey, boolean endInclusive, <A HREF="../../../com/sleepycat/bdb/bind/DataBinding.html" title="interface in com.sleepycat.bdb.bind">DataBinding</A> keyBinding)</CODE> <BR> Return a new value-set view for key range, optionally changing the key binding.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../com/sleepycat/bdb/DataView.html" title="class in com.sleepycat.bdb">DataView</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/sleepycat/bdb/DataView.html#valueSetView()">valueSetView</A></B>()</CODE> <BR> Return a new value-set view derived from this view by setting the key binding to null.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../com/sleepycat/bdb/DataView.html" title="class in com.sleepycat.bdb">DataView</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/sleepycat/bdb/DataView.html#valueSetView(java.lang.Object)">valueSetView</A></B>(java.lang.Object singleKey)</CODE> <BR> Return a new value-set view for single key range.</TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> </TR> </TABLE> <P> <!-- ========= CONSTRUCTOR DETAIL ======== --> <A NAME="constructor_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>Constructor Detail</B></FONT></TH> </TR> </TABLE> <A NAME="DataView(com.sleepycat.bdb.DataStore, com.sleepycat.bdb.DataIndex, com.sleepycat.bdb.bind.DataBinding, com.sleepycat.bdb.bind.DataBinding, com.sleepycat.bdb.bind.EntityBinding, boolean)"><!-- --></A><H3> DataView</H3> <PRE> public <B>DataView</B>(<A HREF="../../../com/sleepycat/bdb/DataStore.html" title="class in com.sleepycat.bdb">DataStore</A> store, <A HREF="../../../com/sleepycat/bdb/DataIndex.html" title="class in com.sleepycat.bdb">DataIndex</A> index, <A HREF="../../../com/sleepycat/bdb/bind/DataBinding.html" title="interface in com.sleepycat.bdb.bind">DataBinding</A> keyBinding, <A HREF="../../../com/sleepycat/bdb/bind/DataBinding.html" title="interface in com.sleepycat.bdb.bind">DataBinding</A> valueBinding, <A HREF="../../../com/sleepycat/bdb/bind/EntityBinding.html" title="interface in com.sleepycat.bdb.bind">EntityBinding</A> entityBinding, boolean writeAllowed) throws java.lang.IllegalArgumentException</PRE> <DL> <DD>Creates a view for a given store/index and bindings. The key range of the view will be open. <P> <DL> <DT><B>Parameters:</B><DD><CODE>store</CODE> - is the store or is ignored if the index parameter is given.<DD><CODE>index</CODE> - is the index or null if no index is used.<DD><CODE>keyBinding</CODE> - is the key binding or null if keys will not be used.<DD><CODE>valueBinding</CODE> - is the value binding or null if an entityBinding is given or if values will not be used.<DD><CODE>entityBinding</CODE> - is the entity binding or null if an valueBinding is given or if values will not be used.<DD><CODE>writeAllowed</CODE> - is whether writing through this view is allowed. <DT><B>Throws:</B> <DD><CODE>java.lang.IllegalArgumentException</CODE> - if formats are not consistently defined or a parameter is invalid.</DL> </DL> <!-- ============ 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="keySetView()"><!-- --></A><H3> keySetView</H3> <PRE> public <A HREF="../../../com/sleepycat/bdb/DataView.html" title="class in com.sleepycat.bdb">DataView</A> <B>keySetView</B>()</PRE> <DL> <DD>Return a new key-set view derived from this view by setting the entity and value binding to null. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the derived view.</DL> </DD> </DL> <HR> <A NAME="valueSetView()"><!-- --></A><H3> valueSetView</H3> <PRE> public <A HREF="../../../com/sleepycat/bdb/DataView.html" title="class in com.sleepycat.bdb">DataView</A> <B>valueSetView</B>()</PRE> <DL> <DD>Return a new value-set view derived from this view by setting the key binding to null. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the derived view.</DL> </DD> </DL> <HR> <A NAME="valueSetView(java.lang.Object)"><!-- --></A><H3> valueSetView</H3> <PRE> public <A HREF="../../../com/sleepycat/bdb/DataView.html" title="class in com.sleepycat.bdb">DataView</A> <B>valueSetView</B>(java.lang.Object singleKey) throws <A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A>, java.io.IOException, <A HREF="../../../com/sleepycat/bdb/KeyRangeException.html" title="class in com.sleepycat.bdb">KeyRangeException</A></PRE> <DL> <DD>Return a new value-set view for single key range. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>singleKey</CODE> - the single key value. <DT><B>Returns:</B><DD>the derived view. <DT><B>Throws:</B> <DD><CODE><A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A></CODE> - if a database problem occurs. <DD><CODE>java.io.IOException</CODE> - if an IO problem occurs. <DD><CODE><A HREF="../../../com/sleepycat/bdb/KeyRangeException.html" title="class in com.sleepycat.bdb">KeyRangeException</A></CODE> - if the specified range is not within the current range.</DL> </DD> </DL> <HR> <A NAME="subView(java.lang.Object, boolean, java.lang.Object, boolean, com.sleepycat.bdb.bind.DataBinding)"><!-- --></A><H3> subView</H3> <PRE> public <A HREF="../../../com/sleepycat/bdb/DataView.html" title="class in com.sleepycat.bdb">DataView</A> <B>subView</B>(java.lang.Object beginKey, boolean beginInclusive, java.lang.Object endKey, boolean endInclusive, <A HREF="../../../com/sleepycat/bdb/bind/DataBinding.html" title="interface in com.sleepycat.bdb.bind">DataBinding</A> keyBinding) throws <A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A>, java.io.IOException, <A HREF="../../../com/sleepycat/bdb/KeyRangeException.html" title="class in com.sleepycat.bdb">KeyRangeException</A></PRE> <DL> <DD>Return a new value-set view for key range, optionally changing the key binding. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>beginKey</CODE> - the lower bound.<DD><CODE>beginInclusive</CODE> - whether the lower bound is inclusive.<DD><CODE>endKey</CODE> - the upper bound.<DD><CODE>endInclusive</CODE> - whether the upper bound is inclusive.<DD><CODE>keyBinding</CODE> - a key binding to use, or null to retain the base view's key binding. <DT><B>Returns:</B><DD>the derived view. <DT><B>Throws:</B> <DD><CODE><A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A></CODE> - if a database problem occurs. <DD><CODE>java.io.IOException</CODE> - if an IO problem occurs. <DD><CODE><A HREF="../../../com/sleepycat/bdb/KeyRangeException.html" title="class in com.sleepycat.bdb">KeyRangeException</A></CODE> - if the specified range is not within the current range.</DL> </DD> </DL> <HR> <A NAME="dirtyReadView(boolean)"><!-- --></A><H3> dirtyReadView</H3> <PRE> public <A HREF="../../../com/sleepycat/bdb/DataView.html" title="class in com.sleepycat.bdb">DataView</A> <B>dirtyReadView</B>(boolean enable)</PRE> <DL> <DD>Returns a new view with a specified dirtyRead setting. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>enable</CODE> - whether to enable or disable dirty-read. <DT><B>Returns:</B><DD>the derived view.</DL> </DD> </DL> <HR> <A NAME="autoCommitView(boolean)"><!-- --></A><H3> autoCommitView</H3> <PRE> public <A HREF="../../../com/sleepycat/bdb/DataView.html" title="class in com.sleepycat.bdb">DataView</A> <B>autoCommitView</B>(boolean enable)</PRE> <DL> <DD>Returns a new view with a specified autoCommit setting. Note that auto-commit is not implemented by the view, the view only holds the auto-commit property. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>enable</CODE> - whether to enable or disable auto-commit. <DT><B>Returns:</B><DD>the derived view.</DL> </DD> </DL> <HR> <A NAME="getCurrentTxn()"><!-- --></A><H3> getCurrentTxn</H3> <PRE> public <A HREF="../../../com/sleepycat/bdb/CurrentTransaction.html" title="class in com.sleepycat.bdb">CurrentTransaction</A> <B>getCurrentTxn</B>()</PRE> <DL> <DD>Returns the current transaction for the view or null if the environment is non-transactional. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the current transaction.</DL> </DD> </DL> <HR> <A NAME="getSingleKeyThang()"><!-- --></A><H3> getSingleKeyThang</H3> <PRE> public <A HREF="../../../com/sleepycat/bdb/DataThang.html" title="class in com.sleepycat.bdb">DataThang</A> <B>getSingleKeyThang</B>()</PRE> <DL> <DD>Returns the key thang for a single key range, or null if a single key range is not used. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the key thang or null.</DL> </DD> </DL> <HR> <A NAME="getDb()"><!-- --></A><H3> getDb</H3> <PRE> public <A HREF="../../../com/sleepycat/bdb/DataDb.html" title="class in com.sleepycat.bdb">DataDb</A> <B>getDb</B>()</PRE> <DL> <DD>Returns the database for the index, if one is used, or store, if no index is used. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the database of the index or, if none, the store.</DL> </DD> </DL> <HR> <A NAME="getEnv()"><!-- --></A><H3> getEnv</H3> <PRE> public final <A HREF="../../../com/sleepycat/db/DbEnv.html" title="class in com.sleepycat.db">DbEnv</A> <B>getEnv</B>()</PRE> <DL> <DD>Returns the environment for the store and index. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the environment.</DL> </DD> </DL> <HR> <A NAME="isAutoCommit()"><!-- --></A><H3> isAutoCommit</H3> <PRE> public final boolean <B>isAutoCommit</B>()</PRE> <DL> <DD>Returns whether auto-commit is set for this view or for the transactional environment of the store and index. Note that auto-commit is not implemented by the view, the view only holds the auto-commit property. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the auto-commit setting.</DL> </DD> </DL> <HR> <A NAME="getStore()"><!-- --></A><H3> getStore</H3> <PRE> public final <A HREF="../../../com/sleepycat/bdb/DataStore.html" title="class in com.sleepycat.bdb">DataStore</A> <B>getStore</B>()</PRE> <DL> <DD>Returns the store, as specified to the constructor. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the store.</DL> </DD> </DL> <HR> <A NAME="getIndex()"><!-- --></A><H3> getIndex</H3> <PRE> public final <A HREF="../../../com/sleepycat/bdb/DataIndex.html" title="class in com.sleepycat.bdb">DataIndex</A> <B>getIndex</B>()</PRE> <DL> <DD>Returns the index, as specified to the constructor. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the index or null.</DL> </DD> </DL> <HR> <A NAME="getKeyBinding()"><!-- --></A><H3> getKeyBinding</H3> <PRE> public final <A HREF="../../../com/sleepycat/bdb/bind/DataBinding.html" title="interface in com.sleepycat.bdb.bind">DataBinding</A> <B>getKeyBinding</B>()</PRE> <DL> <DD>Returns the key binding that is used. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the key binding or null.</DL> </DD> </DL> <HR> <A NAME="getValueBinding()"><!-- --></A><H3> getValueBinding</H3> <PRE> public final <A HREF="../../../com/sleepycat/bdb/bind/DataBinding.html" title="interface in com.sleepycat.bdb.bind">DataBinding</A> <B>getValueBinding</B>()</PRE> <DL> <DD>Returns the value binding that is used. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the value binding or null.</DL> </DD> </DL> <HR> <A NAME="getValueEntityBinding()"><!-- --></A><H3> getValueEntityBinding</H3> <PRE> public final <A HREF="../../../com/sleepycat/bdb/bind/EntityBinding.html" title="interface in com.sleepycat.bdb.bind">EntityBinding</A> <B>getValueEntityBinding</B>()</PRE> <DL> <DD>Returns the entity binding that is used. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the entity binding or null.</DL> </DD> </DL> <HR> <A NAME="areDuplicatesAllowed()"><!-- --></A><H3> areDuplicatesAllowed</H3> <PRE> public final boolean <B>areDuplicatesAllowed</B>()</PRE> <DL> <DD>Returns whether duplicates are allowed for the index or store. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>whether duplicates are allowed.</DL> </DD> </DL> <HR> <A NAME="areDuplicatesOrdered()"><!-- --></A><H3> areDuplicatesOrdered</H3> <PRE> public final boolean <B>areDuplicatesOrdered</B>()</PRE> <DL> <DD>Returns whether duplicates are ordered for the index or store. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>whether duplicates are ordered.</DL> </DD> </DL> <HR> <A NAME="areKeysRenumbered()"><!-- --></A><H3> areKeysRenumbered</H3> <PRE> public final boolean <B>areKeysRenumbered</B>()</PRE> <DL> <DD>Returns whether keys (record numbers) are renumbered for the index or store. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>whether keys are renumbered.</DL> </DD> </DL> <HR> <A NAME="isOrdered()"><!-- --></A><H3> isOrdered</H3> <PRE> public final boolean <B>isOrdered</B>()</PRE> <DL> <DD>Returns whether keys are ordered for the index or store. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>whether keys are ordered.</DL> </DD> </DL> <HR> <A NAME="isWriteAllowed()"><!-- --></A><H3> isWriteAllowed</H3> <PRE> public final boolean <B>isWriteAllowed</B>()</PRE> <DL> <DD>Returns whether write operations are allowed. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>whether write operations are allowed.</DL> </DD> </DL> <HR> <A NAME="isDirtyReadAllowed()"><!-- --></A><H3> isDirtyReadAllowed</H3> <PRE> public final boolean <B>isDirtyReadAllowed</B>()</PRE> <DL> <DD>Returns whether DIRTY_READ was specified for both the Store and Index. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>whether dirty-read is allowed.</DL> </DD> </DL> <HR> <A NAME="isDirtyReadEnabled()"><!-- --></A><H3> isDirtyReadEnabled</H3> <PRE> public final boolean <B>isDirtyReadEnabled</B>()</PRE> <DL> <DD>Returns whether DIRTY_READ will be used for all read operations. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>whether dirty-read is enabled.</DL> </DD> </DL> <HR> <A NAME="isTransactional()"><!-- --></A><H3> isTransactional</H3> <PRE> public final boolean <B>isTransactional</B>()</PRE> <DL> <DD>Returns whether the store and index are transactional. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>whether the store and index are transactional.</DL> </DD> </DL> <HR> <A NAME="isEmpty()"><!-- --></A><H3> isEmpty</H3> <PRE> public boolean <B>isEmpty</B>() throws <A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A>, java.io.IOException</PRE> <DL> <DD>Returns whether no records are present in the view. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>whether the view is empty. <DT><B>Throws:</B> <DD><CODE><A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A></CODE> - if a database problem occurs. <DD><CODE>java.io.IOException</CODE> - if an IO problem occurs.</DL> </DD> </DL> <HR> <A NAME="get(java.lang.Object, java.lang.Object, int, boolean, java.lang.Object[])"><!-- --></A><H3> get</H3> <PRE> public int <B>get</B>(java.lang.Object key, java.lang.Object value, int flags, boolean lockForWrite, java.lang.Object[] retValue) throws <A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A>, java.io.IOException</PRE> <DL> <DD>Performs a general database 'get' operation. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>key</CODE> - used to find the value<DD><CODE>value</CODE> - used to find the value<DD><CODE>flags</CODE> - all flags except DB_SET and DB_GET_BOTH are legal, <A HREF="../../../com/sleepycat/db/Db.html#get(com.sleepycat.db.DbTxn, com.sleepycat.db.Dbt, com.sleepycat.db.Dbt, int)"><CODE>Db.get(DbTxn,Dbt,Dbt,int)</CODE></A>.<DD><CODE>lockForWrite</CODE> - if true locks the cursor during the get.<DD><CODE>retValue</CODE> - used to store the result of the query <DT><B>Returns:</B><DD>0 if mathing values are found, Db.DB_NOTFOUND if not. <DT><B>Throws:</B> <DD><CODE><A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A></CODE> - if a database problem occurs. <DD><CODE>java.io.IOException</CODE> - if an IO problem occurs.</DL> </DD> </DL> <HR> <A NAME="consume(int, java.lang.Object[], java.lang.Object[])"><!-- --></A><H3> consume</H3> <PRE> public int <B>consume</B>(int flags, java.lang.Object[] retPrimaryKey, java.lang.Object[] retValue) throws <A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A>, java.io.IOException</PRE> <DL> <DD>Performs a database 'get and consume' operation. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>flags</CODE> - must be CONSUME or CONSUME_WAIT.<DD><CODE>retPrimaryKey</CODE> - used to store the resulting key.<DD><CODE>retValue</CODE> - used to store the resulting value. <DT><B>Returns:</B><DD>an error or zero for success. <DT><B>Throws:</B> <DD><CODE><A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A></CODE> - if a database problem occurs. <DD><CODE>java.io.IOException</CODE> - if an IO problem occurs.</DL> </DD> </DL> <HR> <A NAME="put(java.lang.Object, java.lang.Object, int, java.lang.Object[])"><!-- --></A><H3> put</H3> <PRE> public int <B>put</B>(java.lang.Object primaryKey, java.lang.Object value, int flags, java.lang.Object[] oldValue) throws <A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A>, java.io.IOException</PRE> <DL> <DD>Performs a database 'put' operation, optionally returning the old value. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>primaryKey</CODE> - key of new record.<DD><CODE>value</CODE> - value of new record.<DD><CODE>flags</CODE> - must be 0, NODUPDATA or NOOVERWRITE.<DD><CODE>oldValue</CODE> - used to store the old value, or null if none should be returned. <DT><B>Returns:</B><DD>an error or zero for success. <DT><B>Throws:</B> <DD><CODE><A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A></CODE> - if a database problem occurs. <DD><CODE>java.io.IOException</CODE> - if an IO problem occurs.</DL> </DD> </DL> <HR> <A NAME="addValue(com.sleepycat.bdb.DataThang, java.lang.Object, int)"><!-- --></A><H3> addValue</H3> <PRE> public int <B>addValue</B>(<A HREF="../../../com/sleepycat/bdb/DataThang.html" title="class in com.sleepycat.bdb">DataThang</A> primaryKeyThang, java.lang.Object value, int flags) throws <A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A>, java.io.IOException</PRE> <DL> <DD>Adds a duplicate value for a specified key. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>primaryKeyThang</CODE> - key of new record.<DD><CODE>value</CODE> - value of new record.<DD><CODE>flags</CODE> - must be 0 or NODUPDATA or KEYFIRST or KEYLAST. <DT><B>Returns:</B><DD>an error or zero for success. <DT><B>Throws:</B> <DD><CODE><A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A></CODE> - if a database problem occurs. <DD><CODE>java.io.IOException</CODE> - if an IO problem occurs.</DL> </DD> </DL> <HR> <A NAME="append(java.lang.Object, java.lang.Object[], java.lang.Object[])"><!-- --></A><H3> append</H3> <PRE> public int <B>append</B>(java.lang.Object value, java.lang.Object[] retPrimaryKey, java.lang.Object[] retValue) throws <A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A>, java.io.IOException</PRE> <DL> <DD>Appends a value and returns the new key. If a key assigner is used it assigns the key, otherwise a QUEUE or RECNO database is required. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>value</CODE> - is the value to append.<DD><CODE>retPrimaryKey</CODE> - used to store the assigned key.<DD><CODE>retValue</CODE> - used to store the resulting entity, or null if none should be returned. <DT><B>Returns:</B><DD>an error or zero for success. <DT><B>Throws:</B> <DD><CODE><A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A></CODE> - if a database problem occurs. <DD><CODE>java.io.IOException</CODE> - if an IO problem occurs.</DL> </DD> </DL> <HR> <A NAME="clear(java.util.Collection)"><!-- --></A><H3> clear</H3> <PRE> public void <B>clear</B>(java.util.Collection oldValues) throws <A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A>, java.io.IOException</PRE> <DL> <DD>Deletes all records in the current range, optionally returning the values for the deleted records. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>oldValues</CODE> - is used to store the values that are cleared, or null if the old values should not be returned. <DT><B>Throws:</B> <DD><CODE><A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A></CODE> - if a database problem occurs. <DD><CODE>java.io.IOException</CODE> - if an IO problem occurs.</DL> </DD> </DL> <HR> <A NAME="join(com.sleepycat.bdb.DataView[], java.lang.Object[], boolean)"><!-- --></A><H3> join</H3> <PRE> public <A HREF="../../../com/sleepycat/bdb/DataCursor.html" title="class in com.sleepycat.bdb">DataCursor</A> <B>join</B>(<A HREF="../../../com/sleepycat/bdb/DataView.html" title="class in com.sleepycat.bdb">DataView</A>[] indexViews, java.lang.Object[] indexKeys, boolean presorted) throws <A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A>, java.io.IOException</PRE> <DL> <DD>Returns a cursor for this view that reads only records having the specified index key values. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>indexViews</CODE> - are the views to be joined.<DD><CODE>indexKeys</CODE> - are the keys to join on for each view.<DD><CODE>presorted</CODE> - is whether the given views are presorted or should be sorted by number of values per key. <DT><B>Returns:</B><DD>the join cursor. <DT><B>Throws:</B> <DD><CODE><A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A></CODE> - if a database problem occurs. <DD><CODE>java.io.IOException</CODE> - if an IO problem occurs.</DL> </DD> </DL> <HR> <A NAME="join(com.sleepycat.bdb.DataCursor[], boolean)"><!-- --></A><H3> join</H3> <PRE> public <A HREF="../../../com/sleepycat/bdb/DataCursor.html" title="class in com.sleepycat.bdb">DataCursor</A> <B>join</B>(<A HREF="../../../com/sleepycat/bdb/DataCursor.html" title="class in com.sleepycat.bdb">DataCursor</A>[] indexCursors, boolean presorted) throws <A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A>, java.io.IOException</PRE> <DL> <DD>Returns a cursor for this view that reads only records having the index key values at the specified cursors. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>indexCursor</CODE> - are the cursors to be joined.<DD><CODE>presorted</CODE> - is whether the given cursors are presorted or should be sorted by number of values per key. <DT><B>Returns:</B><DD>the join cursor. <DT><B>Throws:</B> <DD><CODE><A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A></CODE> - if a database problem occurs. <DD><CODE>java.io.IOException</CODE> - if an IO problem occurs.</DL> </DD> </DL> <HR> <A NAME="canDeriveKeyFromValue()"><!-- --></A><H3> canDeriveKeyFromValue</H3> <PRE> public boolean <B>canDeriveKeyFromValue</B>()</PRE> <DL> <DD>Returns whether data keys can be derived from the value/entity binding of this view, which determines whether a value/entity object alone is sufficient for operations that require keys. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>whether data keys can be derived.</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/DataThang.html" title="class in com.sleepycat.bdb"><B>PREV CLASS</B></A> <A HREF="../../../com/sleepycat/bdb/ForeignKeyIndex.html" title="class in com.sleepycat.bdb"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../index.html?com/sleepycat/bdb/DataView.html" target="_top"><B>FRAMES</B></A> <A HREF="DataView.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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_bottom"></A> <!-- ======== END OF BOTTOM NAVBAR ======= --> <HR> </BODY> </HTML>