Xapian Namespace Reference

The Xapian namespace contains public interfaces for the Xapian library. More...


Namespaces

namespace  Auto
 Database factory functions which determine the database type automatically.
namespace  Brass
 Database factory functions for the brass backend.
namespace  Chert
 Database factory functions for the chert backend.
namespace  Flint
 Database factory functions for the flint backend.
namespace  InMemory
 Database factory functions for the inmemory backend.
namespace  Internal
namespace  Remote
 Database factory functions for the remote backend.
namespace  Unicode
 Functions associated with handling Unicode characters.

Classes

class  ByQueryIndexCmp
class  BitWriter
class  BitReader
class  DatabaseReplicator
 Base class for database replicator objects. More...
struct  ReplicationInfo
 Information about the steps involved in performing a replication. More...
class  DatabaseMaster
 Access to a master database for replication. More...
class  DatabaseReplica
 Access to a database replica, for applying replication to it. More...
struct  delete_ptr
struct  CompareTermListSizeAscending
class  Compactor
 Compact a database, or merge and compact several. More...
class  Database
 This class is used to access a database, or a group of databases. More...
class  WritableDatabase
 This class provides read/write access to a database. More...
class  DerefWrapper_
class  Document
 A handle representing a document in a Xapian database. More...
class  MSet
 A match set (MSet). More...
class  MSetIterator
 An iterator pointing to items in an MSet. More...
class  ESet
 Class representing an ordered set of expand terms (an ESet). More...
class  ESetIterator
 Iterate through terms in the ESet. More...
class  RSet
 A relevance set (R-Set). More...
class  MatchDecider
 Base class for matcher decision functor. More...
class  Enquire
 This class provides an interface to the information retrieval system for the purpose of searching. More...
class  Error
 All exceptions thrown by Xapian are subclasses of Xapian::Error. More...
class  LogicError
 The base class for exceptions indicating errors in the program logic. More...
class  RuntimeError
 The base class for exceptions indicating errors only detectable at runtime. More...
class  AssertionError
 AssertionError is thrown if a logical assertion inside Xapian fails. More...
class  InvalidArgumentError
 InvalidArgumentError indicates an invalid parameter value was passed to the API. More...
class  InvalidOperationError
 InvalidOperationError indicates the API was used in an invalid way. More...
class  UnimplementedError
 UnimplementedError indicates an attempt to use an unimplemented feature. More...
class  DatabaseError
 DatabaseError indicates some sort of database related error. More...
class  DatabaseCorruptError
 DatabaseCorruptError indicates database corruption was detected. More...
class  DatabaseCreateError
 DatabaseCreateError indicates a failure to create a database. More...
class  DatabaseLockError
 DatabaseLockError indicates failure to lock a database. More...
class  DatabaseModifiedError
 DatabaseModifiedError indicates a database was modified. More...
class  DatabaseOpeningError
 DatabaseOpeningError indicates failure to open a database. More...
class  DatabaseVersionError
 DatabaseVersionError indicates that a database is in an unsupported format. More...
class  DocNotFoundError
 Indicates an attempt to access a document not present in the database. More...
class  FeatureUnavailableError
 Indicates an attempt to use a feature which is unavailable. More...
class  InternalError
 InternalError indicates a runtime problem of some sort. More...
class  NetworkError
 Indicates a problem communicating with a remote database. More...
class  NetworkTimeoutError
 Indicates a timeout expired while communicating with a remote database. More...
class  QueryParserError
 Indicates a query string can't be parsed. More...
class  SerialisationError
 Indicates an error in the std::string serialisation of an object. More...
class  RangeError
 RangeError indicates an attempt to access outside the bounds of a container. More...
class  ErrorHandler
 Decide if a Xapian::Error exception should be ignored. More...
class  ExpandDecider
 Virtual base class for expand decider functor. More...
class  ExpandDeciderAnd
 ExpandDecider subclass which rejects terms using two ExpandDeciders. More...
class  ExpandDeciderFilterTerms
 ExpandDecider subclass which rejects terms in a specified list. More...
