Module: Xapian

Module | Xapian
In: | xapian.rb

# Ruby Xapian bindings

Original version by Paul Legato (plegato@nks.net), 4/20/06.

Copyright (C) 2006 Networked Knowledge Systems, Inc. Copyright (C) 2008,2011 Olly Betts Copyright (C) 2010 Richard Boulton

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.

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.

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

## Underscore methods

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.

It should never be necessary to use any method whose name starts with an underscore from user-level code. Make sure you are VERY certain that you know exactly what you‘re doing if you do use one of these methods. Beware. You‘ve been warned…

### Classes and Modules

Class Xapian::AssertionError
Class Xapian::BM25Weight
Class Xapian::BoolWeight
Class Xapian::Compactor
Class Xapian::Database
Class Xapian::DatabaseCorruptError
Class Xapian::DatabaseCreateError
Class Xapian::DatabaseError
Class Xapian::DatabaseLockError
Class Xapian::DatabaseModifiedError
Class Xapian::DatabaseOpeningError
Class Xapian::DatabaseVersionError
Class Xapian::DateValueRangeProcessor
Class Xapian::DecreasingValueWeightPostingSource
Class Xapian::DocNotFoundError
Class Xapian::Document
Class Xapian::ESet
Class Xapian::ESetIterator
Class Xapian::Enquire
Class Xapian::Error
Class Xapian::ErrorHandler
Class Xapian::ExpandDecider
Class Xapian::ExpandDeciderAnd
Class Xapian::ExpandDeciderFilterTerms
Class Xapian::ExpandTerm
Class Xapian::FeatureUnavailableError
Class Xapian::FixedWeightPostingSource
Class Xapian::InternalError
Class Xapian::InvalidArgumentError
Class Xapian::InvalidOperationError
Class Xapian::KeyMaker
Class Xapian::LogicError
Class Xapian::MSet
Class Xapian::MSetIterator
Class Xapian::Match
Class Xapian::MatchDecider
Class Xapian::MatchSpy
Class Xapian::MultiValueKeyMaker
Class Xapian::MultiValueSorter
Class Xapian::NetworkError
Class Xapian::NetworkTimeoutError
Class Xapian::NumberValueRangeProcessor
Class Xapian::PositionIterator
Class Xapian::Posting
Class Xapian::PostingIterator
Class Xapian::PostingSource
Class Xapian::Query
Class Xapian::QueryParser
Class Xapian::QueryParserError
Class Xapian::RSet
Class Xapian::RangeError
Class Xapian::Registry
Class Xapian::RuntimeError
Class Xapian::SerialisationError
Class Xapian::SimpleStopper
Class Xapian::Sorter
Class Xapian::Stem
Class Xapian::StemImplementation
Class Xapian::Stopper
Class Xapian::StringValueRangeProcessor
Class Xapian::Term
Class Xapian::TermGenerator
Class Xapian::TermIterator
Class Xapian::TradWeight
Class Xapian::UnimplementedError
Class Xapian::Utf8Iterator
Class Xapian::Value
Class Xapian::ValueCountMatchSpy
Class Xapian::ValueIterator
Class Xapian::ValueMapPostingSource
Class Xapian::ValuePostingSource
Class Xapian::ValueRangeProcessor
Class Xapian::ValueSetMatchDecider
Class Xapian::ValueWeightPostingSource
Class Xapian::Weight
Class Xapian::WritableDatabase

[Validate]