<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
<title>Class: Xapian::Xapian::Database</title>
<link rel="stylesheet" href="../../rdoc.css" type="text/css" media="screen" />
<script src="../../js/jquery.js" type="text/javascript" charset="utf-8"></script>
<script src="../../js/thickbox-compressed.js" type="text/javascript" charset="utf-8"></script>
<script src="../../js/quicksearch.js" type="text/javascript" charset="utf-8"></script>
<script src="../../js/darkfish.js" type="text/javascript" charset="utf-8"></script>
</head>
<body id="top" class="class">
<div id="metadata">
<div id="home-metadata">
<div id="home-section" class="section">
<h3 class="section-header">
<a href="../../index.html">Home</a>
<a href="../../index.html#classes">Classes</a>
<a href="../../index.html#methods">Methods</a>
</h3>
</div>
</div>
<div id="file-metadata">
<div id="file-list-section" class="section">
<h3 class="section-header">In Files</h3>
<div class="section-body">
<ul>
<li><a href="../../xapian_rb.html?TB_iframe=true&height=550&width=785"
class="thickbox" title="xapian.rb">xapian.rb</a></li>
</ul>
</div>
</div>
</div>
<div id="class-metadata">
<!-- Parent Class -->
<div id="parent-class-section" class="section">
<h3 class="section-header">Parent</h3>
<p class="link">Object</p>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="section">
<h3 class="section-header">Methods</h3>
<ul class="link-list">
<li><a href="#method-i-allterms">#allterms</a></li>
<li><a href="#method-i-positionlist">#positionlist</a></li>
<li><a href="#method-i-postlist">#postlist</a></li>
<li><a href="#method-i-termlist">#termlist</a></li>
<li><a href="#method-i-valuestream">#valuestream</a></li>
</ul>
</div>
</div>
<div id="project-metadata">
<div id="classindex-section" class="section project-section">
<h3 class="section-header">Class/Module Index
<span class="search-toggle"><img src="../../images/find.png"
height="16" width="16" alt="[+]"
title="show/hide quicksearch" /></span></h3>
<form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
<fieldset>
<legend>Quicksearch</legend>
<input type="text" name="quicksearch" value=""
class="quicksearch-field" />
</fieldset>
</form>
<ul class="link-list">
<li><a href="../../Xapian.html">Xapian</a></li>
<li><a href="../../Xapian/AssertionError.html">Xapian::AssertionError</a></li>
<li><a href="../../Xapian/BM25Weight.html">Xapian::BM25Weight</a></li>
<li><a href="../../Xapian/BoolWeight.html">Xapian::BoolWeight</a></li>
<li><a href="../../Xapian/Compactor.html">Xapian::Compactor</a></li>
<li><a href="../../Xapian/DatabaseCorruptError.html">Xapian::DatabaseCorruptError</a></li>
<li><a href="../../Xapian/DatabaseCreateError.html">Xapian::DatabaseCreateError</a></li>
<li><a href="../../Xapian/DatabaseError.html">Xapian::DatabaseError</a></li>
<li><a href="../../Xapian/DatabaseLockError.html">Xapian::DatabaseLockError</a></li>
<li><a href="../../Xapian/DatabaseModifiedError.html">Xapian::DatabaseModifiedError</a></li>
<li><a href="../../Xapian/DatabaseOpeningError.html">Xapian::DatabaseOpeningError</a></li>
<li><a href="../../Xapian/DatabaseVersionError.html">Xapian::DatabaseVersionError</a></li>
<li><a href="../../Xapian/DateValueRangeProcessor.html">Xapian::DateValueRangeProcessor</a></li>
<li><a href="../../Xapian/DecreasingValueWeightPostingSource.html">Xapian::DecreasingValueWeightPostingSource</a></li>
<li><a href="../../Xapian/DocNotFoundError.html">Xapian::DocNotFoundError</a></li>
<li><a href="../../Xapian/ESetIterator.html">Xapian::ESetIterator</a></li>
<li><a href="../../Xapian/Error.html">Xapian::Error</a></li>
<li><a href="../../Xapian/ErrorHandler.html">Xapian::ErrorHandler</a></li>
<li><a href="../../Xapian/ExpandDecider.html">Xapian::ExpandDecider</a></li>
<li><a href="../../Xapian/ExpandDeciderAnd.html">Xapian::ExpandDeciderAnd</a></li>
<li><a href="../../Xapian/ExpandDeciderFilterTerms.html">Xapian::ExpandDeciderFilterTerms</a></li>
<li><a href="../../Xapian/FeatureUnavailableError.html">Xapian::FeatureUnavailableError</a></li>
<li><a href="../../Xapian/FixedWeightPostingSource.html">Xapian::FixedWeightPostingSource</a></li>
<li><a href="../../Xapian/InternalError.html">Xapian::InternalError</a></li>
<li><a href="../../Xapian/InvalidArgumentError.html">Xapian::InvalidArgumentError</a></li>
<li><a href="../../Xapian/InvalidOperationError.html">Xapian::InvalidOperationError</a></li>
<li><a href="../../Xapian/KeyMaker.html">Xapian::KeyMaker</a></li>
<li><a href="../../Xapian/LogicError.html">Xapian::LogicError</a></li>
<li><a href="../../Xapian/MSetIterator.html">Xapian::MSetIterator</a></li>
<li><a href="../../Xapian/MatchDecider.html">Xapian::MatchDecider</a></li>
<li><a href="../../Xapian/MatchSpy.html">Xapian::MatchSpy</a></li>
<li><a href="../../Xapian/MultiValueKeyMaker.html">Xapian::MultiValueKeyMaker</a></li>
<li><a href="../../Xapian/MultiValueSorter.html">Xapian::MultiValueSorter</a></li>
<li><a href="../../Xapian/NetworkError.html">Xapian::NetworkError</a></li>
<li><a href="../../Xapian/NetworkTimeoutError.html">Xapian::NetworkTimeoutError</a></li>
<li><a href="../../Xapian/NumberValueRangeProcessor.html">Xapian::NumberValueRangeProcessor</a></li>
<li><a href="../../Xapian/PositionIterator.html">Xapian::PositionIterator</a></li>
<li><a href="../../Xapian/PostingIterator.html">Xapian::PostingIterator</a></li>
<li><a href="../../Xapian/PostingSource.html">Xapian::PostingSource</a></li>
<li><a href="../../Xapian/QueryParser.html">Xapian::QueryParser</a></li>
<li><a href="../../Xapian/QueryParserError.html">Xapian::QueryParserError</a></li>
<li><a href="../../Xapian/RSet.html">Xapian::RSet</a></li>
<li><a href="../../Xapian/RangeError.html">Xapian::RangeError</a></li>
<li><a href="../../Xapian/Registry.html">Xapian::Registry</a></li>
<li><a href="../../Xapian/RuntimeError.html">Xapian::RuntimeError</a></li>
<li><a href="../../Xapian/SerialisationError.html">Xapian::SerialisationError</a></li>
<li><a href="../../Xapian/SimpleStopper.html">Xapian::SimpleStopper</a></li>
<li><a href="../../Xapian/Sorter.html">Xapian::Sorter</a></li>
<li><a href="../../Xapian/Stem.html">Xapian::Stem</a></li>
<li><a href="../../Xapian/StemImplementation.html">Xapian::StemImplementation</a></li>
<li><a href="../../Xapian/Stopper.html">Xapian::Stopper</a></li>
<li><a href="../../Xapian/StringValueRangeProcessor.html">Xapian::StringValueRangeProcessor</a></li>
<li><a href="../../Xapian/TermGenerator.html">Xapian::TermGenerator</a></li>
<li><a href="../../Xapian/TermIterator.html">Xapian::TermIterator</a></li>
<li><a href="../../Xapian/TradWeight.html">Xapian::TradWeight</a></li>
<li><a href="../../Xapian/UnimplementedError.html">Xapian::UnimplementedError</a></li>
<li><a href="../../Xapian/Utf8Iterator.html">Xapian::Utf8Iterator</a></li>
<li><a href="../../Xapian/ValueIterator.html">Xapian::ValueIterator</a></li>
<li><a href="../../Xapian/ValueMapPostingSource.html">Xapian::ValueMapPostingSource</a></li>
<li><a href="../../Xapian/ValuePostingSource.html">Xapian::ValuePostingSource</a></li>
<li><a href="../../Xapian/ValueRangeProcessor.html">Xapian::ValueRangeProcessor</a></li>
<li><a href="../../Xapian/ValueSetMatchDecider.html">Xapian::ValueSetMatchDecider</a></li>
<li><a href="../../Xapian/ValueWeightPostingSource.html">Xapian::ValueWeightPostingSource</a></li>
<li><a href="../../Xapian/Weight.html">Xapian::Weight</a></li>
<li><a href="../../Xapian/WritableDatabase.html">Xapian::WritableDatabase</a></li>
<li><a href="../../Xapian/Xapian.html">Xapian::Xapian</a></li>
<li><a href="../../Xapian/Xapian/Database.html">Xapian::Xapian::Database</a></li>
<li><a href="../../Xapian/Xapian/Document.html">Xapian::Xapian::Document</a></li>
<li><a href="../../Xapian/Xapian/ESet.html">Xapian::Xapian::ESet</a></li>
<li><a href="../../Xapian/Xapian/Enquire.html">Xapian::Xapian::Enquire</a></li>
<li><a href="../../Xapian/Xapian/ExpandTerm.html">Xapian::Xapian::ExpandTerm</a></li>
<li><a href="../../Xapian/Xapian/MSet.html">Xapian::Xapian::MSet</a></li>
<li><a href="../../Xapian/Xapian/Match.html">Xapian::Xapian::Match</a></li>
<li><a href="../../Xapian/Xapian/Posting.html">Xapian::Xapian::Posting</a></li>
<li><a href="../../Xapian/Xapian/Query.html">Xapian::Xapian::Query</a></li>
<li><a href="../../Xapian/Xapian/Value.html">Xapian::Xapian::Value</a></li>
<li><a href="../../Xapian/Xapian/ValueCountMatchSpy.html">Xapian::Xapian::ValueCountMatchSpy</a></li>
<li><a href="../../Xapian/Xapian/Xapian.html">Xapian::Xapian::Xapian</a></li>
<li><a href="../../Xapian/Xapian/Xapian/Term.html">Xapian::Xapian::Xapian::Term</a></li>
</ul>
<div id="no-class-search-results" style="display: none;">No matching classes.</div>
</div>
</div>
</div>
<div id="documentation">
<h1 class="class">Xapian::Xapian::Database</h1>
<div id="description" class="description">
<p>Refer to the <a
href="https://xapian.org/docs/apidoc/html/classXapian_1_1Database.html">Xapian::Database
C++ API documentation</a> for methods not specific to Ruby.</p>
</div><!-- description -->
<div id="5Buntitled-5D" class="documentation-section">
<!-- Methods -->
<div id="public-instance-method-details" class="method-section section">
<h3 class="section-header">Public Instance Methods</h3>
<div id="allterms-method" class="method-detail ">
<a name="method-i-allterms"></a>
<div class="method-heading">
<span class="method-name">allterms</span><span
class="method-args">(pref = '')</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns an Array of all Xapian::Terms for this database.</p>
<div class="method-source-code" id="allterms-source">
<pre>
<span class="ruby-comment"># File xapian.rb, line 249</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">allterms</span>(<span class="ruby-identifier">pref</span> = <span class="ruby-string">''</span>)
<span class="ruby-constant">Xapian</span>.<span class="ruby-identifier">_safelyIterate</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">_dangerous_allterms_begin</span>(<span class="ruby-identifier">pref</span>),
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">_dangerous_allterms_end</span>(<span class="ruby-identifier">pref</span>)) { <span class="ruby-operator">|</span><span class="ruby-identifier">item</span><span class="ruby-operator">|</span>
<span class="ruby-constant">Xapian</span><span class="ruby-operator">::</span><span class="ruby-constant">Term</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">item</span>.<span class="ruby-identifier">term</span>, <span class="ruby-value">0</span>, <span class="ruby-identifier">item</span>.<span class="ruby-identifier">termfreq</span>)
}
<span class="ruby-keyword">end</span></pre>
</div><!-- allterms-source -->
</div>
</div><!-- allterms-method -->
<div id="positionlist-method" class="method-detail ">
<a name="method-i-positionlist"></a>
<div class="method-heading">
<span class="method-name">positionlist</span><span
class="method-args">(docid, term)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns an Array of Xapian::Termpos objects for the given term (a String)
in the given docid.</p>
<div class="method-source-code" id="positionlist-source">
<pre>
<span class="ruby-comment"># File xapian.rb, line 275</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">positionlist</span>(<span class="ruby-identifier">docid</span>, <span class="ruby-identifier">term</span>)
<span class="ruby-constant">Xapian</span>.<span class="ruby-identifier">_safelyIterate</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">_dangerous_positionlist_begin</span>(<span class="ruby-identifier">docid</span>, <span class="ruby-identifier">term</span>),
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">_dangerous_positionlist_end</span>(<span class="ruby-identifier">docid</span>, <span class="ruby-identifier">term</span>)) { <span class="ruby-operator">|</span><span class="ruby-identifier">item</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">item</span>.<span class="ruby-identifier">termpos</span>
}
<span class="ruby-keyword">end</span></pre>
</div><!-- positionlist-source -->
</div>
</div><!-- positionlist-method -->
<div id="postlist-method" class="method-detail ">
<a name="method-i-postlist"></a>
<div class="method-heading">
<span class="method-name">postlist</span><span
class="method-args">(term)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns an Array of Xapian::Postings for the given term. term is a string.</p>
<div class="method-source-code" id="postlist-source">
<pre>
<span class="ruby-comment"># File xapian.rb, line 258</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">postlist</span>(<span class="ruby-identifier">term</span>)
<span class="ruby-constant">Xapian</span>.<span class="ruby-identifier">_safelyIterate</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">_dangerous_postlist_begin</span>(<span class="ruby-identifier">term</span>),
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">_dangerous_postlist_end</span>(<span class="ruby-identifier">term</span>)) { <span class="ruby-operator">|</span><span class="ruby-identifier">item</span><span class="ruby-operator">|</span>
<span class="ruby-constant">Xapian</span><span class="ruby-operator">::</span><span class="ruby-constant">Posting</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">item</span>.<span class="ruby-identifier">docid</span>, <span class="ruby-identifier">item</span>.<span class="ruby-identifier">doclength</span>, <span class="ruby-identifier">item</span>.<span class="ruby-identifier">wdf</span>)
}
<span class="ruby-keyword">end</span></pre>
</div><!-- postlist-source -->
</div>
</div><!-- postlist-method -->
<div id="termlist-method" class="method-detail ">
<a name="method-i-termlist"></a>
<div class="method-heading">
<span class="method-name">termlist</span><span
class="method-args">(docid)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns an Array of Terms for the given docid.</p>
<div class="method-source-code" id="termlist-source">
<pre>
<span class="ruby-comment"># File xapian.rb, line 266</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">termlist</span>(<span class="ruby-identifier">docid</span>)
<span class="ruby-constant">Xapian</span>.<span class="ruby-identifier">_safelyIterate</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">_dangerous_termlist_begin</span>(<span class="ruby-identifier">docid</span>),
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">_dangerous_termlist_end</span>(<span class="ruby-identifier">docid</span>)) { <span class="ruby-operator">|</span><span class="ruby-identifier">item</span><span class="ruby-operator">|</span>
<span class="ruby-constant">Xapian</span><span class="ruby-operator">::</span><span class="ruby-constant">Term</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">item</span>.<span class="ruby-identifier">term</span>, <span class="ruby-identifier">item</span>.<span class="ruby-identifier">wdf</span>, <span class="ruby-identifier">item</span>.<span class="ruby-identifier">termfreq</span>)
}
<span class="ruby-keyword">end</span></pre>
</div><!-- termlist-source -->
</div>
</div><!-- termlist-method -->
<div id="valuestream-method" class="method-detail ">
<a name="method-i-valuestream"></a>
<div class="method-heading">
<span class="method-name">valuestream</span><span
class="method-args">(slot)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns an Array of <a href="Value.html">Xapian::Value</a> objects for the
given slot in the database.</p>
<div class="method-source-code" id="valuestream-source">
<pre>
<span class="ruby-comment"># File xapian.rb, line 284</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">valuestream</span>(<span class="ruby-identifier">slot</span>)
<span class="ruby-constant">Xapian</span>.<span class="ruby-identifier">_safelyIterate</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">_dangerous_valuestream_begin</span>(<span class="ruby-identifier">slot</span>),
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">_dangerous_valuestream_end</span>(<span class="ruby-identifier">slot</span>)) { <span class="ruby-operator">|</span><span class="ruby-identifier">item</span><span class="ruby-operator">|</span>
<span class="ruby-constant">Xapian</span><span class="ruby-operator">::</span><span class="ruby-constant">Value</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">item</span>.<span class="ruby-identifier">value</span>, <span class="ruby-identifier">slot</span>, <span class="ruby-identifier">item</span>.<span class="ruby-identifier">docid</span>)
}
<span class="ruby-keyword">end</span></pre>
</div><!-- valuestream-source -->
</div>
</div><!-- valuestream-method -->
</div><!-- public-instance-method-details -->
</div><!-- 5Buntitled-5D -->
</div><!-- documentation -->
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
<p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
Rdoc Generator</a> 2</small>.</p>
</div>
</body>
</html>
distrib
>
Mageia
>
6
>
x86_64
>
media
>
core-release
>
by-pkgid
>
5e0fef68afb85ed69a6f278984a08620
>
files
>
78
