<!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>
DataIndex
</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="DataIndex";
}
}
</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/DataDb.html" title="class in com.sleepycat.bdb"><B>PREV CLASS</B></A>
<A HREF="../../../com/sleepycat/bdb/DataStore.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/DataIndex.html" target="_top"><B>FRAMES</B></A>
<A HREF="DataIndex.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 DataIndex</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.sleepycat.bdb.DataIndex</B>
</PRE>
<DL>
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../com/sleepycat/bdb/ForeignKeyIndex.html" title="class in com.sleepycat.bdb">ForeignKeyIndex</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <B>DataIndex</B><DT>extends java.lang.Object</DL>
</PRE>
<P>
Represents a Berkeley DB secondary index. An index is always attached to a
single <A HREF="../../../com/sleepycat/bdb/DataStore.html" title="class in com.sleepycat.bdb"><CODE>DataStore</CODE></A> when it is constructed. An index is typically
accessed by passing it to the constructor of one of the collection classes
in the <CODE>com.sleepycat.bdb.collection</CODE> package. For example:
<pre>
Db db = new Db(env, 0);
db.setFlags(Db.DB_DUPSORT);
db.open(null, "index.db", null, Db.DB_BTREE, dbOpenFlags, 0);
DataIndex index = new DataIndex(store, db, keyFormat, keyExtractor);
StoredMap map = new StoredMap(index, 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>
<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/DataIndex.html#DataIndex(com.sleepycat.bdb.DataStore, com.sleepycat.db.Db, com.sleepycat.bdb.bind.DataFormat, com.sleepycat.bdb.bind.KeyExtractor)">DataIndex</A></B>(<A HREF="../../../com/sleepycat/bdb/DataStore.html" title="class in com.sleepycat.bdb">DataStore</A> store,
<A HREF="../../../com/sleepycat/db/Db.html" title="class in com.sleepycat.db">Db</A> db,
<A HREF="../../../com/sleepycat/bdb/bind/DataFormat.html" title="interface in com.sleepycat.bdb.bind">DataFormat</A> keyFormat,
<A HREF="../../../com/sleepycat/bdb/bind/KeyExtractor.html" title="interface in com.sleepycat.bdb.bind">KeyExtractor</A> keyExtractor)</CODE>
<BR>
Creates an index from a previously opened Db object.</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> <A HREF="../../../com/sleepycat/bdb/bind/KeyExtractor.html" title="interface in com.sleepycat.bdb.bind">KeyExtractor</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/bdb/DataIndex.html#getKeyExtractor()">getKeyExtractor</A></B>()</CODE>
<BR>
Returns the key extractor associated with this index.</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" title="interface in com.sleepycat.bdb.bind">DataFormat</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/bdb/DataIndex.html#getKeyFormat()">getKeyFormat</A></B>()</CODE>
<BR>
Returns the key format associated with this index.</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/DataIndex.html#getStore()">getStore</A></B>()</CODE>
<BR>
Returns the store associated with this index.</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/bdb/DataIndex.html#toString()">toString</A></B>()</CODE>
<BR>
Returns a printable string identifying the file and database name
of the index.</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, 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="DataIndex(com.sleepycat.bdb.DataStore, com.sleepycat.db.Db, com.sleepycat.bdb.bind.DataFormat, com.sleepycat.bdb.bind.KeyExtractor)"><!-- --></A><H3>
DataIndex</H3>
<PRE>
public <B>DataIndex</B>(<A HREF="../../../com/sleepycat/bdb/DataStore.html" title="class in com.sleepycat.bdb">DataStore</A> store,
<A HREF="../../../com/sleepycat/db/Db.html" title="class in com.sleepycat.db">Db</A> db,
<A HREF="../../../com/sleepycat/bdb/bind/DataFormat.html" title="interface in com.sleepycat.bdb.bind">DataFormat</A> keyFormat,
<A HREF="../../../com/sleepycat/bdb/bind/KeyExtractor.html" title="interface in com.sleepycat.bdb.bind">KeyExtractor</A> keyExtractor)</PRE>
<DL>
<DD>Creates an index from a previously opened Db object.
<P>
<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>keyFormat</CODE> - the data format for keys.<DD><CODE>keyExtractor</CODE> - an object for extracting the index key from primary
key and/or value buffers, and for clearing the index key in a value
buffer.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if a format mismatch is detected
between the index and the store, or if unsorted duplicates were
specified for the index Db.</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="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 associated with this index.
<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" title="interface in com.sleepycat.bdb.bind">DataFormat</A> <B>getKeyFormat</B>()</PRE>
<DL>
<DD>Returns the key format associated with this index.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getKeyExtractor()"><!-- --></A><H3>
getKeyExtractor</H3>
<PRE>
public final <A HREF="../../../com/sleepycat/bdb/bind/KeyExtractor.html" title="interface in com.sleepycat.bdb.bind">KeyExtractor</A> <B>getKeyExtractor</B>()</PRE>
<DL>
<DD>Returns the key extractor associated with this index.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="toString()"><!-- --></A><H3>
toString</H3>
<PRE>
public java.lang.String <B>toString</B>()</PRE>
<DL>
<DD>Returns a printable string identifying the file and database name
of the index.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
</DD>
<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/bdb/DataDb.html" title="class in com.sleepycat.bdb"><B>PREV CLASS</B></A>
<A HREF="../../../com/sleepycat/bdb/DataStore.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/DataIndex.html" target="_top"><B>FRAMES</B></A>
<A HREF="DataIndex.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>