class  KeyMaker
 Virtual base class for key making functors. More...
class  MultiValueKeyMaker
 KeyMaker subclass which combines several values. More...
class  Sorter
 Virtual base class for sorter functor. More...
class  MultiValueSorter
 Sorter subclass which sorts by a several values. More...
class  MatchSpy
 Abstract base class for match spies. More...
class  ValueCountMatchSpy
 Class for counting the frequencies of values in the matching documents. More...
class  PositionIterator
 An iterator pointing to items in a list of positions. More...
class  PostingIterator
 An iterator pointing to items in a list of postings. More...
class  PostingSource
 Base class which provides an "external" source of postings. More...
class  ValuePostingSource
 A posting source which generates weights from a value slot. More...
class  ValueWeightPostingSource
 A posting source which reads weights from a value slot. More...
class  DecreasingValueWeightPostingSource
 Read weights from a value which is known to decrease as docid increases. More...
class  ValueMapPostingSource
 A posting source which looks up weights in a map using values as the key. More...
class  FixedWeightPostingSource
 A posting source which returns a fixed weight for all documents. More...
class  Query
 Class representing a query. More...
class  Stopper
 Base class for stop-word decision functor. More...
class  SimpleStopper
 Simple implementation of Stopper class - this will suit most users. More...
struct  ValueRangeProcessor
 Base class for value range processors. More...
class  StringValueRangeProcessor
 Handle a string range. More...
class  DateValueRangeProcessor
 Handle a date range. More...
class  NumberValueRangeProcessor
 Handle a number range. More...
class  QueryParser
 Build a Xapian::Query object from a user query string. More...
class  Registry
 Registry for user subclasses. More...
struct  StemImplementation
 Class representing a stemming algorithm implementation. More...
class  Stem
 Class representing a stemming algorithm. More...
class  TermGenerator
 Parses a piece of text and generate terms. More...
class  TermIterator
 An iterator pointing to items in a list of terms. More...
class  Utf8Iterator
 An iterator which returns Unicode character values from a UTF-8 encoded string. More...
class  ValueIteratorEnd_
class  ValueIterator
 Class for iterating over document values. More...
class  ValueSetMatchDecider
 MatchDecider filtering results based on whether document values are in a user-defined set. More...
class  Weight
 Abstract base class for weighting schemes. More...
class  BoolWeight
 Class implementing a "boolean" weighting scheme. More...
class  BM25Weight
 Xapian::Weight subclass implementing the BM25 probabilistic formula. More...
class  TradWeight
 Xapian::Weight subclass implementing the traditional probabilistic formula. More...
class  InternalStemDanish
class  InternalStemDutch
class  InternalStemEnglish
class  InternalStemFinnish
class  InternalStemFrench
class  InternalStemGerman
class  InternalStemGerman2
class  InternalStemHungarian
class  InternalStemItalian
class  InternalStemKraaij_pohlmann
class  InternalStemLovins
class  InternalStemNorwegian
class  InternalStemPorter
class  InternalStemPortuguese
class  InternalStemRomanian
class  InternalStemRussian
class  InternalStemSpanish
class  SnowballStemImplementation
class  InternalStemSwedish
class  InternalStemTurkish

Typedefs

typedef unsigned doccount
 A count of documents.
typedef int doccount_diff
 A signed difference between two counts of documents.
typedef unsigned docid
 A unique identifier for a document.
typedef double doclength
 A normalised document length.
typedef int percent
 The percentage score for a document in an MSet.
typedef unsigned termcount
 A counts of terms.
typedef int termcount_diff
 A signed difference between two counts of terms.
typedef unsigned termpos
 A term position within a document or query.
typedef int termpos_diff
 A signed difference between two term positions.
typedef unsigned timeout
 A timeout value in milliseconds.
typedef unsigned valueno
 The number for a value slot in a document.
typedef int valueno_diff
 A signed difference between two value slot numbers.
typedef double weight
 The weight of a document or term.

Functions

static int freq_edit_lower_bound (const vector< unsigned > &a, const vector< unsigned > &b)
 XAPIAN_NORETURN (static void only_one_subdatabase_allowed())
