TupleSerialDbFactory.html   [plain text]


<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc on Wed Dec 03 16:22:08 EST 2003 -->
<TITLE>
TupleSerialDbFactory (Sleepycat Software, Inc. - Berkeley DB Java API)
</TITLE>
<META NAME="keywords" CONTENT="com.sleepycat.bdb.factory.TupleSerialDbFactory,TupleSerialDbFactory class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../style.css" TITLE="Style">
</HEAD>
<SCRIPT>
function asd()
{
parent.document.title="TupleSerialDbFactory (Sleepycat Software, Inc. - Berkeley DB Java API)";
}
</SCRIPT>
<BODY BGCOLOR="white" onload="asd();">

<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_top"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/TupleSerialDbFactory.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<b>Berkeley DB</b><br><font size="-1"> version 4.2.52</font></EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV CLASS&nbsp;
&nbsp;NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="TupleSerialDbFactory.html" TARGET="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;
<SCRIPT>
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->

<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sleepycat.bdb.factory</FONT>
<BR>
Class TupleSerialDbFactory</H2>
<PRE>
<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">java.lang.Object</A>
  |
  +--<B>com.sleepycat.bdb.factory.TupleSerialDbFactory</B>
</PRE>
<HR>
<DL>
<DT>public class <B>TupleSerialDbFactory</B><DT>extends <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A></DL>

<P>
Creates stored collections having tuple keys and serialized entity values.
 The entity classes must implement the java.io.Serializable and
 MarshalledTupleKeyEntity interfaces.  The key classes must either implement
 the MarshalledTupleData interface or be one of the Java primitive type
 classes.

 <p> This factory object is used to create DataStore, DataIndex,
 ForeignKeyIndex and Map objects.  The underlying DataFormat,
 DataBinding and KeyExtractor objects are created automatically. </p>
<P>

<P>
<HR>

<P>
<!-- ======== NESTED CLASS SUMMARY ======== -->


<!-- =========== FIELD SUMMARY =========== -->


<!-- ======== CONSTRUCTOR SUMMARY ======== -->

<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../com/sleepycat/bdb/factory/TupleSerialDbFactory.html#TupleSerialDbFactory(com.sleepycat.bdb.bind.serial.ClassCatalog)">TupleSerialDbFactory</A></B>(<A HREF="../../../../com/sleepycat/bdb/bind/serial/ClassCatalog.html">ClassCatalog</A>&nbsp;catalog)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a tuple-serial factory for given environment and class catalog.</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->

