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_03) on Mon Apr 12 16:25:44 EDT 2010 --> 6<TITLE> 7BtreeCompressor (Oracle - Berkeley DB Java API) 8</TITLE> 9 10<META NAME="date" CONTENT="2010-04-12"> 11 12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../style.css" TITLE="Style"> 13 14<SCRIPT type="text/javascript"> 15function windowTitle() 16{ 17 if (location.href.indexOf('is-external=true') == -1) { 18 parent.document.title="BtreeCompressor (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> </TD> 41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 42 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/BtreeCompressor.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </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 4.8.30</font></EM> 53</TD> 54</TR> 55 56<TR> 57<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 58 PREV CLASS 59 <A HREF="../../../com/sleepycat/db/BtreePrefixCalculator.html" title="interface 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/BtreeCompressor.html" target="_top"><B>FRAMES</B></A> 62 <A HREF="BtreeCompressor.html" target="_top"><B>NO FRAMES</B></A> 63 <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: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> 80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 81DETAIL: FIELD | CONSTR | <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"> 91com.sleepycat.db</FONT> 92<BR> 93Interface BtreeCompressor</H2> 94<HR> 95<DL> 96<DT><PRE>public interface <B>BtreeCompressor</B></DL> 97</PRE> 98 99<P> 100An interface specifying how Btree compression works. 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> boolean</CODE></FONT></TD> 119<TD><CODE><B><A HREF="../../../com/sleepycat/db/BtreeCompressor.html#compress(com.sleepycat.db.Database, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)">compress</A></B>(<A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</A> db, 120 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> prevKey, 121 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> prevData, 122 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key, 123 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data, 124 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> dest)</CODE> 125 126<BR> 127 The application-specific Btree compress callback.</TD> 128</TR> 129<TR BGCOLOR="white" CLASS="TableRowColor"> 130<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 131<CODE> boolean</CODE></FONT></TD> 132<TD><CODE><B><A HREF="../../../com/sleepycat/db/BtreeCompressor.html#decompress(com.sleepycat.db.Database, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)">decompress</A></B>(<A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</A> db, 133 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> prevKey, 134 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> prevData, 135 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> compressed, 136 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key, 137 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data)</CODE> 138 139<BR> 140 The application-specific Btree decompress callback.</TD> 141</TR> 142</TABLE> 143 144<P> 145 146<!-- ============ METHOD DETAIL ========== --> 147 148<A NAME="method_detail"><!-- --></A> 149<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 150<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 151<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 152<B>Method Detail</B></FONT></TH> 153</TR> 154</TABLE> 155 156<A NAME="compress(com.sleepycat.db.Database, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)"><!-- --></A><H3> 157compress</H3> 158<PRE> 159boolean <B>compress</B>(<A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</A> db, 160 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> prevKey, 161 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> prevData, 162 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key, 163 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data, 164 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> dest)</PRE> 165<DL> 166<DD>The application-specific Btree compress callback. 167 <p> 168 The compress function must return true on success and false on failure. If 169 the compressed data is larger than dest.getUserBufferLength() the function 170 should set the required length in the dest DatabaseEntry via setSize and 171 return false. 172 <p> 173<P> 174<DD><DL> 175<DT><B>Parameters:</B><DD><CODE>db</CODE> - The enclosing database handle.<DD><CODE>prevKey</CODE> - A database entry representing the previous key from the compressed stream.<DD><CODE>prevData</CODE> - A database entry representing the data matching prevKey key entry.<DD><CODE>key</CODE> - A database entry representing representing the application supplied key.<DD><CODE>data</CODE> - A database entry representing representing the application supplied data.<DD><CODE>dest</CODE> - A database entry representing the data stored in the tree. This is where 176 the callback function should write the compressed data.</DL> 177</DD> 178</DL> 179<HR> 180 181<A NAME="decompress(com.sleepycat.db.Database, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)"><!-- --></A><H3> 182decompress</H3> 183<PRE> 184boolean <B>decompress</B>(<A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</A> db, 185 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> prevKey, 186 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> prevData, 187 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> compressed, 188 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key, 189 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data)</PRE> 190<DL> 191<DD>The application-specific Btree decompress callback. 192 <p> 193 The decompress function must return true on success, and false on failure. 194 <p> 195<P> 196<DD><DL> 197<DT><B>Parameters:</B><DD><CODE>db</CODE> - The enclosing database handle.<DD><CODE>prevKey</CODE> - A database entry representing the previous key from the compressed stream.<DD><CODE>prevData</CODE> - A database entry representing the data matching prevKey key entry.<DD><CODE>compressed</CODE> - A database entry representing the data stored in the tree. That is the 198 compressed data.<DD><CODE>key</CODE> - A database entry representing representing the application supplied key.<DD><CODE>data</CODE> - A database entry representing representing the application supplied data.</DL> 199</DD> 200</DL> 201<!-- ========= END OF CLASS DATA ========= --> 202<HR> 203 204 205<!-- ======= START OF BOTTOM NAVBAR ====== --> 206<A NAME="navbar_bottom"><!-- --></A> 207<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 208<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 209<TR> 210<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 211<A NAME="navbar_bottom_firstrow"><!-- --></A> 212<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 213 <TR ALIGN="center" VALIGN="top"> 214 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 215 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 216 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 217 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/BtreeCompressor.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 218 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 219 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 220 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 221 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 222 </TR> 223</TABLE> 224</TD> 225<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 226<b>Berkeley DB</b><br><font size="-1"> version 4.8.30</font></EM> 227</TD> 228</TR> 229 230<TR> 231<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 232 PREV CLASS 233 <A HREF="../../../com/sleepycat/db/BtreePrefixCalculator.html" title="interface in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD> 234<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 235 <A HREF="../../../index.html?com/sleepycat/db/BtreeCompressor.html" target="_top"><B>FRAMES</B></A> 236 <A HREF="BtreeCompressor.html" target="_top"><B>NO FRAMES</B></A> 237 <SCRIPT type="text/javascript"> 238 <!-- 239 if(window==top) { 240 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); 241 } 242 //--> 243</SCRIPT> 244<NOSCRIPT> 245 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> 246</NOSCRIPT> 247 248 249</FONT></TD> 250</TR> 251<TR> 252<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 253 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> 254<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 255DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> 256</TR> 257</TABLE> 258<A NAME="skip-navbar_bottom"></A> 259<!-- ======== END OF BOTTOM NAVBAR ======= --> 260 261<HR> 262<font size=1>Copyright (c) 1996-2009 Oracle. All rights reserved.</font> 263</BODY> 264</HTML> 265