static void only_one_subdatabase_allowed ()
static bool decode_xxy (const string &s, int &x1, int &x2, int &y)
static bool vet_dm (int d, int m)
static bool is_yyyy_mm_dd (const string &s)
const char * version_string ()
 Report the version string of the library which the program is linked with.
int major_version ()
 Report the major version of the library which the program is linked with.
int minor_version ()
 Report the minor version of the library which the program is linked with.
int revision ()
 Report the revision of the library which the program is linked with.
static void open_stub (Database &db, const string &file)
static void open_stub (WritableDatabase &db, const string &file, int action)
static TermListbuild_termlist_tree (const Xapian::Database &db, const RSet &rset)
 Build a tree of binary TermList objects like QueryOptimiser does for OrPostList objects.
bool operator== (const MSetIterator &a, const MSetIterator &b)
 Equality test for MSetIterator objects.
bool operator!= (const MSetIterator &a, const MSetIterator &b)
 Inequality test for MSetIterator objects.
bool operator== (const ESetIterator &a, const ESetIterator &b)
 Equality test for ESetIterator objects.
bool operator!= (const ESetIterator &a, const ESetIterator &b)
 Inequality test for ESetIterator objects.
bool operator== (const PositionIterator &a, const PositionIterator &b)
 Test equality of two PositionIterators.
bool operator!= (const PositionIterator &a, const PositionIterator &b)
 Test inequality of two PositionIterators.
bool operator== (const PostingIterator &a, const PostingIterator &b)
 Test equality of two PostingIterators.
bool operator!= (const PostingIterator &a, const PostingIterator &b)
 Test inequality of two PostingIterators.
std::string sortable_serialise (double value)
 Convert a floating point number to a string, preserving sort order.
double sortable_unserialise (const std::string &value)
 Convert a string encoded using sortable_serialise back to a floating point number.
bool operator== (const TermIterator &a, const TermIterator &b)
 Equality test for TermIterator objects.
bool operator!= (const TermIterator &a, const TermIterator &b)
 Inequality test for TermIterator objects.
bool operator== (const ValueIterator &a, const ValueIterator &b)
 Equality test for ValueIterator objects.
bool operator== (const ValueIterator &a, const ValueIteratorEnd_ &)
bool operator== (const ValueIteratorEnd_ &a, const ValueIterator &b)
bool operator== (const ValueIteratorEnd_ &, const ValueIteratorEnd_ &)
bool operator!= (const ValueIterator &a, const ValueIterator &b)
 Inequality test for ValueIterator objects.
bool operator!= (const ValueIterator &a, const ValueIteratorEnd_ &b)
bool operator!= (const ValueIteratorEnd_ &a, const ValueIterator &b)
bool operator!= (const ValueIteratorEnd_ &a, const ValueIteratorEnd_ &b)
bool U_isupper (unsigned ch)
unsigned check_wordchar (unsigned ch)
bool should_stem (const std::string &term)
unsigned check_infix (unsigned ch)
unsigned check_infix_digit (unsigned ch)
bool is_digit (unsigned ch)
unsigned check_suffix (unsigned ch)

Variables

static const char max_month_length [12]
const int DB_CREATE_OR_OPEN = 1
 Open for read/write; create if no db exists.
const int DB_CREATE = 2
 Create a new database; fail if db exists.
const int DB_CREATE_OR_OVERWRITE = 3
 Overwrite existing db; create if none exists.
const int DB_OPEN = 4
 Open for read/write; fail if no db exists.
const valueno BAD_VALUENO = static_cast<valueno>(-1)
 Reserved value to indicate "no valueno".
const unsigned UNICODE_IGNORE = numeric_limits<unsigned>::max()
 Value representing "ignore this" when returned by check_infix() or check_infix_digit().


Detailed Description

The Xapian namespace contains public interfaces for the Xapian library.


Typedef Documentation

typedef unsigned Xapian::doccount

A count of documents.

This is used to hold values such as the number of documents in a database and the frequency of a term in the database.

Definition at line 31 of file types.h.

