Imported Upstream version 5.3.21
[platform/upstream/libdb.git] / docs / java / com / sleepycat / db / BtreePrefixCalculator.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <!--NewPage-->
3 <HTML>
4 <HEAD>
5 <!-- Generated by javadoc (build 1.6.0_23) on Fri May 11 14:10:03 EDT 2012 -->
6 <TITLE>
7 BtreePrefixCalculator (Oracle - Berkeley DB Java API)
8 </TITLE>
9
10 <META NAME="date" CONTENT="2012-05-11">
11
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../style.css" TITLE="Style">
13
14 <SCRIPT type="text/javascript">
15 function windowTitle()
16 {
17     if (location.href.indexOf('is-external=true') == -1) {
18         parent.document.title="BtreePrefixCalculator (Oracle - Berkeley DB Java API)";
19     }
20 }
21 </SCRIPT>
22 <NOSCRIPT>
23 </NOSCRIPT>
24
25 </HEAD>
26
27 <BODY BGCOLOR="white" onload="windowTitle();">
28 <HR>
29
30
31 <!-- ========= START OF TOP NAVBAR ======= -->
32 <A NAME="navbar_top"><!-- --></A>
33 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
34 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
35 <TR>
36 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
37 <A NAME="navbar_top_firstrow"><!-- --></A>
38 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
39   <TR ALIGN="center" VALIGN="top">
40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
42   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/BtreePrefixCalculator.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
44   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
45   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
46   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
47   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
48   </TR>
49 </TABLE>
50 </TD>
51 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
52 <b>Berkeley DB</b><br><font size="-1"> version 5.3.21</font></EM>
53 </TD>
54 </TR>
55
56 <TR>
57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
58 &nbsp;<A HREF="../../../com/sleepycat/db/BtreeCompressor.html" title="interface in com.sleepycat.db"><B>PREV CLASS</B></A>&nbsp;
59 &nbsp;<A HREF="../../../com/sleepycat/db/BtreeStats.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD>
60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61   <A HREF="../../../index.html?com/sleepycat/db/BtreePrefixCalculator.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62 &nbsp;<A HREF="BtreePrefixCalculator.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
63 &nbsp;<SCRIPT type="text/javascript">
64   <!--
65   if(window==top) {
66     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
67   }
68   //-->
69 </SCRIPT>
70 <NOSCRIPT>
71   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
72 </NOSCRIPT>
73
74
75 </FONT></TD>
76 </TR>
77 <TR>
78 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
79   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
80 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
81 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
82 </TR>
83 </TABLE>
84 <A NAME="skip-navbar_top"></A>
85 <!-- ========= END OF TOP NAVBAR ========= -->
86
87 <HR>
88 <!-- ======== START OF CLASS DATA ======== -->
89 <H2>
90 <FONT SIZE="-1">
91 com.sleepycat.db</FONT>
92 <BR>
93 Interface BtreePrefixCalculator</H2>
94 <HR>
95 <DL>
96 <DT><PRE>public interface <B>BtreePrefixCalculator</B></DL>
97 </PRE>
98
99 <P>
100 An interface specifying how Btree prefixes should be calculated.
101 <P>
102
103 <P>
104 <HR>
105
106 <P>
107
108 <!-- ========== METHOD SUMMARY =========== -->
109
110 <A NAME="method_summary"><!-- --></A>
111 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
112 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
113 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
114 <B>Method Summary</B></FONT></TH>
115 </TR>
116 <TR BGCOLOR="white" CLASS="TableRowColor">
117 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
118 <CODE>&nbsp;int</CODE></FONT></TD>
119 <TD><CODE><B><A HREF="../../../com/sleepycat/db/BtreePrefixCalculator.html#prefix(com.sleepycat.db.Database, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)">prefix</A></B>(<A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</A>&nbsp;db,
120        <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;dbt1,
121        <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;dbt2)</CODE>
122
123 <BR>
124 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The application-specific Btree prefix callback.</TD>
125 </TR>
126 </TABLE>
127 &nbsp;
128 <P>
129
130 <!-- ============ METHOD DETAIL ========== -->
131
132 <A NAME="method_detail"><!-- --></A>
133 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
134 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
135 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
136 <B>Method Detail</B></FONT></TH>
137 </TR>
138 </TABLE>
139
140 <A NAME="prefix(com.sleepycat.db.Database, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)"><!-- --></A><H3>
141 prefix</H3>
142 <PRE>
143 int <B>prefix</B>(<A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</A>&nbsp;db,
144            <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;dbt1,
145            <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;dbt2)</PRE>
146 <DL>
147 <DD>The application-specific Btree prefix callback.
148     <p>
149 <P>
150 <DD><DL>
151 <DT><B>Parameters:</B><DD><CODE>db</CODE> - The enclosing database handle.<DD><CODE>dbt1</CODE> - A database entry representing a database key.<DD><CODE>dbt2</CODE> - A database entry representing a database key.</DL>
152 </DD>
153 </DL>
154 <!-- ========= END OF CLASS DATA ========= -->
155 <HR>
156
157
158 <!-- ======= START OF BOTTOM NAVBAR ====== -->
159 <A NAME="navbar_bottom"><!-- --></A>
160 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
161 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
162 <TR>
163 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
164 <A NAME="navbar_bottom_firstrow"><!-- --></A>
165 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
166   <TR ALIGN="center" VALIGN="top">
167   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
168   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
169   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
170   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/BtreePrefixCalculator.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
171   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
172   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
173   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
174   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
175   </TR>
176 </TABLE>
177 </TD>
178 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
179 <b>Berkeley DB</b><br><font size="-1"> version 5.3.21</font></EM>
180 </TD>
181 </TR>
182
183 <TR>
184 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
185 &nbsp;<A HREF="../../../com/sleepycat/db/BtreeCompressor.html" title="interface in com.sleepycat.db"><B>PREV CLASS</B></A>&nbsp;
186 &nbsp;<A HREF="../../../com/sleepycat/db/BtreeStats.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD>
187 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
188   <A HREF="../../../index.html?com/sleepycat/db/BtreePrefixCalculator.html" target="_top"><B>FRAMES</B></A>  &nbsp;
189 &nbsp;<A HREF="BtreePrefixCalculator.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
190 &nbsp;<SCRIPT type="text/javascript">
191   <!--
192   if(window==top) {
193     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
194   }
195   //-->
196 </SCRIPT>
197 <NOSCRIPT>
198   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
199 </NOSCRIPT>
200
201
202 </FONT></TD>
203 </TR>
204 <TR>
205 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
206   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
207 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
208 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
209 </TR>
210 </TABLE>
211 <A NAME="skip-navbar_bottom"></A>
212 <!-- ======== END OF BOTTOM NAVBAR ======= -->
213
214 <HR>
215 <font size=1>Copyright (c) 1996, 2012 Oracle and/or its affiliates.  All rights reserved.</font>
216 </BODY>
217 </HTML>