| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>BPlusTree (Apache Jena TDB)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: module: org.apache.jena.tdb, package: org.apache.jena.tdb1.index.bplustree, class: BPlusTree"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../../module-summary.html">Module</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/BPlusTree.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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="module-label-in-type">Module</span> <a href="../../../../../../module-summary.html">org.apache.jena.tdb</a></div> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.jena.tdb1.index.bplustree</a></div> |
| <h1 title="Class BPlusTree" class="title">Class BPlusTree</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.jena.tdb1.index.bplustree.BPlusTree</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><<a href="../../base/record/Record.html" title="class in org.apache.jena.tdb1.base.record">Record</a>></code>, <code>org.apache.jena.atlas.lib.Closeable</code>, <code>org.apache.jena.atlas.lib.Sync</code>, <code><a href="../Index.html" title="interface in org.apache.jena.tdb1.index">Index</a></code>, <code><a href="../RangeIndex.html" title="interface in org.apache.jena.tdb1.index">RangeIndex</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">BPlusTree</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| implements <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><<a href="../../base/record/Record.html" title="class in org.apache.jena.tdb1.base.record">Record</a>>, <a href="../RangeIndex.html" title="interface in org.apache.jena.tdb1.index">RangeIndex</a></span></div> |
| <div class="block">B-Tree converted to B+Tree |
| |
| B-Tree taken from: |
| Introduction to Algorithms, Second Edition |
| Chapter 18: B-Trees |
| by Thomas H. Cormen, Charles E. Leiserson, |
| Ronald L. Rivest and Clifford Stein |
| |
| Includes implementation of removal. |
| |
| Notes: |
| Stores "records", which are a key and value (the value may be null). |
| |
| In this B+Tree implementation, the (key,value) pairs are held in |
| RecordBuffer, which wrap a ByteBuffer that only has records in it. |
| BPTreeRecords provides the B+Tree view of a RecordBuffer. All records |
| are in RecordBuffer - the "tree" part is an index for finding the right |
| page. The tree only holds keys, copies from the (key, value) pairs in |
| the RecordBuffers. |
| |
| Notes: |
| |
| The version above splits nodes on the way down when full, |
| not when needed where a split can bubble up from below. |
| It means it only ever walks down the tree on insert. |
| Similarly, the delete code ensures a node is suitable |
| before descending. |
| |
| Variations: |
| In this impl, splitRoot leaves the root node in place. |
| The root is always the same block.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#add(org.apache.jena.tdb1.base.record.Record)" class="member-name-link">add</a><wbr>(<a href="../../base/record/Record.html" title="class in org.apache.jena.tdb1.base.record">Record</a> record)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add a record - return true if an insertion was actually needed</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../base/record/Record.html" title="class in org.apache.jena.tdb1.base.record">Record</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addAndReturnOld(org.apache.jena.tdb1.base.record.Record)" class="member-name-link">addAndReturnOld</a><wbr>(<a href="../../base/record/Record.html" title="class in org.apache.jena.tdb1.base.record">Record</a> record)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add a record into the B+Tree</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="BPlusTree.html" title="class in org.apache.jena.tdb1.index.bplustree">BPlusTree</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#addTracking(org.apache.jena.tdb1.index.bplustree.BPlusTree)" class="member-name-link">addTracking</a><wbr>(<a href="BPlusTree.html" title="class in org.apache.jena.tdb1.index.bplustree">BPlusTree</a> bpTree)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Debugging</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="BPlusTree.html" title="class in org.apache.jena.tdb1.index.bplustree">BPlusTree</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#attach(org.apache.jena.tdb1.index.bplustree.BPlusTreeParams,org.apache.jena.tdb1.base.block.BlockMgr,org.apache.jena.tdb1.base.block.BlockMgr)" class="member-name-link">attach</a><wbr>(<a href="BPlusTreeParams.html" title="class in org.apache.jena.tdb1.index.bplustree">BPlusTreeParams</a> params, |
| <a href="../../base/block/BlockMgr.html" title="interface in org.apache.jena.tdb1.base.block">BlockMgr</a> blkMgrNodes, |
| <a href="../../base/block/BlockMgr.html" title="interface in org.apache.jena.tdb1.base.block">BlockMgr</a> blkMgrRecords)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Create the in-memory structures to correspond to |
| the supplied block managers for the persistent storage.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#check()" class="member-name-link">check</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Perform checks on this index</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clear()" class="member-name-link">clear</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Clear the index</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#close()" class="member-name-link">close</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Close the index - can not be used again through this object</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#contains(org.apache.jena.tdb1.base.record.Record)" class="member-name-link">contains</a><wbr>(<a href="../../base/record/Record.html" title="class in org.apache.jena.tdb1.base.record">Record</a> record)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Return whether the index contains the record or not.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="BPlusTree.html" title="class in org.apache.jena.tdb1.index.bplustree">BPlusTree</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#create(org.apache.jena.tdb1.index.bplustree.BPlusTreeParams,org.apache.jena.tdb1.base.block.BlockMgr,org.apache.jena.tdb1.base.block.BlockMgr)" class="member-name-link">create</a><wbr>(<a href="BPlusTreeParams.html" title="class in org.apache.jena.tdb1.index.bplustree">BPlusTreeParams</a> params, |
| <a href="../../base/block/BlockMgr.html" title="interface in org.apache.jena.tdb1.base.block">BlockMgr</a> blkMgrNodes, |
| <a href="../../base/block/BlockMgr.html" title="interface in org.apache.jena.tdb1.base.block">BlockMgr</a> blkMgrLeaves)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Create the in-memory structures to correspond to |
| the supplied block managers for the persistent storage.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#delete(org.apache.jena.tdb1.base.record.Record)" class="member-name-link">delete</a><wbr>(<a href="../../base/record/Record.html" title="class in org.apache.jena.tdb1.base.record">Record</a> record)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Delete a record.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../base/record/Record.html" title="class in org.apache.jena.tdb1.base.record">Record</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#deleteAndReturnOld(org.apache.jena.tdb1.base.record.Record)" class="member-name-link">deleteAndReturnOld</a><wbr>(<a href="../../base/record/Record.html" title="class in org.apache.jena.tdb1.base.record">Record</a> record)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#dump()" class="member-name-link">dump</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#dump(org.apache.jena.atlas.io.IndentedWriter)" class="member-name-link">dump</a><wbr>(org.apache.jena.atlas.io.IndentedWriter out)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../base/record/Record.html" title="class in org.apache.jena.tdb1.base.record">Record</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#find(org.apache.jena.tdb1.base.record.Record)" class="member-name-link">find</a><wbr>(<a href="../../base/record/Record.html" title="class in org.apache.jena.tdb1.base.record">Record</a> record)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Find one record - and return the record actually in the index (may have a value part)</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="BPTreeNodeMgr.html" title="class in org.apache.jena.tdb1.index.bplustree">BPTreeNodeMgr</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNodeManager()" class="member-name-link">getNodeManager</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Only use for careful manipulation of structures</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="BPlusTreeParams.html" title="class in org.apache.jena.tdb1.index.bplustree">BPlusTreeParams</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getParams()" class="member-name-link">getParams</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the parameters describing this B+Tree</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../base/record/RecordFactory.html" title="class in org.apache.jena.tdb1.base.record">RecordFactory</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRecordFactory()" class="member-name-link">getRecordFactory</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the Record factory associated with this index</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="BPTreeRecordsMgr.html" title="class in org.apache.jena.tdb1.index.bplustree">BPTreeRecordsMgr</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRecordsMgr()" class="member-name-link">getRecordsMgr</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Only use for careful manipulation of structures</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isEmpty()" class="member-name-link">isEmpty</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Answer whether the index is empty or not.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link">Iterator</a><<a href="../../base/record/Record.html" title="class in org.apache.jena.tdb1.base.record">Record</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#iterator()" class="member-name-link">iterator</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Iterate over the whole index</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link">Iterator</a><<a href="../../base/record/Record.html" title="class in org.apache.jena.tdb1.base.record">Record</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#iterator(org.apache.jena.tdb1.base.record.Record,org.apache.jena.tdb1.base.record.Record)" class="member-name-link">iterator</a><wbr>(<a href="../../base/record/Record.html" title="class in org.apache.jena.tdb1.base.record">Record</a> fromRec, |
| <a href="../../base/record/Record.html" title="class in org.apache.jena.tdb1.base.record">Record</a> toRec)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Return records between min (inclusive) and max (exclusive), based on the record keys</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="BPlusTree.html" title="class in org.apache.jena.tdb1.index.bplustree">BPlusTree</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#makeMem(int,int,int,int)" class="member-name-link">makeMem</a><wbr>(int order, |
| int minRecords, |
| int keyLength, |
| int valueLength)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">(Testing mainly) Make an in-memory B+Tree, with copy-in, copy-out block managers</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="BPlusTree.html" title="class in org.apache.jena.tdb1.index.bplustree">BPlusTree</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#makeMem(java.lang.String,int,int,int,int)" class="member-name-link">makeMem</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| int order, |
| int minRecords, |
| int keyLength, |
| int valueLength)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">(Testing mainly) Make an in-memory B+Tree, with copy-in, copy-out block managers</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../base/record/Record.html" title="class in org.apache.jena.tdb1.base.record">Record</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#maxKey()" class="member-name-link">maxKey</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Return the record containing the greatest key - may or may not have the associated value</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../base/record/Record.html" title="class in org.apache.jena.tdb1.base.record">Record</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#minKey()" class="member-name-link">minKey</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Return the record containing the least key - may or may not have the associated value</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#size()" class="member-name-link">size</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Return size if known else return -1 : does not count the persistent storage</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#sync()" class="member-name-link">sync</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Iterable">Methods inherited from interface java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html#forEach(java.util.function.Consumer)" title="class or interface in java.lang" class="external-link">forEach</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html#spliterator()" title="class or interface in java.lang" class="external-link">spliterator</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="create(org.apache.jena.tdb1.index.bplustree.BPlusTreeParams,org.apache.jena.tdb1.base.block.BlockMgr,org.apache.jena.tdb1.base.block.BlockMgr)"> |
| <h3>create</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="BPlusTree.html" title="class in org.apache.jena.tdb1.index.bplustree">BPlusTree</a></span> <span class="element-name">create</span><wbr><span class="parameters">(<a href="BPlusTreeParams.html" title="class in org.apache.jena.tdb1.index.bplustree">BPlusTreeParams</a> params, |
| <a href="../../base/block/BlockMgr.html" title="interface in org.apache.jena.tdb1.base.block">BlockMgr</a> blkMgrNodes, |
| <a href="../../base/block/BlockMgr.html" title="interface in org.apache.jena.tdb1.base.block">BlockMgr</a> blkMgrLeaves)</span></div> |
| <div class="block">Create the in-memory structures to correspond to |
| the supplied block managers for the persistent storage. |
| Initialize the persistent storage to the empty B+Tree if it does not exist. |
| This is the normal way to create a B+Tree.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="attach(org.apache.jena.tdb1.index.bplustree.BPlusTreeParams,org.apache.jena.tdb1.base.block.BlockMgr,org.apache.jena.tdb1.base.block.BlockMgr)"> |
| <h3>attach</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="BPlusTree.html" title="class in org.apache.jena.tdb1.index.bplustree">BPlusTree</a></span> <span class="element-name">attach</span><wbr><span class="parameters">(<a href="BPlusTreeParams.html" title="class in org.apache.jena.tdb1.index.bplustree">BPlusTreeParams</a> params, |
| <a href="../../base/block/BlockMgr.html" title="interface in org.apache.jena.tdb1.base.block">BlockMgr</a> blkMgrNodes, |
| <a href="../../base/block/BlockMgr.html" title="interface in org.apache.jena.tdb1.base.block">BlockMgr</a> blkMgrRecords)</span></div> |
| <div class="block">Create the in-memory structures to correspond to |
| the supplied block managers for the persistent storage. |
| Does not initialize the B+Tree - it assumes the block managers |
| correspond to an existing B+Tree.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="makeMem(int,int,int,int)"> |
| <h3>makeMem</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="BPlusTree.html" title="class in org.apache.jena.tdb1.index.bplustree">BPlusTree</a></span> <span class="element-name">makeMem</span><wbr><span class="parameters">(int order, |
| int minRecords, |
| int keyLength, |
| int valueLength)</span></div> |
| <div class="block">(Testing mainly) Make an in-memory B+Tree, with copy-in, copy-out block managers</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="makeMem(java.lang.String,int,int,int,int)"> |
| <h3>makeMem</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="BPlusTree.html" title="class in org.apache.jena.tdb1.index.bplustree">BPlusTree</a></span> <span class="element-name">makeMem</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| int order, |
| int minRecords, |
| int keyLength, |
| int valueLength)</span></div> |
| <div class="block">(Testing mainly) Make an in-memory B+Tree, with copy-in, copy-out block managers</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addTracking(org.apache.jena.tdb1.index.bplustree.BPlusTree)"> |
| <h3>addTracking</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="BPlusTree.html" title="class in org.apache.jena.tdb1.index.bplustree">BPlusTree</a></span> <span class="element-name">addTracking</span><wbr><span class="parameters">(<a href="BPlusTree.html" title="class in org.apache.jena.tdb1.index.bplustree">BPlusTree</a> bpTree)</span></div> |
| <div class="block">Debugging</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getParams()"> |
| <h3>getParams</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="BPlusTreeParams.html" title="class in org.apache.jena.tdb1.index.bplustree">BPlusTreeParams</a></span> <span class="element-name">getParams</span>()</div> |
| <div class="block">Get the parameters describing this B+Tree</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getNodeManager()"> |
| <h3>getNodeManager</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="BPTreeNodeMgr.html" title="class in org.apache.jena.tdb1.index.bplustree">BPTreeNodeMgr</a></span> <span class="element-name">getNodeManager</span>()</div> |
| <div class="block">Only use for careful manipulation of structures</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRecordsMgr()"> |
| <h3>getRecordsMgr</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="BPTreeRecordsMgr.html" title="class in org.apache.jena.tdb1.index.bplustree">BPTreeRecordsMgr</a></span> <span class="element-name">getRecordsMgr</span>()</div> |
| <div class="block">Only use for careful manipulation of structures</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRecordFactory()"> |
| <h3>getRecordFactory</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../base/record/RecordFactory.html" title="class in org.apache.jena.tdb1.base.record">RecordFactory</a></span> <span class="element-name">getRecordFactory</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../Index.html#getRecordFactory()">Index</a></code></span></div> |
| <div class="block">Get the Record factory associated with this index</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../Index.html#getRecordFactory()">getRecordFactory</a></code> in interface <code><a href="../Index.html" title="interface in org.apache.jena.tdb1.index">Index</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="find(org.apache.jena.tdb1.base.record.Record)"> |
| <h3>find</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../base/record/Record.html" title="class in org.apache.jena.tdb1.base.record">Record</a></span> <span class="element-name">find</span><wbr><span class="parameters">(<a href="../../base/record/Record.html" title="class in org.apache.jena.tdb1.base.record">Record</a> record)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../Index.html#find(org.apache.jena.tdb1.base.record.Record)">Index</a></code></span></div> |
| <div class="block">Find one record - and return the record actually in the index (may have a value part)</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../Index.html#find(org.apache.jena.tdb1.base.record.Record)">find</a></code> in interface <code><a href="../Index.html" title="interface in org.apache.jena.tdb1.index">Index</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="contains(org.apache.jena.tdb1.base.record.Record)"> |
| <h3>contains</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">contains</span><wbr><span class="parameters">(<a href="../../base/record/Record.html" title="class in org.apache.jena.tdb1.base.record">Record</a> record)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../Index.html#contains(org.apache.jena.tdb1.base.record.Record)">Index</a></code></span></div> |
| <div class="block">Return whether the index contains the record or not.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../Index.html#contains(org.apache.jena.tdb1.base.record.Record)">contains</a></code> in interface <code><a href="../Index.html" title="interface in org.apache.jena.tdb1.index">Index</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="minKey()"> |
| <h3>minKey</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../base/record/Record.html" title="class in org.apache.jena.tdb1.base.record">Record</a></span> <span class="element-name">minKey</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../RangeIndex.html#minKey()">RangeIndex</a></code></span></div> |
| <div class="block">Return the record containing the least key - may or may not have the associated value</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../RangeIndex.html#minKey()">minKey</a></code> in interface <code><a href="../RangeIndex.html" title="interface in org.apache.jena.tdb1.index">RangeIndex</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="maxKey()"> |
| <h3>maxKey</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../base/record/Record.html" title="class in org.apache.jena.tdb1.base.record">Record</a></span> <span class="element-name">maxKey</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../RangeIndex.html#maxKey()">RangeIndex</a></code></span></div> |
| <div class="block">Return the record containing the greatest key - may or may not have the associated value</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../RangeIndex.html#maxKey()">maxKey</a></code> in interface <code><a href="../RangeIndex.html" title="interface in org.apache.jena.tdb1.index">RangeIndex</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="add(org.apache.jena.tdb1.base.record.Record)"> |
| <h3>add</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">add</span><wbr><span class="parameters">(<a href="../../base/record/Record.html" title="class in org.apache.jena.tdb1.base.record">Record</a> record)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../Index.html#add(org.apache.jena.tdb1.base.record.Record)">Index</a></code></span></div> |
| <div class="block">Add a record - return true if an insertion was actually needed</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../Index.html#add(org.apache.jena.tdb1.base.record.Record)">add</a></code> in interface <code><a href="../Index.html" title="interface in org.apache.jena.tdb1.index">Index</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addAndReturnOld(org.apache.jena.tdb1.base.record.Record)"> |
| <h3>addAndReturnOld</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../base/record/Record.html" title="class in org.apache.jena.tdb1.base.record">Record</a></span> <span class="element-name">addAndReturnOld</span><wbr><span class="parameters">(<a href="../../base/record/Record.html" title="class in org.apache.jena.tdb1.base.record">Record</a> record)</span></div> |
| <div class="block">Add a record into the B+Tree</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="delete(org.apache.jena.tdb1.base.record.Record)"> |
| <h3>delete</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">delete</span><wbr><span class="parameters">(<a href="../../base/record/Record.html" title="class in org.apache.jena.tdb1.base.record">Record</a> record)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../Index.html#delete(org.apache.jena.tdb1.base.record.Record)">Index</a></code></span></div> |
| <div class="block">Delete a record. Return true if a record was actually removed</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../Index.html#delete(org.apache.jena.tdb1.base.record.Record)">delete</a></code> in interface <code><a href="../Index.html" title="interface in org.apache.jena.tdb1.index">Index</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="deleteAndReturnOld(org.apache.jena.tdb1.base.record.Record)"> |
| <h3>deleteAndReturnOld</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../base/record/Record.html" title="class in org.apache.jena.tdb1.base.record">Record</a></span> <span class="element-name">deleteAndReturnOld</span><wbr><span class="parameters">(<a href="../../base/record/Record.html" title="class in org.apache.jena.tdb1.base.record">Record</a> record)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="iterator()"> |
| <h3>iterator</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link">Iterator</a><<a href="../../base/record/Record.html" title="class in org.apache.jena.tdb1.base.record">Record</a>></span> <span class="element-name">iterator</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../Index.html#iterator()">Index</a></code></span></div> |
| <div class="block">Iterate over the whole index</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../Index.html#iterator()">iterator</a></code> in interface <code><a href="../Index.html" title="interface in org.apache.jena.tdb1.index">Index</a></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html#iterator()" title="class or interface in java.lang" class="external-link">iterator</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><<a href="../../base/record/Record.html" title="class in org.apache.jena.tdb1.base.record">Record</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="iterator(org.apache.jena.tdb1.base.record.Record,org.apache.jena.tdb1.base.record.Record)"> |
| <h3>iterator</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link">Iterator</a><<a href="../../base/record/Record.html" title="class in org.apache.jena.tdb1.base.record">Record</a>></span> <span class="element-name">iterator</span><wbr><span class="parameters">(<a href="../../base/record/Record.html" title="class in org.apache.jena.tdb1.base.record">Record</a> fromRec, |
| <a href="../../base/record/Record.html" title="class in org.apache.jena.tdb1.base.record">Record</a> toRec)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../RangeIndex.html#iterator(org.apache.jena.tdb1.base.record.Record,org.apache.jena.tdb1.base.record.Record)">RangeIndex</a></code></span></div> |
| <div class="block">Return records between min (inclusive) and max (exclusive), based on the record keys</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../RangeIndex.html#iterator(org.apache.jena.tdb1.base.record.Record,org.apache.jena.tdb1.base.record.Record)">iterator</a></code> in interface <code><a href="../RangeIndex.html" title="interface in org.apache.jena.tdb1.index">RangeIndex</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isEmpty()"> |
| <h3>isEmpty</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isEmpty</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../Index.html#isEmpty()">Index</a></code></span></div> |
| <div class="block">Answer whether the index is empty or not. May return false for unknown or meaningless</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../Index.html#isEmpty()">isEmpty</a></code> in interface <code><a href="../Index.html" title="interface in org.apache.jena.tdb1.index">Index</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="clear()"> |
| <h3>clear</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">clear</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../Index.html#clear()">Index</a></code></span></div> |
| <div class="block">Clear the index</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../Index.html#clear()">clear</a></code> in interface <code><a href="../Index.html" title="interface in org.apache.jena.tdb1.index">Index</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="sync()"> |
| <h3>sync</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">sync</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>sync</code> in interface <code>org.apache.jena.atlas.lib.Sync</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="close()"> |
| <h3>close</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">close</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../Index.html#close()">Index</a></code></span></div> |
| <div class="block">Close the index - can not be used again through this object</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>close</code> in interface <code>org.apache.jena.atlas.lib.Closeable</code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../Index.html#close()">close</a></code> in interface <code><a href="../Index.html" title="interface in org.apache.jena.tdb1.index">Index</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="size()"> |
| <h3>size</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">size</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../Index.html#size()">Index</a></code></span></div> |
| <div class="block">Return size if known else return -1 : does not count the persistent storage</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../Index.html#size()">size</a></code> in interface <code><a href="../Index.html" title="interface in org.apache.jena.tdb1.index">Index</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="check()"> |
| <h3>check</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">check</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../Index.html#check()">Index</a></code></span></div> |
| <div class="block">Perform checks on this index</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../Index.html#check()">check</a></code> in interface <code><a href="../Index.html" title="interface in org.apache.jena.tdb1.index">Index</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="dump()"> |
| <h3>dump</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">dump</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="dump(org.apache.jena.atlas.io.IndentedWriter)"> |
| <h3>dump</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">dump</span><wbr><span class="parameters">(org.apache.jena.atlas.io.IndentedWriter out)</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Licensed under the Apache License, Version 2.0</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