typedef int Xapian::doccount_diff

A signed difference between two counts of documents.

This is used by the Xapian classes which are STL containers of documents for "difference_type".

Definition at line 38 of file types.h.

typedef unsigned Xapian::docid

A unique identifier for a document.

Docid 0 is invalid, providing an "out of range" value which can be used to mean "not a valid document".

Definition at line 45 of file types.h.

typedef double Xapian::doclength

A normalised document length.

The normalised document length is the document length divided by the average document length in the database.

Definition at line 52 of file types.h.

typedef int Xapian::percent

The percentage score for a document in an MSet.

Definition at line 55 of file types.h.

typedef unsigned Xapian::termcount

A counts of terms.

This is used to hold values such as the Within Document Frequency (wdf).

Definition at line 61 of file types.h.

A signed difference between two counts of terms.

This is used by the Xapian classes which are STL containers of terms for "difference_type".

Definition at line 68 of file types.h.

typedef unsigned Xapian::termpos

A term position within a document or query.

Definition at line 72 of file types.h.

typedef int Xapian::termpos_diff

A signed difference between two term positions.

This is used by the Xapian classes which are STL containers of positions for "difference_type".

Definition at line 79 of file types.h.

typedef unsigned Xapian::timeout

A timeout value in milliseconds.

There are 1000 milliseconds in a second, so for example, to set a timeout of 5 seconds use 5000.

Definition at line 86 of file types.h.

typedef unsigned Xapian::valueno

The number for a value slot in a document.

Value slot numbers are unsigned and (currently) a 32-bit quantity, with Xapian::BAD_VALUENO being represented by the largest possible value. Therefore value slots 0 to 0xFFFFFFFE are available for use.

Definition at line 94 of file types.h.

typedef int Xapian::valueno_diff

A signed difference between two value slot numbers.

This is used by the Xapian classes which are STL containers of values for "difference_type".

Definition at line 101 of file types.h.

typedef double Xapian::weight

The weight of a document or term.

Definition at line 104 of file types.h.


Function Documentation

static TermList* Xapian::build_termlist_tree ( const Xapian::Database db,
const RSet &  rset 
) [static]

Build a tree of binary TermList objects like QueryOptimiser does for OrPostList objects.

Definition at line 71 of file esetinternal.cc.

References Assert, AssertRel, Xapian::RSet::empty(), Xapian::Database::internal, and Xapian::RSet::internal.

Referenced by Xapian::ESet::Internal::expand().

unsigned Xapian::check_infix ( unsigned  ch  )  [inline]

unsigned Xapian::check_infix_digit ( unsigned  ch  )  [inline]

unsigned Xapian::check_suffix ( unsigned  ch  )  [inline]

unsigned Xapian::check_wordchar ( unsigned  ch  )  [inline]

static bool Xapian::decode_xxy ( const string &  s,
int &  x1,
int &  x2,
int &  y 
) [static]

Definition at line 68 of file valuerangeproc.cc.

Referenced by Xapian::DateValueRangeProcessor::operator()().

static int Xapian::freq_edit_lower_bound ( const vector< unsigned > &  a,
const vector< unsigned > &  b 
) [static]

Definition at line 508 of file omdatabase.cc.

References VEC_SIZE.

Referenced by Xapian::Database::get_spelling_suggestion().

bool Xapian::is_digit ( unsigned  ch  )  [inline]

static bool Xapian::is_yyyy_mm_dd ( const string &  s  )  [static]

Definition at line 112 of file valuerangeproc.cc.

Referenced by Xapian::DateValueRangeProcessor::operator()().

int Xapian::major_version (  ) 

Report the major version of the library which the program is linked with.

This may be different to the version compiled against (given by XAPIAN_MAJOR_VERSION) if shared libraries are being used.

Definition at line 27 of file version.cc.

References XAPIAN_MAJOR_VERSION.

int Xapian::minor_version (  ) 

Report the minor version of the library which the program is linked with.

This may be different to the version compiled against (given by XAPIAN_MINOR_VERSION) if shared libraries are being used.

