Module: Xapian

### Home Classes Methods

### In Files

- xapian.rb

### Namespace

- MODULE Xapian::Xapian
- CLASS Xapian::AssertionError
- CLASS Xapian::BM25Weight
- CLASS Xapian::BoolWeight
- CLASS Xapian::Compactor
- 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::ESetIterator
- CLASS Xapian::Error
- CLASS Xapian::ErrorHandler
- CLASS Xapian::ExpandDecider
- CLASS Xapian::ExpandDeciderAnd
- CLASS Xapian::ExpandDeciderFilterTerms
- CLASS Xapian::FeatureUnavailableError
- CLASS Xapian::FixedWeightPostingSource
- CLASS Xapian::InternalError
- CLASS Xapian::InvalidArgumentError
- CLASS Xapian::InvalidOperationError
- CLASS Xapian::KeyMaker
- CLASS Xapian::LogicError
- CLASS Xapian::MSetIterator
- 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::PostingIterator
- CLASS Xapian::PostingSource
- 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::TermGenerator
- CLASS Xapian::TermIterator
- CLASS Xapian::TradWeight
- CLASS Xapian::UnimplementedError
- CLASS Xapian::Utf8Iterator
- CLASS Xapian::ValueIterator
- CLASS Xapian::ValueMapPostingSource
- CLASS Xapian::ValuePostingSource
- CLASS Xapian::ValueRangeProcessor
- CLASS Xapian::ValueSetMatchDecider
- CLASS Xapian::ValueWeightPostingSource
- CLASS Xapian::Weight
- CLASS Xapian::WritableDatabase

### Class/Module Index

Quicksearch

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

No matching classes.

# Xapian

# 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…

[Validate]

Generated with the Darkfish Rdoc Generator 2.