<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Method Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../com/sleepycat/bdb/bind/serial/ClassCatalog.html">ClassCatalog</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/bdb/factory/TupleSerialDbFactory.html#getCatalog()">getCatalog</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the class catalog associated with this factory.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../com/sleepycat/bdb/DataIndex.html">DataIndex</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/bdb/factory/TupleSerialDbFactory.html#newDataIndex(com.sleepycat.bdb.DataStore, com.sleepycat.db.Db, java.lang.String, boolean, boolean)">newDataIndex</A></B>(<A HREF="../../../../com/sleepycat/bdb/DataStore.html">DataStore</A>&nbsp;store,
             <A HREF="../../../../com/sleepycat/db/Db.html">Db</A>&nbsp;db,
             <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A>&nbsp;keyName,
             boolean&nbsp;usePrimaryKey,
             boolean&nbsp;useValue)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates an index from a previously opened Db object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../com/sleepycat/bdb/DataStore.html">DataStore</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/bdb/factory/TupleSerialDbFactory.html#newDataStore(com.sleepycat.db.Db, java.lang.Class, com.sleepycat.bdb.PrimaryKeyAssigner)">newDataStore</A></B>(<A HREF="../../../../com/sleepycat/db/Db.html">Db</A>&nbsp;db,
             <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Class.html">Class</A>&nbsp;baseClass,
             <A HREF="../../../../com/sleepycat/bdb/PrimaryKeyAssigner.html">PrimaryKeyAssigner</A>&nbsp;keyAssigner)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a store from a previously opened Db object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../com/sleepycat/bdb/ForeignKeyIndex.html">ForeignKeyIndex</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/bdb/factory/TupleSerialDbFactory.html#newForeignKeyIndex(com.sleepycat.bdb.DataStore, com.sleepycat.db.Db, java.lang.String, boolean, boolean, com.sleepycat.bdb.DataStore, int)">newForeignKeyIndex</A></B>(<A HREF="../../../../com/sleepycat/bdb/DataStore.html">DataStore</A>&nbsp;store,
                   <A HREF="../../../../com/sleepycat/db/Db.html">Db</A>&nbsp;db,
                   <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A>&nbsp;keyName,
                   boolean&nbsp;usePrimaryKey,
                   boolean&nbsp;useValue,
                   <A HREF="../../../../com/sleepycat/bdb/DataStore.html">DataStore</A>&nbsp;foreignStore,
                   int&nbsp;deleteAction)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a foreign key index from a previously opened Db object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../com/sleepycat/bdb/collection/StoredMap.html">StoredMap</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/bdb/factory/TupleSerialDbFactory.html#newMap(com.sleepycat.bdb.DataIndex, java.lang.Class, boolean)">newMap</A></B>(<A HREF="../../../../com/sleepycat/bdb/DataIndex.html">DataIndex</A>&nbsp;index,
       <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Class.html">Class</A>&nbsp;keyClass,
       boolean&nbsp;writeAllowed)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a map for a given index that was obtained from this factory.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../com/sleepycat/bdb/collection/StoredMap.html">StoredMap</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/bdb/factory/TupleSerialDbFactory.html#newMap(com.sleepycat.bdb.DataStore, java.lang.Class, boolean)">newMap</A></B>(<A HREF="../../../../com/sleepycat/bdb/DataStore.html">DataStore</A>&nbsp;store,
       <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Class.html">Class</A>&nbsp;keyClass,
       boolean&nbsp;writeAllowed)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a map for a given store that was obtained from this factory.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../com/sleepycat/bdb/collection/StoredSortedMap.html">StoredSortedMap</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/bdb/factory/TupleSerialDbFactory.html#newSortedMap(com.sleepycat.bdb.DataIndex, java.lang.Class, boolean)">newSortedMap</A></B>(<A HREF="../../../../com/sleepycat/bdb/DataIndex.html">DataIndex</A>&nbsp;index,
             <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Class.html">Class</A>&nbsp;keyClass,
             boolean&nbsp;writeAllowed)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a sorted map for a given index that was obtained from this
 factory.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../com/sleepycat/bdb/collection/StoredSortedMap.html">StoredSortedMap</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/bdb/factory/TupleSerialDbFactory.html#newSortedMap(com.sleepycat.bdb.DataStore, java.lang.Class, boolean)">newSortedMap</A></B>(<A HREF="../../../../com/sleepycat/bdb/DataStore.html">DataStore</A>&nbsp;store,
             <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Class.html">Class</A>&nbsp;keyClass,
             boolean&nbsp;writeAllowed)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a sorted map for a given store that was obtained from this
 factory.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#equals(java.lang.Object)">equals</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#getClass()">getClass</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#hashCode()">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#notify()">notify</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#notifyAll()">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#toString()">toString</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#wait()">wait</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#wait(long)">wait</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#wait(long, int)">wait</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ============ FIELD DETAIL =========== -->


<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="TupleSerialDbFactory(com.sleepycat.bdb.bind.serial.ClassCatalog)"><!-- --></A><H3>
TupleSerialDbFactory</H3>
<PRE>
public <B>TupleSerialDbFactory</B>(<A HREF="../../../../com/sleepycat/bdb/bind/serial/ClassCatalog.html">ClassCatalog</A>&nbsp;catalog)</PRE>
<DL>
<DD>Creates a tuple-serial factory for given environment and class catalog.
<P>
</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="getCatalog()"><!-- --></A><H3>
getCatalog</H3>
<PRE>
public final <A HREF="../../../../com/sleepycat/bdb/bind/serial/ClassCatalog.html">ClassCatalog</A> <B>getCatalog</B>()</PRE>
<DL>
<DD>Returns the class catalog associated with this factory.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="newDataStore(com.sleepycat.db.Db, java.lang.Class, com.sleepycat.bdb.PrimaryKeyAssigner)"><!-- --></A><H3>
newDataStore</H3>
<PRE>
public <A HREF="../../../../com/sleepycat/bdb/DataStore.html">DataStore</A> <B>newDataStore</B>(<A HREF="../../../../com/sleepycat/db/Db.html">Db</A>&nbsp;db,
                              <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Class.html">Class</A>&nbsp;baseClass,
                              <A HREF="../../../../com/sleepycat/bdb/PrimaryKeyAssigner.html">PrimaryKeyAssigner</A>&nbsp;keyAssigner)</PRE>
<DL>
<DD>Creates a store from a previously opened Db object.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>db</CODE> - the previously opened Db object.<DD><CODE>baseClass</CODE> - the base class of the entity values for this store.
 It must implement the  <A HREF="../../../../com/sleepycat/bdb/bind/tuple/MarshalledTupleKeyEntity.html"><CODE>MarshalledTupleKeyEntity</CODE></A> interface.<DD><CODE>keyAssigner</CODE> - an object for assigning keys or null if no automatic
 key assignment is used.</DL>