Definition at line 29 of file version.cc.

References XAPIAN_MINOR_VERSION.

static void Xapian::only_one_subdatabase_allowed (  )  [static]

static void Xapian::open_stub ( WritableDatabase &  db,
const string &  file,
int  action 
) [static]

static void Xapian::open_stub ( Database &  db,
const string &  file 
) [static]

bool Xapian::operator!= ( const ValueIteratorEnd_ &  a,
const ValueIteratorEnd_ &  b 
) [inline]

For internal use only.

Inequality test for end iterators.

Definition at line 225 of file valueiterator.h.

bool Xapian::operator!= ( const ValueIteratorEnd_ &  a,
const ValueIterator &  b 
) [inline]

For internal use only.

Inequality test for ValueIterator object and end iterator.

Definition at line 218 of file valueiterator.h.

bool Xapian::operator!= ( const ValueIterator &  a,
const ValueIteratorEnd_ &  b 
) [inline]

For internal use only.

Inequality test for ValueIterator object and end iterator.

Definition at line 211 of file valueiterator.h.

bool Xapian::operator!= ( const ValueIterator &  a,
const ValueIterator &  b 
) [inline]

Inequality test for ValueIterator objects.

Definition at line 204 of file valueiterator.h.

bool Xapian::operator!= ( const TermIterator &  a,
const TermIterator &  b 
) [inline]

Inequality test for TermIterator objects.

Definition at line 138 of file termiterator.h.

bool Xapian::operator!= ( const PostingIterator &  a,
const PostingIterator &  b 
) [inline]

Test inequality of two PostingIterators.

Definition at line 147 of file postingiterator.h.

bool Xapian::operator!= ( const PositionIterator &  a,
const PositionIterator &  b 
) [inline]

Test inequality of two PositionIterators.

Definition at line 117 of file positioniterator.h.

bool Xapian::operator!= ( const ESetIterator &  a,
const ESetIterator &  b 
) [inline]

Inequality test for ESetIterator objects.

Definition at line 562 of file enquire.h.

References Xapian::ESetIterator::index.

bool Xapian::operator!= ( const MSetIterator &  a,
const MSetIterator &  b 
) [inline]

Inequality test for MSetIterator objects.

Definition at line 413 of file enquire.h.

References Xapian::MSetIterator::index.

bool Xapian::operator== ( const ValueIteratorEnd_ &  ,
const ValueIteratorEnd_ &   
) [inline]

For internal use only.

Equality test for end iterators.

Definition at line 197 of file valueiterator.h.

bool Xapian::operator== ( const ValueIteratorEnd_ &  a,
const ValueIterator &  b 
) [inline]

For internal use only.

Equality test for ValueIterator object and end iterator.

Definition at line 190 of file valueiterator.h.

bool Xapian::operator== ( const ValueIterator &  a,
const ValueIteratorEnd_ &   
) [inline]

For internal use only.

Equality test for ValueIterator object and end iterator.

Definition at line 183 of file valueiterator.h.

References Xapian::Internal::RefCntPtr< T >::get(), and Xapian::ValueIterator::internal.

bool Xapian::operator== ( const ValueIterator &  a,
const ValueIterator &  b 
) [inline]

Equality test for ValueIterator objects.

Definition at line 174 of file valueiterator.h.

References Xapian::Internal::RefCntPtr< T >::get(), and Xapian::ValueIterator::internal.

bool Xapian::operator== ( const TermIterator &  a,
const TermIterator &  b 
) [inline]

Equality test for TermIterator objects.

Definition at line 131 of file termiterator.h.

References Xapian::Internal::RefCntPtr< T >::get(), and Xapian::TermIterator::internal.

bool Xapian::operator== ( const PostingIterator &  a,
const PostingIterator &  b 
) [inline]

Test equality of two PostingIterators.

Definition at line 141 of file postingiterator.h.

References Xapian::Internal::RefCntPtr< T >::get(), and Xapian::PostingIterator::internal.

bool Xapian::operator== ( const PositionIterator &  a,
const PositionIterator &  b 
) [inline]

