Xapian: API Documentation: Class List

- Main Page
- Related Pages
- Namespaces
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 12]

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