</DD>
</DL>
<HR>

<A NAME="newDataIndex(com.sleepycat.bdb.DataStore, com.sleepycat.db.Db, java.lang.String, boolean, boolean)"><!-- --></A><H3>
newDataIndex</H3>
<PRE>
public <A HREF="../../../../com/sleepycat/bdb/DataIndex.html">DataIndex</A> <B>newDataIndex</B>(<A HREF="../../../../com/sleepycat/bdb/DataStore.html">DataStore</A>&nbsp;store,
                              <A HREF="../../../../com/sleepycat/db/Db.html">Db</A>&nbsp;db,
                              <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A>&nbsp;keyName,
                              boolean&nbsp;usePrimaryKey,
                              boolean&nbsp;useValue)</PRE>
<DL>
<DD>Creates an index from a previously opened Db object.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>db</CODE> - the previously opened Db object.<DD><CODE>store</CODE> - the store to be indexed and also specifies the
 environment that was used to create the Db object.<DD><CODE>keyName</CODE> - is the key name passed to the <A HREF="../../../../com/sleepycat/bdb/bind/tuple/MarshalledTupleKeyEntity.html#marshalIndexKey(java.lang.String, com.sleepycat.bdb.bind.tuple.TupleOutput)"><CODE>MarshalledTupleKeyEntity.marshalIndexKey(java.lang.String, com.sleepycat.bdb.bind.tuple.TupleOutput)</CODE></A> method to identify the index
 key.<DD><CODE>usePrimaryKey</CODE> - is true if the primary key data is used to
 construct the index key.<DD><CODE>useValue</CODE> - is true if the value data is used to construct the index
 key.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/IllegalArgumentException.html">IllegalArgumentException</A></CODE> - if a format mismatch is detected
 between the index and the store, or if unsorted duplicates were
 specified for the index Db.</DL>
</DD>
</DL>
<HR>

<A NAME="newForeignKeyIndex(com.sleepycat.bdb.DataStore, com.sleepycat.db.Db, java.lang.String, boolean, boolean, com.sleepycat.bdb.DataStore, int)"><!-- --></A><H3>
newForeignKeyIndex</H3>
<PRE>
public <A HREF="../../../../com/sleepycat/bdb/ForeignKeyIndex.html">ForeignKeyIndex</A> <B>newForeignKeyIndex</B>(<A HREF="../../../../com/sleepycat/bdb/DataStore.html">DataStore</A>&nbsp;store,
                                          <A HREF="../../../../com/sleepycat/db/Db.html">Db</A>&nbsp;db,
                                          <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A>&nbsp;keyName,
                                          boolean&nbsp;usePrimaryKey,
                                          boolean&nbsp;useValue,
                                          <A HREF="../../../../com/sleepycat/bdb/DataStore.html">DataStore</A>&nbsp;foreignStore,
                                          int&nbsp;deleteAction)</PRE>
<DL>
<DD>Creates a foreign key index from a previously opened Db object.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>store</CODE> - the store to be indexed and also specifies the
 environment that was used to create the Db object.<DD><CODE>db</CODE> - the previously opened Db object.<DD><CODE>keyName</CODE> - is the key name passed to the <A HREF="../../../../com/sleepycat/bdb/bind/tuple/MarshalledTupleKeyEntity.html#marshalIndexKey(java.lang.String, com.sleepycat.bdb.bind.tuple.TupleOutput)"><CODE>MarshalledTupleKeyEntity.marshalIndexKey(java.lang.String, com.sleepycat.bdb.bind.tuple.TupleOutput)</CODE></A> method to identify the index
 key.<DD><CODE>usePrimaryKey</CODE> - is true if the primary key data is used to
 construct the index key.<DD><CODE>useValue</CODE> - is true if the value data is used to construct the index
 key.<DD><CODE>foreignStore</CODE> - is the store in which the index key for this store
 is a primary key.<DD><CODE>deleteAction</CODE> - determines what action occurs when the foreign key
 is deleted. It must be one of the
 <A HREF="../../../../com/sleepycat/bdb/ForeignKeyIndex.html"><CODE>ForeignKeyIndex</CODE></A> ON_DELETE_
 constants.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/IllegalArgumentException.html">IllegalArgumentException</A></CODE> - if a format mismatch is detected
 between the index and the store, or if unsorted duplicates were
 specified for the index Db.</DL>
</DD>
</DL>
<HR>