Test equality of two PositionIterators.

Definition at line 110 of file positioniterator.h.

References Xapian::Internal::RefCntPtr< T >::get(), and Xapian::PositionIterator::internal.

bool Xapian::operator== ( const ESetIterator &  a,
const ESetIterator &  b 
) [inline]

Equality test for ESetIterator objects.

Definition at line 556 of file enquire.h.

References Xapian::ESetIterator::index.

bool Xapian::operator== ( const MSetIterator &  a,
const MSetIterator &  b 
) [inline]

Equality test for MSetIterator objects.

Definition at line 407 of file enquire.h.

References Xapian::MSetIterator::index.

int Xapian::revision (  ) 

bool Xapian::should_stem ( const std::string &  term  )  [inline]

string Xapian::sortable_serialise ( double  value  ) 

Convert a floating point number to a string, preserving sort order.

This method converts a floating point number to a string, suitable for using as a value for numeric range restriction, or for use as a sort key.

The conversion is platform independent.

The conversion attempts to ensure that, for any pair of values supplied to the conversion algorithm, the result of comparing the original values (with a numeric comparison operator) will be the same as the result of comparing the resulting values (with a string comparison operator). On platforms which represent doubles with the precisions specified by IEEE_754, this will be the case: if the representation of doubles is more precise, it is possible that two very close doubles will be mapped to the same string, so will compare equal.

Note also that both zero and -zero will be converted to the same representation: since these compare equal, this satisfies the comparison constraint, but it's worth knowing this if you wish to use the encoding in some situation where this distinction matters.

Handling of NaN isn't (currently) guaranteed to be sensible.

Parameters:
value The number to serialise.

Definition at line 44 of file sortable-serialise.cc.

References Assert.

Referenced by DEFINE_TESTCASE(), FileIndexer::next(), Xapian::NumberValueRangeProcessor::operator()(), test_qp_value_range3(), and test_value_range_serialise1().

double Xapian::sortable_unserialise ( const std::string &  value  ) 

Convert a string encoded using sortable_serialise back to a floating point number.

This expects the input to be a string produced by sortable_serialise(). If the input is not such a string, the value returned is undefined (but no error will be thrown).

The result of the conversion will be exactly the value which was supplied to sortable_serialise() when making the string on platforms which represent doubles with the precisions specified by IEEE_754, but may be a different (nearby) value on other platforms.

Parameters:
value The serialised string to decode.

Definition at line 176 of file sortable-serialise.cc.

References Assert, and numfromstr().

Referenced by Xapian::ValueWeightPostingSource::get_weight(), Xapian::ValueWeightPostingSource::init(), and test_value_range_serialise1().

bool Xapian::U_isupper ( unsigned  ch  )  [inline]

const char * Xapian::version_string (  ) 

Report the version string of the library which the program is linked with.

This may be different to the version compiled against (given by XAPIAN_VERSION) if shared libraries are being used.

Definition at line 25 of file version.cc.

References XAPIAN_VERSION.

Referenced by PerfTestLogger::open().

static bool Xapian::vet_dm ( int  d,
int  m 
) [static]

Definition at line 102 of file valuerangeproc.cc.

References max_month_length.

Referenced by Xapian::DateValueRangeProcessor::operator()().

Xapian::XAPIAN_NORETURN ( static void   only_one_subdatabase_allowed()  ) 


Variable Documentation

const valueno Xapian::BAD_VALUENO = static_cast<valueno>(-1)

const int Xapian::DB_CREATE = 2

Open for read/write; create if no db exists.

Definition at line 928 of file database.h.

Referenced by DEFINE_TESTCASE(), and main().

const int Xapian::DB_OPEN = 4

const char Xapian::max_month_length[12] [static]

Initial value:

 {
    31, 29, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31
}

Definition at line 97 of file valuerangeproc.cc.

Referenced by vet_dm().

const unsigned Xapian::UNICODE_IGNORE = numeric_limits<unsigned>::max()


Documentation for Xapian (version 1.2.13).
Generated on 9 Jan 2013 by Doxygen 1.5.9.