<!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:06 EST 2003 -->
<TITLE>
DataStore (Sleepycat Software, Inc. - Berkeley DB Java API)
</TITLE>
<META NAME="keywords" CONTENT="com.sleepycat.bdb.DataStore,DataStore class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../style.css" TITLE="Style">
</HEAD>
<SCRIPT>
function asd()
{
parent.document.title="DataStore (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> </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="class-use/DataStore.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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>
<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">
<A HREF="../../../com/sleepycat/bdb/DataIndex.html"><B>PREV CLASS</B></A>
<A HREF="../../../com/sleepycat/bdb/DataThang.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="DataStore.html" TARGET="_top"><B>NO FRAMES</B></A>
<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: 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>
<!-- =========== END OF NAVBAR =========== -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sleepycat.bdb</FONT>
<BR>
Class DataStore</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.DataStore</B>
</PRE>
<HR>
<DL>
<DT>public class <B>DataStore</B><DT>extends <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A></DL>
<P>
Represents a Berkeley DB database in the role of a primary data store. A
store may be used by itself or along with one or more <A HREF="../../../com/sleepycat/bdb/DataIndex.html"><CODE>DataIndex</CODE></A>
objects. A store is typically accessed by passing it to the constructor of
one of the collection classes in the <A HREF="../../../com/sleepycat/bdb/collection/package-summary.html">com.sleepycat.bdb.collection</A>
package. For example:
<pre>
Db db = new Db(env, 0);
db.open(null, "store.db", null, Db.DB_BTREE, dbOpenFlags, 0);
DataStore store = new DataStore(db, keyFormat, valueFormat, keyAssigner);
StoredMap map = new StoredMap(store, keyBinding, valueBinding, writeAllowed);
</pre>
<p>All access methods may be used with BDB. However, some access methods
may only be used with certain types of collection views, and some access
methods impose restrictions on the way collection views are used.</p>
<p>A store is always associated with the environment of its underlying
database, which is the first parameter to the {Db#Db} constructor. There
are three types of environments in Berkeley DB.</p>
<p>
<table border="1">
<tr>
<th>Environment</th>
<th>Access Mode</th>
<th>Berkeley DB Flags</th>
</tr>
<tr>
<td>Data Store</td>
<td>single-threaded access</td>
<td>Db.DB_INIT_MPOOL</td>
</tr>
<tr>
<td>Concurrent Data Store</td>
<td>single-writer multiple-reader access</td>
<td>Db.DB_INIT_CDB | Db.DB_INIT_MPOOL</td>
</tr>
<tr>
<td>Transactional Data Store</td>
<td>transactional access for any number of readers and writers</td>
<td>Db.DB_INIT_TXN | Db.DB_INIT_LOCK | Db.DB_INIT_MPOOL</td>
</tr>
</table>
<p>The flags shown are the minimum required for creating the Berkeley DB
environment. Many other Berkeley DB options are also available. For details
on creating and configuring the environment see the Berkeley DB
documentation.</p>
<p>All three environments may be used within BDB. However, the Concurrent
Data Store Environment imposes the restriction that only one writable cursor
may be open at a time. This means that if you have a writable iterator for
a data store open, then you cannot obtain another writable iterator for the
same data store and you cannot perform other write operations through a
collection for that data store (since this also uses a write cursor).</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/DataStore.html#DataStore(com.sleepycat.db.Db, com.sleepycat.bdb.bind.DataFormat, com.sleepycat.bdb.bind.DataFormat, com.sleepycat.bdb.PrimaryKeyAssigner)">DataStore</A></B>(<A HREF="../../../com/sleepycat/db/Db.html">Db</A> db,
<A HREF="../../../com/sleepycat/bdb/bind/DataFormat.html">DataFormat</A> keyFormat,
<A HREF="../../../com/sleepycat/bdb/bind/DataFormat.html">DataFormat</A> valueFormat,
<A HREF="../../../com/sleepycat/bdb/PrimaryKeyAssigner.html">PrimaryKeyAssigner</A> keyAssigner)</CODE>
<BR>
Creates a store from a previously opened Db object.</TD>
</TR>
</TABLE>
<!-- ========== 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> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/bdb/DataStore.html#close()">close</A></B>()</CODE>
<BR>
Closes the store and all associated indices.</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">DbEnv</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/bdb/DataStore.html#getEnv()">getEnv</A></B>()</CODE>
<BR>
Returns the environment associated with this store.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Iterator.html">Iterator</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/bdb/DataStore.html#getIndices()">getIndices</A></B>()</CODE>
<BR>
Returns the indices associated with this store.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../com/sleepycat/bdb/PrimaryKeyAssigner.html">PrimaryKeyAssigner</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/bdb/DataStore.html#getKeyAssigner()">getKeyAssigner</A></B>()</CODE>
<BR>
Returns the key assigner associated with this store.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../com/sleepycat/bdb/bind/DataFormat.html">DataFormat</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/bdb/DataStore.html#getKeyFormat()">getKeyFormat</A></B>()</CODE>
<BR>
Returns the key format associated with this store.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../com/sleepycat/bdb/bind/DataFormat.html">DataFormat</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/bdb/DataStore.html#getValueFormat()">getValueFormat</A></B>()</CODE>
<BR>
Returns the value format associated with this store.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/bdb/DataStore.html#toString()">toString</A></B>()</CODE>
<BR>
Returns a printable string identifying the filename and datbase name
of the store.</TD>
</TR>
</TABLE>
<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#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>
<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="DataStore(com.sleepycat.db.Db, com.sleepycat.bdb.bind.DataFormat, com.sleepycat.bdb.bind.DataFormat, com.sleepycat.bdb.PrimaryKeyAssigner)"><!-- --></A><H3>
DataStore</H3>
<PRE>
public <B>DataStore</B>(<A HREF="../../../com/sleepycat/db/Db.html">Db</A> db,
<A HREF="../../../com/sleepycat/bdb/bind/DataFormat.html">DataFormat</A> keyFormat,
<A HREF="../../../com/sleepycat/bdb/bind/DataFormat.html">DataFormat</A> valueFormat,
<A HREF="../../../com/sleepycat/bdb/PrimaryKeyAssigner.html">PrimaryKeyAssigner</A> keyAssigner)</PRE>
<DL>
<DD>Creates a store from a previously opened Db object.
<P>
<DT><B>Parameters:</B><DD><CODE>db</CODE> - the previously opened Db object.<DD><CODE>keyFormat</CODE> - the data format for keys.<DD><CODE>valueFormat</CODE> - the data format for values.<DD><CODE>keyAssigner</CODE> - an object for assigning keys or null if no automatic
key assignment is used.</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="close()"><!-- --></A><H3>
close</H3>
<PRE>
public void <B>close</B>()
throws <A HREF="../../../com/sleepycat/db/DbException.html">DbException</A></PRE>
<DL>
<DD>Closes the store and all associated indices.
<P>
<DD><DL>
<DD><CODE><A HREF="../../../com/sleepycat/db/DbException.html">DbException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getEnv()"><!-- --></A><H3>
getEnv</H3>
<PRE>
public final <A HREF="../../../com/sleepycat/db/DbEnv.html">DbEnv</A> <B>getEnv</B>()</PRE>
<DL>
<DD>Returns the environment associated with this store.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getKeyFormat()"><!-- --></A><H3>
getKeyFormat</H3>
<PRE>
public final <A HREF="../../../com/sleepycat/bdb/bind/DataFormat.html">DataFormat</A> <B>getKeyFormat</B>()</PRE>
<DL>
<DD>Returns the key format associated with this store.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getKeyAssigner()"><!-- --></A><H3>
getKeyAssigner</H3>
<PRE>
public final <A HREF="../../../com/sleepycat/bdb/PrimaryKeyAssigner.html">PrimaryKeyAssigner</A> <B>getKeyAssigner</B>()</PRE>
<DL>
<DD>Returns the key assigner associated with this store.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getValueFormat()"><!-- --></A><H3>
getValueFormat</H3>
<PRE>
public final <A HREF="../../../com/sleepycat/bdb/bind/DataFormat.html">DataFormat</A> <B>getValueFormat</B>()</PRE>
<DL>
<DD>Returns the value format associated with this store.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getIndices()"><!-- --></A><H3>
getIndices</H3>
<PRE>
public final <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Iterator.html">Iterator</A> <B>getIndices</B>()</PRE>
<DL>
<DD>Returns the indices associated with this store. Indices are associated
with a store when they are constructed. All objects returned by the
iterator will be of class <A HREF="../../../com/sleepycat/bdb/DataIndex.html"><CODE>DataIndex</CODE></A> and may also be of class
<A HREF="../../../com/sleepycat/bdb/ForeignKeyIndex.html"><CODE>ForeignKeyIndex</CODE></A>.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>an iterator of associated indices or null if there are none.</DL>
</DD>
</DL>
<HR>
<A NAME="toString()"><!-- --></A><H3>
toString</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A> <B>toString</B>()</PRE>
<DL>
<DD>Returns a printable string identifying the filename and datbase name
of the store.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#toString()">toString</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A></CODE></DL>
</DD>
<DD><DL>
</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> </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="class-use/DataStore.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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>
<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">
<A HREF="../../../com/sleepycat/bdb/DataIndex.html"><B>PREV CLASS</B></A>
<A HREF="../../../com/sleepycat/bdb/DataThang.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="DataStore.html" TARGET="_top"><B>NO FRAMES</B></A>
<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: 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>
<!-- =========== 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>