<A NAME="newMap(com.sleepycat.bdb.DataStore, java.lang.Class, boolean)"><!-- --></A><H3>
newMap</H3>
<PRE>
public <A HREF="../../../../com/sleepycat/bdb/collection/StoredMap.html">StoredMap</A> <B>newMap</B>(<A HREF="../../../../com/sleepycat/bdb/DataStore.html">DataStore</A>&nbsp;store,
                        <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Class.html">Class</A>&nbsp;keyClass,
                        boolean&nbsp;writeAllowed)</PRE>
<DL>
<DD>Creates a map for a given store that was obtained from this factory.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>store</CODE> - a store obtained from this factory.<DD><CODE>keyClass</CODE> - is the class used for map keys.  It must implement the
 <A HREF="../../../../com/sleepycat/bdb/bind/tuple/MarshalledTupleData.html"><CODE>MarshalledTupleData</CODE></A> interface or be one of the Java primitive
 type classes.<DD><CODE>writeAllowed</CODE> - is true to create a read-write collection or false
 to create a read-only collection.</DL>
</DD>
</DL>
<HR>

<A NAME="newMap(com.sleepycat.bdb.DataIndex, java.lang.Class, boolean)"><!-- --></A><H3>
newMap</H3>
<PRE>
public <A HREF="../../../../com/sleepycat/bdb/collection/StoredMap.html">StoredMap</A> <B>newMap</B>(<A HREF="../../../../com/sleepycat/bdb/DataIndex.html">DataIndex</A>&nbsp;index,
                        <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Class.html">Class</A>&nbsp;keyClass,
                        boolean&nbsp;writeAllowed)</PRE>
<DL>
<DD>Creates a map for a given index that was obtained from this factory.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>index</CODE> - a index obtained from this factory.<DD><CODE>keyClass</CODE> - is the class used for map keys.  It must implement the
 <A HREF="../../../../com/sleepycat/bdb/bind/tuple/MarshalledTupleData.html"><CODE>MarshalledTupleData</CODE></A> interface or be one of the Java primitive
 type classes.<DD><CODE>writeAllowed</CODE> - is true to create a read-write collection or false
 to create a read-only collection.</DL>
</DD>
</DL>
<HR>

<A NAME="newSortedMap(com.sleepycat.bdb.DataStore, java.lang.Class, boolean)"><!-- --></A><H3>
newSortedMap</H3>
<PRE>
public <A HREF="../../../../com/sleepycat/bdb/collection/StoredSortedMap.html">StoredSortedMap</A> <B>newSortedMap</B>(<A HREF="../../../../com/sleepycat/bdb/DataStore.html">DataStore</A>&nbsp;store,
                                    <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Class.html">Class</A>&nbsp;keyClass,
                                    boolean&nbsp;writeAllowed)</PRE>
<DL>
<DD>Creates a sorted map for a given store that was obtained from this
 factory.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>store</CODE> - a store obtained from this factory.<DD><CODE>keyClass</CODE> - is the class used for map keys.  It must implement the
 <A HREF="../../../../com/sleepycat/bdb/bind/tuple/MarshalledTupleData.html"><CODE>MarshalledTupleData</CODE></A> interface or be one of the Java primitive
 type classes.<DD><CODE>writeAllowed</CODE> - is true to create a read-write collection or false
 to create a read-only collection.</DL>
</DD>
</DL>
<HR>

<A NAME="newSortedMap(com.sleepycat.bdb.DataIndex, java.lang.Class, boolean)"><!-- --></A><H3>
newSortedMap</H3>
<PRE>
public <A HREF="../../../../com/sleepycat/bdb/collection/StoredSortedMap.html">StoredSortedMap</A> <B>newSortedMap</B>(<A HREF="../../../../com/sleepycat/bdb/DataIndex.html">DataIndex</A>&nbsp;index,
                                    <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Class.html">Class</A>&nbsp;keyClass,
                                    boolean&nbsp;writeAllowed)</PRE>
<DL>
<DD>Creates a sorted map for a given index that was obtained from this
 factory.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>index</CODE> - an index obtained from this factory.<DD><CODE>keyClass</CODE> - is the class used for map keys.  It must implement the
 <A HREF="../../../../com/sleepycat/bdb/bind/tuple/MarshalledTupleData.html"><CODE>MarshalledTupleData</CODE></A> interface or be one of the Java primitive
 type classes.<DD><CODE>writeAllowed</CODE> - is true to create a read-write collection or false
 to create a read-only collection.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>

<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/TupleSerialDbFactory.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<b>Berkeley DB</b><br><font size="-1"> version 4.2.52</font></EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV CLASS&nbsp;
&nbsp;NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="TupleSerialDbFactory.html" TARGET="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;
<SCRIPT>
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->

<HR>
<font size=1><a href="../../../../../sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font>
</BODY>
</HTML>