Class Hierarchy

Go to the graphical class hierarchy

This inheritance list is sorted roughly, but not completely, alphabetically:
[detail level 12345]
oCXapian::CompactorCompact a database, or merge and compact several
oCXapian::DatabaseThis class is used to access a database, or a group of databases
|\CXapian::WritableDatabaseThis class provides read/write access to a database
oCXapian::DocumentA handle representing a document in a Xapian database
oCXapian::EnquireThis class provides an interface to the information retrieval system for the purpose of searching
oCXapian::ErrorAll exceptions thrown by Xapian are subclasses of Xapian::Error
|oCXapian::LogicErrorThe base class for exceptions indicating errors in the program logic
||oCXapian::AssertionErrorAssertionError is thrown if a logical assertion inside Xapian fails
||oCXapian::InvalidArgumentErrorInvalidArgumentError indicates an invalid parameter value was passed to the API
||oCXapian::InvalidOperationErrorInvalidOperationError indicates the API was used in an invalid way
||\CXapian::UnimplementedErrorUnimplementedError indicates an attempt to use an unimplemented feature
|\CXapian::RuntimeErrorThe base class for exceptions indicating errors only detectable at runtime
| oCXapian::DatabaseErrorDatabaseError indicates some sort of database related error
| |oCXapian::DatabaseCorruptErrorDatabaseCorruptError indicates database corruption was detected
| |oCXapian::DatabaseCreateErrorDatabaseCreateError indicates a failure to create a database
| |oCXapian::DatabaseLockErrorDatabaseLockError indicates failure to lock a database
| |oCXapian::DatabaseModifiedErrorDatabaseModifiedError indicates a database was modified
| |\CXapian::DatabaseOpeningErrorDatabaseOpeningError indicates failure to open a database
| | \CXapian::DatabaseVersionErrorDatabaseVersionError indicates that a database is in an unsupported format
| oCXapian::DocNotFoundErrorIndicates an attempt to access a document not present in the database
| oCXapian::FeatureUnavailableErrorIndicates an attempt to use a feature which is unavailable
| oCXapian::InternalErrorInternalError indicates a runtime problem of some sort
| oCXapian::NetworkErrorIndicates a problem communicating with a remote database
| |\CXapian::NetworkTimeoutErrorIndicates a timeout expired while communicating with a remote database
| oCXapian::QueryParserErrorIndicates a query string can't be parsed
| oCXapian::RangeErrorRangeError indicates an attempt to access outside the bounds of a container
| oCXapian::SerialisationErrorIndicates an error in the std::string serialisation of an object
| \CXapian::WildcardErrorWildcardError indicates an error expanding a wildcarded query
oCXapian::ErrorHandlerDecide if a Xapian::Error exception should be ignored
oCXapian::ESetClass representing a list of search results
oCXapian::ESetIteratorIterator over a Xapian::ESet
oCXapian::ExpandDeciderVirtual base class for expand decider functor
|oCXapian::ExpandDeciderAndExpandDecider subclass which rejects terms using two ExpandDeciders
|oCXapian::ExpandDeciderFilterPrefixExpandDecider subclass which restrict terms to a particular prefix
|\CXapian::ExpandDeciderFilterTermsExpandDecider subclass which rejects terms in a specified list
oCXapian::FieldProcessorBase class for field processors
oCXapian::KeyMakerVirtual base class for key making functors
|oCXapian::LatLongDistanceKeyMakerKeyMaker subclass which sorts by distance from a latitude/longitude
|\CXapian::MultiValueKeyMakerKeyMaker subclass which combines several values
oCXapian::LatLongCoordA latitude-longitude coordinate
oCXapian::LatLongCoordsA sequence of latitude-longitude coordinates
oCXapian::LatLongCoordsIteratorAn iterator across the values in a LatLongCoords object
oCXapian::LatLongMetricBase class for calculating distances between two lat/long coordinates
|\CXapian::GreatCircleMetricCalculate the great-circle distance between two coordinates on a sphere
oCXapian::MatchDeciderBase class for matcher decision functor
|\CXapian::ValueSetMatchDeciderMatchDecider filtering results based on whether document values are in a user-defined set
oCXapian::MatchSpyAbstract base class for match spies
|\CXapian::ValueCountMatchSpyClass for counting the frequencies of values in the matching documents
oCXapian::MSetClass representing a list of search results
oCXapian::MSetIteratorIterator over a Xapian::MSet
oCXapian::PositionIteratorClass for iterating over term positions
oCXapian::PostingIteratorClass for iterating over a list of terms
oCXapian::PostingSourceBase class which provides an "external" source of postings
|oCXapian::FixedWeightPostingSourceA posting source which returns a fixed weight for all documents
|\CXapian::ValuePostingSourceA posting source which generates weights from a value slot
| oCXapian::LatLongDistancePostingSourcePosting source which returns a weight based on geospatial distance
| oCXapian::ValueMapPostingSourceA posting source which looks up weights in a map using values as the key
| \CXapian::ValueWeightPostingSourceA posting source which reads weights from a value slot
|  \CXapian::DecreasingValueWeightPostingSourceRead weights from a value which is known to decrease as docid increases
oCXapian::QueryClass representing a query
oCXapian::QueryParserBuild a Xapian::Query object from a user query string
oCXapian::RangeProcessorBase class for range processors
|oCXapian::DateRangeProcessorHandle a date range
|\CXapian::NumberRangeProcessorHandle a number range
oCXapian::RegistryRegistry for user subclasses
oCXapian::RSetA relevance set (R-Set)
oCXapian::StemClass representing a stemming algorithm
oCXapian::StemImplementationClass representing a stemming algorithm implementation
oCXapian::StopperBase class for stop-word decision functor
|\CXapian::SimpleStopperSimple implementation of Stopper class - this will suit most users
oCXapian::TermGeneratorParses a piece of text and generate terms
oCXapian::TermIteratorClass for iterating over a list of terms
oCXapian::Utf8IteratorAn iterator which returns Unicode character values from a UTF-8 encoded string
oCXapian::ValueIteratorClass for iterating over document values
oCXapian::ValueRangeProcessorBase class for value range processors
|\CXapian::StringValueRangeProcessorHandle a string range
| oCXapian::DateValueRangeProcessorHandle a date range
| \CXapian::NumberValueRangeProcessorHandle a number range
\CXapian::WeightAbstract base class for weighting schemes
 oCXapian::BB2WeightThis class implements the BB2 weighting scheme
 oCXapian::BM25WeightXapian::Weight subclass implementing the BM25 probabilistic formula
 oCXapian::BoolWeightClass implementing a "boolean" weighting scheme
 oCXapian::DLHWeightThis class implements the DLH weighting scheme, which is a representative scheme of the Divergence from Randomness Framework by Gianni Amati
 oCXapian::DPHWeightThis class implements the DPH weighting scheme
 oCXapian::IfB2WeightThis class implements the IfB2 weighting scheme
 oCXapian::IneB2WeightThis class implements the IneB2 weighting scheme
 oCXapian::InL2WeightThis class implements the InL2 weighting scheme
 oCXapian::LMWeightXapian::Weight subclass implementing the Language Model formula
 oCXapian::PL2WeightThis class implements the PL2 weighting scheme
 oCXapian::TfIdfWeightXapian::Weight subclass implementing the tf-idf weighting scheme
 \CXapian::TradWeightXapian::Weight subclass implementing the traditional probabilistic formula

Documentation for Xapian (version 1.4.0).
Generated on Sat Jun 25 2016 by Doxygen 1.8.1.2.