admin/yasuhirokimura-db18
1
0
Fork 0
mirror of https://github.com/yasuhirokimura/db18 synced 2026-06-08 18:29:23 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
master
yasuhirokimura-db18/docs/java/com/sleepycat/db/BtreeCompressor.html
T
Yasuhiro KIMURA 9678929700 Update to 18.1.40
2020-07-24 01:10:28 +09:00

314 lines
14 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.7) on Mon Jun 01 06:40:53 PDT 2020 -->
<title>BtreeCompressor (Oracle - Berkeley DB Java API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="date" content="2020-06-01">
<link rel="stylesheet" type="text/css" href="../../../style.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
<script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../jquery/jquery-3.4.1.js"></script>
<script type="text/javascript" src="../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="BtreeCompressor (Oracle - Berkeley DB Java API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/BtreeCompressor.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Berkeley DB</b><br><font size="-1"> version 18.1.40</font></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">com.sleepycat.db</a></div>
<h2 title="Interface BtreeCompressor" class="title">Interface BtreeCompressor</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public interface <span class="typeNameLabel">BtreeCompressor</span></pre>
<div class="block">An interface specifying how Btree compression works.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#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></span>&#8203;(<a href="Database.html" title="class in com.sleepycat.db">Database</a>&nbsp;db,
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a>&nbsp;prevKey,
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a>&nbsp;prevData,
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a>&nbsp;key,
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a>&nbsp;data,
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a>&nbsp;dest)</code></th>
<td class="colLast">
<div class="block">The application-specific Btree compress callback.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#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></span>&#8203;(<a href="Database.html" title="class in com.sleepycat.db">Database</a>&nbsp;db,
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a>&nbsp;prevKey,
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a>&nbsp;prevData,
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a>&nbsp;compressed,
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a>&nbsp;key,
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a>&nbsp;data)</code></th>
<td class="colLast">
<div class="block">The application-specific Btree decompress callback.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<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>
<ul class="blockList">
<li class="blockList">
<h4>compress</h4>
<pre class="methodSignature">boolean&nbsp;compress&#8203;(<a href="Database.html" title="class in com.sleepycat.db">Database</a>&nbsp;db,
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a>&nbsp;prevKey,
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a>&nbsp;prevData,
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a>&nbsp;key,
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a>&nbsp;data,
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a>&nbsp;dest)</pre>
<div class="block">The application-specific Btree compress callback.
<p>
The compress function must return true on success and false on failure. If
the compressed data is larger than dest.getUserBufferLength() the function
should set the required length in the dest DatabaseEntry via setSize and
return false.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>db</code> - The enclosing database handle.</dd>
<dd><code>prevKey</code> - A database entry representing the previous key from the compressed stream.</dd>
<dd><code>prevData</code> - A database entry representing the data matching prevKey key entry.</dd>
<dd><code>key</code> - A database entry representing representing the application supplied key.</dd>
<dd><code>data</code> - A database entry representing representing the application supplied data.</dd>
<dd><code>dest</code> - A database entry representing the data stored in the tree. This is where
the callback function should write the compressed data.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true on success and false on failure</dd>
</dl>
</li>
</ul>
<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>
<ul class="blockListLast">
<li class="blockList">
<h4>decompress</h4>
<pre class="methodSignature">boolean&nbsp;decompress&#8203;(<a href="Database.html" title="class in com.sleepycat.db">Database</a>&nbsp;db,
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a>&nbsp;prevKey,
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a>&nbsp;prevData,
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a>&nbsp;compressed,
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a>&nbsp;key,
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a>&nbsp;data)</pre>
<div class="block">The application-specific Btree decompress callback.
<p>
The decompress function must return true on success, and false on failure.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>db</code> - The enclosing database handle.</dd>
<dd><code>prevKey</code> - A database entry representing the previous key from the compressed stream.</dd>
<dd><code>prevData</code> - A database entry representing the data matching prevKey key entry.</dd>
<dd><code>compressed</code> - A database entry representing the data stored in the tree. That is the
compressed data.</dd>
<dd><code>key</code> - A database entry representing representing the application supplied key.</dd>
<dd><code>data</code> - A database entry representing representing the application supplied data.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true on success and false on failure</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/BtreeCompressor.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Berkeley DB</b><br><font size="-1"> version 18.1.40</font></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><font size=1>Copyright (c) 1996, 2020 Oracle and/or its affiliates. All rights reserved.</font></small></p>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink