<?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>Module: Xapian</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="module">
<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">
<!-- Namespace Contents -->
<div id="namespace-list-section" class="section">
<h3 class="section-header">Namespace</h3>
<ul class="link-list">
<li><span class="type">MODULE</span> <a href="Xapian/Xapian.html">Xapian::Xapian</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/AssertionError.html">Xapian::AssertionError</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/BM25Weight.html">Xapian::BM25Weight</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/BoolWeight.html">Xapian::BoolWeight</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/Compactor.html">Xapian::Compactor</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/DatabaseCorruptError.html">Xapian::DatabaseCorruptError</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/DatabaseCreateError.html">Xapian::DatabaseCreateError</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/DatabaseError.html">Xapian::DatabaseError</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/DatabaseLockError.html">Xapian::DatabaseLockError</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/DatabaseModifiedError.html">Xapian::DatabaseModifiedError</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/DatabaseOpeningError.html">Xapian::DatabaseOpeningError</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/DatabaseVersionError.html">Xapian::DatabaseVersionError</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/DateValueRangeProcessor.html">Xapian::DateValueRangeProcessor</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/DecreasingValueWeightPostingSource.html">Xapian::DecreasingValueWeightPostingSource</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/DocNotFoundError.html">Xapian::DocNotFoundError</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/ESetIterator.html">Xapian::ESetIterator</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/Error.html">Xapian::Error</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/ErrorHandler.html">Xapian::ErrorHandler</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/ExpandDecider.html">Xapian::ExpandDecider</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/ExpandDeciderAnd.html">Xapian::ExpandDeciderAnd</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/ExpandDeciderFilterTerms.html">Xapian::ExpandDeciderFilterTerms</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/FeatureUnavailableError.html">Xapian::FeatureUnavailableError</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/FixedWeightPostingSource.html">Xapian::FixedWeightPostingSource</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/InternalError.html">Xapian::InternalError</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/InvalidArgumentError.html">Xapian::InvalidArgumentError</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/InvalidOperationError.html">Xapian::InvalidOperationError</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/KeyMaker.html">Xapian::KeyMaker</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/LogicError.html">Xapian::LogicError</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/MSetIterator.html">Xapian::MSetIterator</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/MatchDecider.html">Xapian::MatchDecider</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/MatchSpy.html">Xapian::MatchSpy</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/MultiValueKeyMaker.html">Xapian::MultiValueKeyMaker</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/MultiValueSorter.html">Xapian::MultiValueSorter</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/NetworkError.html">Xapian::NetworkError</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/NetworkTimeoutError.html">Xapian::NetworkTimeoutError</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/NumberValueRangeProcessor.html">Xapian::NumberValueRangeProcessor</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/PositionIterator.html">Xapian::PositionIterator</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/PostingIterator.html">Xapian::PostingIterator</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/PostingSource.html">Xapian::PostingSource</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/QueryParser.html">Xapian::QueryParser</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/QueryParserError.html">Xapian::QueryParserError</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/RSet.html">Xapian::RSet</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/RangeError.html">Xapian::RangeError</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/Registry.html">Xapian::Registry</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/RuntimeError.html">Xapian::RuntimeError</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/SerialisationError.html">Xapian::SerialisationError</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/SimpleStopper.html">Xapian::SimpleStopper</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/Sorter.html">Xapian::Sorter</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/Stem.html">Xapian::Stem</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/StemImplementation.html">Xapian::StemImplementation</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/Stopper.html">Xapian::Stopper</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/StringValueRangeProcessor.html">Xapian::StringValueRangeProcessor</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/TermGenerator.html">Xapian::TermGenerator</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/TermIterator.html">Xapian::TermIterator</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/TradWeight.html">Xapian::TradWeight</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/UnimplementedError.html">Xapian::UnimplementedError</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/Utf8Iterator.html">Xapian::Utf8Iterator</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/ValueIterator.html">Xapian::ValueIterator</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/ValueMapPostingSource.html">Xapian::ValueMapPostingSource</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/ValuePostingSource.html">Xapian::ValuePostingSource</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/ValueRangeProcessor.html">Xapian::ValueRangeProcessor</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/ValueSetMatchDecider.html">Xapian::ValueSetMatchDecider</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/ValueWeightPostingSource.html">Xapian::ValueWeightPostingSource</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/Weight.html">Xapian::Weight</a></li>
<li><span class="type">CLASS</span> <a href="Xapian/WritableDatabase.html">Xapian::WritableDatabase</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="module">Xapian</h1>
<div id="description" class="description">
<h1>Ruby <a href="Xapian/Xapian.html">Xapian</a> bindings</h1>
<p>Original version by Paul Legato (plegato@nks.net), 4/20/06.</p>
<p>Copyright (C) 2006 Networked Knowledge Systems, Inc. Copyright (C)
2008,2011 Olly Betts Copyright (C) 2010 Richard Boulton</p>
<p>This program is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the Free
Software Foundation; either version 2 of the License, or (at your option)
any later version.</p>
<p>This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
more details.</p>
<p>You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc., 51
Franklin St, Fifth Floor, Boston, MA 02110-1301 USA</p>
<h2>Underscore methods</h2>
<p>Note: Methods whose names start with an underscore character _ are internal
methods from the C++ API. Their functionality is not accessible in a
Ruby-friendly way, so this file provides wrapper code to make it easier to
use them from a Ruby programming idiom. Most are also dangerous insofar as
misusing them can cause your program to segfault. In particular, all of
Xapian’s *Iterator classes are wrapped into nice Ruby-friendly Arrays.</p>
<p>It should never be necessary to use any method whose name starts with an
underscore from user-level code. Make sure you are <em>VERY</em> certain
that you know exactly what you’re doing if you do use one of these methods.
Beware. You’ve been warned…</p>
</div><!-- description -->
<div id="5Buntitled-5D" class="documentation-section">
<!-- Methods -->
</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
>
11
