Public interfaces for the Xapian library.
More...
Public interfaces for the Xapian library.
const FieldProcessor * release() const
Start reference counting this object.
Definition: queryparser.h:763
void need_stat(stat_flags flag)
Tell Xapian that your subclass will want a particular statistic.
Definition: weight.h:83
ExpandDeciderFilterPrefix(const std::string &prefix_)
The parameter specify the prefix of terms to be retained.
Definition: expanddecider.h:150
~TermIterator()
Destructor.
Definition: termiterator.h:84
Xapian::termcount get_query_length() const
The length of the query.
Definition: weight.h:359
const int DB_RETRY_LOCK
If the database is already locked, retry the lock.
Definition: constants.h:145
Registry for user subclasses.
Definition: registry.h:47
InvalidArgumentError(const std::string &msg_, const std::string &context_=std::string(), int errno_=0)
General purpose constructor.
Definition: error.h:257
@ NON_SPACING_MARK
Mark, nonspacing (Mn)
Definition: unicode.h:227
DerefWrapper_< std::string > operator++(int)
Advance the iterator to the next position (postfix version).
Definition: valueiterator.h:96
DatabaseModifiedError indicates a database was modified.
Definition: error.h:539
ESetIterator operator[](Xapian::doccount i) const
Return iterator pointing to the i-th object in this ESet.
Definition: eset.h:357
Abstract base class for match spies.
Definition: matchspy.h:49
TermIterator allterms_end(const std::string &=std::string()) const
Corresponding end iterator to allterms_begin(prefix).
Definition: database.h:265
@ INITIAL_QUOTE_PUNCTUATION
Punctuation, initial quote (Pi)
Definition: unicode.h:244
const valueno BAD_VALUENO
Reserved value to indicate "no valueno".
Definition: types.h:125
DerefWrapper_< std::string > operator++(int)
Advance the iterator to the next position (postfix version).
Definition: termiterator.h:112
void operator=(const Database &other)
Assignment is allowed.
bool prefix
Whether to look for str as a prefix or suffix.
Definition: queryparser.h:464
const Query operator|=(const Query &o)
Combine with another Xapian::Query object using OP_OR.
Definition: query.h:802
DatabaseLockError(const std::string &msg_, const std::string &context_=std::string(), int errno_=0)
General purpose constructor.
Definition: error.h:509
@ TITLECASE_LETTER
Letter, titlecase (Lt)
Definition: unicode.h:224
ValueCountMatchSpy(Xapian::valueno slot_)
Construct a MatchSpy which counts the values in a particular slot.
Definition: matchspy.h:237
A latitude-longitude coordinate.
Definition: geospatial.h:81
TermIterator get_matching_terms_end(Xapian::docid) const
End iterator corresponding to get_matching_terms_begin()
Definition: enquire.h:713
@ MATH_SYMBOL
Symbol, math (Sm)
Definition: unicode.h:247
This class implements the BB2 weighting scheme.
Definition: weight.h:1032
Handle a date range.
Definition: queryparser.h:512
RangeError(const std::string &msg_, int errno_)
Construct from message and errno value.
Definition: error.h:995
NetworkError(const std::string &msg_, const std::string &context_=std::string(), int errno_=0)
General purpose constructor.
Definition: error.h:819
@ OTHER_PUNCTUATION
Punctuation, other (Po)
Definition: unicode.h:246
Weight()
Default constructor, needed by subclass constructors.
Definition: weight.h:141
DatabaseVersionError(const std::string &msg_, const std::string &context_=std::string(), int errno_=0)
General purpose constructor.
Definition: error.h:648
@ FINAL_QUOTE_PUNCTUATION
Punctuation, final quote (Pf)
Definition: unicode.h:245
category get_category(unsigned ch)
Return the category which a given Unicode character falls into.
Definition: unicode.h:338
const int DBCOMPACT_SINGLE_FILE
Produce a single-file database.
Definition: constants.h:268
@ SURROGATE
Other, surrogate (Cs)
Definition: unicode.h:239
MSetIterator()
Create an unpositioned MSetIterator.
Definition: mset.h:365
~ValueIterator()
Destructor.
Definition: valueiterator.h:85
Xapian::TermIterator synonyms_end(const std::string &) const
Corresponding end iterator to synonyms_begin(term).
Definition: database.h:435
MSetIterator operator[](Xapian::doccount i) const
Return iterator pointing to the i-th object in this MSet.
Definition: mset.h:615
Stopper()
Default constructor.
Definition: queryparser.h:56
bool operator<(const ESetIterator &a, const ESetIterator &b)
Inequality test for ESetIterator objects.
Definition: eset.h:297
WildcardError indicates an error expanding a wildcarded query.
Definition: error.h:1013
ESet get_eset(Xapian::termcount maxitems, const RSet &omrset, const Xapian::ExpandDecider *edecider) const
Get the expand set for the given rset.
Definition: enquire.h:643
LatLongCoord()
Construct an uninitialised coordinate.
Definition: geospatial.h:102
void fetch() const
Prefetch hint the whole MSet.
Definition: mset.h:273
double longitude
A longitude, as decimal degrees.
Definition: geospatial.h:98
double miles_to_metres(double miles)
Convert from miles to metres.
Definition: geospatial.h:54
ExpandDeciderAnd(const ExpandDecider &first_, const ExpandDecider &second_)
Terms will be checked with first, and if accepted, then checked with second.
Definition: expanddecider.h:98
PostingIterator postlist_end(const std::string &) const
Corresponding end iterator to postlist_begin().
Definition: database.h:225
LatLongCoordsIterator()
Default constructor. Produces an uninitialised iterator.
Definition: geospatial.h:178
DatabaseCreateError(const std::string &msg_, const std::string &context_=std::string(), int errno_=0)
General purpose constructor.
Definition: error.h:467
const char * version_string()
Report the version string of the library which the program is linked with.
Definition: xapian.h:115
unsigned flags
Flags.
Definition: queryparser.h:161
TermIterator unstem_end(const std::string &) const
End iterator over unstemmed forms of the given stemmed query term.
Definition: queryparser.h:1218
Xapian::Weight subclass implementing the traditional probabilistic formula.
Definition: weight.h:746
ErrorHandler()
Default constructor.
Definition: errorhandler.h:81
void add_value(Xapian::valueno slot, bool reverse=false, const std::string &defvalue=std::string())
Add a value slot to the list to build a key from.
Definition: keymaker.h:143
const int DB_CREATE_OR_OVERWRITE
Create database if it doesn't already exist, or overwrite if it does.
Definition: constants.h:38
unsigned timeout
A timeout value in milliseconds.
Definition: types.h:100
Build key strings for MSet ordering or collapsing.
Utf8Iterator()
Create an iterator which is at the end of its iteration.
Definition: unicode.h:132
std::string str
The prefix (or suffix with RP_SUFFIX) string to look for.
Definition: queryparser.h:148
NumberValueRangeProcessor(Xapian::valueno slot_, const std::string &str_, bool prefix_=true)
Constructor.
Definition: queryparser.h:695
const RangeProcessor * release() const
Start reference counting this object.
Definition: queryparser.h:235
ExpandDecider()
Default constructor.
Definition: expanddecider.h:47
Class for iterating over document values.
const LatLongCoord & operator*() const
Get the LatLongCoord for the current position.
Definition: geospatial.h:181
XAPIAN_REVISION_TYPE rev
Revision number of a database.
Definition: types.h:133
std::input_iterator_tag iterator_category
We implement the semantics of an STL input_iterator.
Definition: unicode.h:204
unsigned to_utf8(unsigned ch, char *buf)
Convert a single Unicode character to UTF-8.
Definition: unicode.h:321
parsing a user query string to build a Xapian::Query object
const KeyMaker * release() const
Start reference counting this object.
Definition: keymaker.h:83
double weight
The weight of a document or term.
Definition: types.h:122
Factory functions for constructing Database and WritableDatabase objects.
NetworkTimeoutError(const std::string &msg_, const std::string &context_=std::string(), int errno_=0)
General purpose constructor.
Definition: error.h:861
DatabaseCreateError indicates a failure to create a database.
Definition: error.h:451
@ WILDCARD_LIMIT_FIRST
Stop expanding when OP_WILDCARD reaches its expansion limit.
Definition: query.h:288
A posting source which generates weights from a value slot.
Definition: postingsource.h:401
const int DB_FULL_SYNC
Try to ensure changes are really written to disk.
Definition: constants.h:83
API for working with documents.
bool empty() const
Return true if this ESet object is empty.
Definition: eset.h:85
Query(Query::op op_)
Construct with just an operator.
Definition: query.h:598
A posting source which reads weights from a value slot.
Definition: postingsource.h:586
@ OPEN_PUNCTUATION
Punctuation, open (Ps)
Definition: unicode.h:242
double curr_weight
Weight at current position.
Definition: postingsource.h:641
int get_percent() const
Convert the weight of the current iterator position to a percentage.
Definition: mset.h:510
Utf8Iterator(const char *p_, size_t len)
Create an iterator given a pointer and a length.
Definition: unicode.h:114
#define XAPIAN_DOCID_BASE_TYPE
Base (signed) type for Xapian::docid and related types.
Definition: version.h:71
unsigned toupper(unsigned ch)
Convert a Unicode character to uppercase.
Definition: unicode.h:384
Indicates an attempt to access a document not present in the database.
Definition: error.h:674
int minor_version()
Report the minor version of the library which the program is linked with.
Definition: xapian.h:133
Class implementing a "boolean" weighting scheme.
Definition: weight.h:400
Xapian::valueno valno
The value slot to process.
Definition: queryparser.h:461
Xapian::TermIterator metadata_keys_end(const std::string &=std::string()) const
Corresponding end iterator to metadata_keys_begin().
Definition: database.h:498
bool items_at_end
Flag, set to true if there are docs after the end of the range.
Definition: postingsource.h:644
Xapian::doccount size() const
Return number of items in this MSet object.
@ PARAGRAPH_SEPARATOR
Separator, paragraph (Zp)
Definition: unicode.h:235
MSetIterator begin() const
Return iterator pointing to the first item in this MSet.
Definition: mset.h:603
unsigned XAPIAN_TERMCOUNT_BASE_TYPE termcount
A counts of terms.
Definition: types.h:72
Utf8Iterator(const std::string &s)
Create an iterator given a string.
Definition: unicode.h:125
DatabaseOpeningError(const std::string &msg_, int errno_)
Construct from message and errno value.
Definition: error.h:605
void assign(const char *p_, size_t len)
Assign a new string to the iterator.
Definition: unicode.h:72
Class for iterating over term positions.
Definition: positioniterator.h:40
LatLongCoords(const LatLongCoord &coord)
Construct a container holding one coordinate.
Definition: geospatial.h:269
double get_weight() const
Get the weight for the current position.
MSetIterator operator++(int)
Advance the iterator to the next position (postfix version).
Definition: mset.h:377
bool operator>=(const ESetIterator &a, const ESetIterator &b)
Inequality test for ESetIterator objects.
Definition: eset.h:317
PositionIterator positionlist_end(Xapian::docid, const std::string &) const
Corresponding end iterator to positionlist_begin().
Definition: database.h:252
op
Query operators.
Definition: query.h:78
DatabaseVersionError(const std::string &msg_, int errno_)
Construct from message and errno value.
Definition: error.h:656
LatLongCoordsIterator begin() const
Get a begin iterator for the coordinates.
Definition: geospatial.h:238
Xapian::totallength get_total_length() const
Total length of all documents in the collection.
Definition: weight.h:391
difference_type operator-(const MSetIterator &o) const
Return the number of positions between o and this iterator.
Definition: mset.h:448
void append(const LatLongCoord &coord)
Append a coordinate to the end of the sequence.
Definition: geospatial.h:260
This class implements the IfB2 weighting scheme.
Definition: weight.h:887
ESetIterator & operator-=(difference_type n)
Move the iterator back by n positions.
Definition: eset.h:239
const int DOC_ASSUME_VALID
Assume document id is valid.
Definition: constants.h:280
Xapian::Weight subclass implementing Coordinate Matching.
Definition: weight.h:1487
PostingSource()
Allow subclasses to be instantiated.
Definition: postingsource.h:67
Build a Xapian::Query object from a user query string.
Definition: queryparser.h:770
Xapian::doccount get_rank() const
Return the MSet rank for the current position.
Definition: mset.h:456
void flush()
Pre-1.1.0 name for commit().
Definition: database.h:917
static size_t check(const std::string &path, int opts=0, std::ostream *out=NULL)
Check the integrity of a database or database table.
Definition: database.h:552
static size_t check(int fd, int opts=0, std::ostream *out=NULL)
Check the integrity of a single file database.
Definition: database.h:567
@ CONNECTOR_PUNCTUATION
Punctuation, connector (Pc)
Definition: unicode.h:240
@ CLOSE_PUNCTUATION
Punctuation, close (Pe)
Definition: unicode.h:243
LatLongCoordsIterator & operator++()
Advance the iterator to the next position.
Definition: geospatial.h:186
This class implements the DLH weighting scheme, which is a representative scheme of the Divergence fr...
Definition: weight.h:1108
@ OP_OR
Match documents which at least one subquery matches.
Definition: query.h:92
SimpleStopper()
Default constructor.
Definition: queryparser.h:101
CoordWeight()
Construct a CoordWeight.
Definition: weight.h:1497
@ MODIFIER_LETTER
Letter, modifier (Lm)
Definition: unicode.h:225
const int DB_CREATE
Create a new database.
Definition: constants.h:44
ValueIterator valuestream_end(Xapian::valueno) const
Return end iterator corresponding to valuestream_begin().
Definition: database.h:351
const Query operator/=(double factor)
Inverse scale using OP_SCALE_WEIGHT.
Definition: query.h:587
Allow rejection of terms during ESet generation.
TermIterator get_matching_terms_end(const MSetIterator &) const
End iterator corresponding to get_matching_terms_begin()
Definition: enquire.h:742
Xapian::doccount get_collection_size() const
The number of documents in the collection.
Definition: weight.h:341
InvalidArgumentError indicates an invalid parameter value was passed to the API.
Definition: error.h:241
unsigned nonascii_to_utf8(unsigned ch, char *buf)
Convert a single non-ASCII Unicode character to UTF-8.
Define preprocessor symbols for the library version.
size_t get_num_subqueries() const
Get the number of subqueries of the top level query.
DatabaseOpeningError indicates failure to open a database.
Definition: error.h:581
MatchDecider filtering results based on whether document values are in a user-defined set.
Definition: valuesetmatchdecider.h:44
const int DB_OPEN
Open an existing database.
Definition: constants.h:50
BoolWeight()
Construct a BoolWeight.
Definition: weight.h:407
const int DB_CREATE_OR_OPEN
Create database if it doesn't already exist.
Definition: constants.h:35
int valueno_diff
A signed difference between two value slot numbers.
Definition: types.h:115
ESetIterator & operator++()
Advance the iterator to the next position.
Definition: eset.h:184
Indicates an attempt to access a database not present.
Definition: error.h:1055
@ CONTROL
Other, control (Cc)
Definition: unicode.h:236
ValueCountMatchSpy()
Construct an empty ValueCountMatchSpy.
Definition: matchspy.h:234
InternalError(const std::string &msg_, const std::string &context_=std::string(), int errno_=0)
General purpose constructor.
Definition: error.h:777
KeyMaker subclass which combines several values.
Definition: keymaker.h:104
Base class for calculating distances between two lat/long coordinates.
Definition: geospatial.h:303
A posting source which returns a fixed weight for all documents.
Definition: postingsource.h:735
ExpandDecider * release()
Start reference counting this object.
Definition: expanddecider.h:65
Base class for stop-word decision functor.
Definition: queryparser.h:46
@ UNASSIGNED
Other, not assigned (Cn)
Definition: unicode.h:221
SerialisationError(const std::string &msg_, int errno_)
Construct from message and errno value.
Definition: error.h:953
void compact(const std::string &output, unsigned flags, int block_size, Xapian::Compactor &compactor)
Produce a compact version of this database.
Definition: database.h:711
@ COMBINING_SPACING_MARK
Mark, spacing combining (Mc)
Definition: unicode.h:229
Database open(const std::string &dir)
Construct a Database object for read-only access to a Chert database.
Definition: dbfactory.h:123
const Query operator&(const Query &a, const Query &b)
Combine two Xapian::Query objects using OP_AND.
Definition: query.h:636
void add(const std::string &word)
Add a single stop word.
Definition: queryparser.h:116
const Stopper * release() const
Start reference counting this object.
Definition: queryparser.h:89
MSetIterator & operator--()
Move the iterator to the previous position.
Definition: mset.h:384
Xapian::TermIterator synonym_keys_end(const std::string &=std::string()) const
Corresponding end iterator to synonym_keys_begin(prefix).
Definition: database.h:447
Xapian::Database get_database() const
The database we're reading values from.
Definition: postingsource.h:502
Handle a string range.
Definition: queryparser.h:458
MatchDecider()
Default constructor.
Definition: enquire.h:127
Xapian::doccount get_termfreq() const
The number of documents which this term indexes.
Definition: weight.h:350
RangeProcessor(Xapian::valueno slot_, const std::string &str_=std::string(), unsigned flags_=0)
Constructor.
Definition: queryparser.h:183
Class representing a list of query expansion terms.
bool operator==(const ESetIterator &a, const ESetIterator &b)
Equality test for ESetIterator objects.
Definition: eset.h:277
NumberValueRangeProcessor(Xapian::valueno slot_)
Constructor.
Definition: queryparser.h:660
Query & operator=(const Query &o)
Copying is allowed.
Definition: query.h:325
Database open_stub(const std::string &file)
Construct a Database object for a stub database file.
Definition: dbfactory.h:61
virtual bool operator()(const std::string &term) const
Is term a stop-word?
Definition: queryparser.h:118
DatabaseNotFoundError(const std::string &msg_, int errno_)
Construct from message and errno value.
Definition: error.h:1079
difference_type operator-(const ESetIterator &o) const
Return the number of positions between o and this iterator.
Definition: eset.h:261
op get_type() const
Get the type of the top level of the query.
const Query operator^=(const Query &o)
Combine with another Xapian::Query object using OP_XOR.
Definition: query.h:819
Virtual base class for key making functors.
Definition: keymaker.h:41
LatLongDistanceKeyMaker(Xapian::valueno slot_, const LatLongCoords ¢re_, const LatLongMetric &metric_, double defdistance)
Construct a LatLongDistanceKeyMaker.
Definition: geospatial.h:574
InternalError indicates a runtime problem of some sort.
Definition: error.h:761
ValueRangeProcessor()
Default constructor.
Definition: queryparser.h:406
const int DBCOMPACT_NO_RENUMBER
Use the same document ids in the output as in the input(s).
Definition: constants.h:256
Xapian::doccount size() const
Return number of items in this ESet object.
SimpleStopper(Iterator begin, Iterator end)
Initialise from a pair of iterators.
Definition: queryparser.h:113
TradWeight(double k=1.0)
Construct a TradWeight.
Definition: weight.h:768
category
Each Unicode character is in exactly one of these categories.
Definition: unicode.h:220
void add_value(const std::string &value)
Add a value to the test set.
Definition: valuesetmatchdecider.h:75
bool is_none() const
Return true if this is a no-op stemmer.
Definition: stem.h:166
Query(op op_, const Xapian::Query &a, const Xapian::Query &b)
Construct a Query object by combining two others.
Definition: query.h:375
LMWeight(double param_log_=0.0, type_smoothing select_smoothing_=TWO_STAGE_SMOOTHING, double param_smoothing1_=-1.0, double param_smoothing2_=-1.0)
Construct a LMWeight.
Definition: weight.h:1439
const PostingSource * release() const
Start reference counting this object.
Definition: postingsource.h:384
@ OTHER_NUMBER
Number, other (No)
Definition: unicode.h:232
static const Xapian::Query MatchAll
A query matching all documents.
Definition: query.h:75
Class representing a list of search results.
Definition: eset.h:43
PostingIterator()
Default constructor.
Definition: postingiterator.h:80
Xapian::termcount get_wqf() const
The within-query-frequency of this term.
Definition: weight.h:362
FieldProcessor * release()
Start reference counting this object.
Definition: queryparser.h:751
InvalidOperationError(const std::string &msg_, const std::string &context_=std::string(), int errno_=0)
General purpose constructor.
Definition: error.h:299
bool is_currency(unsigned ch)
Test if a given Unicode character is a currency symbol.
Definition: unicode.h:371
const TermIterator get_terms_end() const
End iterator for terms in the query object.
Definition: query.h:493
MSetIterator & operator+=(difference_type n)
Move the iterator forwards by n positions.
Definition: mset.h:420
Stopper * release()
Start reference counting this object.
Definition: queryparser.h:77
void set_compaction_level(compaction_level compaction)
Set the compaction level.
Definition: compactor.h:116
KeyMaker * release()
Start reference counting this object.
Definition: keymaker.h:71
@ OTHER_LETTER
Letter, other (Lo)
Definition: unicode.h:226
const int DB_BACKEND_GLASS
Use the glass backend.
Definition: constants.h:158
@ OP_AND
Match only documents which all subqueries match.
Definition: query.h:84
ExpandDeciderFilterTerms(Iterator reject_begin, Iterator reject_end)
The two iterators specify a list of terms to be rejected.
Definition: expanddecider.h:132
void swap(ESet &o)
Efficiently swap this ESet object with another.
Definition: eset.h:95
ValueRangeProcessor * release()
Start reference counting this object.
Definition: queryparser.h:434
Database open(const std::string &host, unsigned int port, useconds_t timeout=10000, useconds_t connect_timeout=10000)
Construct a Database object for read-only access to a remote database accessed via a TCP connection.
XAPIAN_DOCID_BASE_TYPE doccount_diff
A signed difference between two counts of documents.
Definition: types.h:45
Query()
Construct a query matching no documents.
Definition: query.h:310
const char * raw() const
Return the raw const char* pointer for the current position.
Definition: unicode.h:54
InvalidOperationError(const std::string &msg_, int errno_)
Construct from message and errno value.
Definition: error.h:307
This class provides an interface to the information retrieval system for the purpose of searching.
Definition: enquire.h:152
Xapian::docid range_end
End of range of docids for which weights are known to be decreasing.
Definition: postingsource.h:638
TermIterator termlist_end(Xapian::docid) const
Corresponding end iterator to termlist_begin().
Definition: database.h:238
@ OP_INVALID
Construct an invalid query.
Definition: query.h:254
void append_utf8(std::string &s, unsigned ch)
Append the UTF-8 representation of a single Unicode character to a std::string.
Definition: unicode.h:332
XAPIAN_TOTALLENGTH_TYPE totallength
The total length of all documents in a database.
Definition: types.h:139
ESetIterator end() const
Return iterator pointing to just after the last item in this ESet.
Definition: eset.h:350
@ OP_XOR
Match documents which an odd number of subqueries match.
Definition: query.h:107
ValueSetMatchDecider(Xapian::valueno slot, bool inclusive_)
Construct a ValueSetMatchDecider.
Definition: valuesetmatchdecider.h:68
XAPIAN_TERMCOUNT_BASE_TYPE termcount_diff
A signed difference between two counts of terms.
Definition: types.h:79
AssertionError is thrown if a logical assertion inside Xapian fails.
Definition: error.h:199
@ DECIMAL_DIGIT_NUMBER
Number, decimal digit (Nd)
Definition: unicode.h:230
XAPIAN_TERMPOS_BASE_TYPE termpos_diff
A signed difference between two term positions.
Definition: types.h:90
@ LOWERCASE_LETTER
Letter, lowercase (Ll)
Definition: unicode.h:223
DatabaseModifiedError(const std::string &msg_, int errno_)
Construct from message and errno value.
Definition: error.h:563
@ LEAF_POSTING_SOURCE
Value returned by get_type() for a PostingSource.
Definition: query.h:260
virtual Xapian::Query operator()(const std::string &begin, const std::string &end)
Check for a valid range of this type.
This class implements the DPH weighting scheme.
Definition: weight.h:1331
void add_document(const Xapian::MSetIterator &i)
Add a document to the relevance set.
Definition: enquire.h:98
bool is_whitespace(unsigned ch)
Test if a given Unicode character is a whitespace character.
Definition: unicode.h:361
Base class for field processors.
Definition: queryparser.h:721
This class implements the PL2 weighting scheme.
Definition: weight.h:1168
stat_flags
Stats which the weighting scheme can use (see need_stat()).
Definition: weight.h:38
const Query operator*(double factor, const Query &q)
Scale a Xapian::Query object using OP_SCALE_WEIGHT.
Definition: query.h:661
InternalError(const std::string &msg_, int errno_)
Construct from message and errno value.
Definition: error.h:785
ValueIterator values_end() const
Equivalent end iterator for values_begin().
Definition: document.h:271
ESetIterator operator+(ESetIterator::difference_type n, const ESetIterator &it)
Return ESetIterator it incremented by n positions.
Definition: eset.h:337
DatabaseClosedError(const std::string &msg_, const std::string &context_=std::string(), int errno_=0)
General purpose constructor.
Definition: error.h:1113
Class for iterating over a list of document ids.
An iterator which returns Unicode character values from a UTF-8 encoded string.
Definition: unicode.h:38
QueryParserError(const std::string &msg_, const std::string &context_=std::string(), int errno_=0)
General purpose constructor.
Definition: error.h:903
void compact(const std::string &output, unsigned flags=0, int block_size=0)
Produce a compact version of this database.
Definition: database.h:615
~Query()
Destructor.
Definition: query.h:313
Base class which provides an "external" source of postings.
Definition: postingsource.h:47
const int DBCHECK_SHOW_FREELIST
Show the bitmap for the B-tree.
Definition: constants.h:222
Base class for range processors.
Definition: queryparser.h:132
ExpandDecider subclass which restrict terms to a particular prefix.
Definition: expanddecider.h:143
TermIterator termlist_end() const
Equivalent end iterator for termlist_begin().
Definition: document.h:260
Query(const Query &o)
Copying is allowed.
Definition: query.h:319
unsigned tolower(unsigned ch)
Convert a Unicode character to lowercase.
Definition: unicode.h:376
@ PRIVATE_USE
Other, private use (Co)
Definition: unicode.h:238
MatchSpy()
Default constructor, needed by subclass constructors.
Definition: matchspy.h:60
Xapian::Weight subclass implementing the BM25 probabilistic formula.
Definition: weight.h:513
AssertionError(const std::string &msg_, const std::string &context_=std::string(), int errno_=0)
General purpose constructor.
Definition: error.h:215
NumberRangeProcessor(Xapian::valueno slot_, const std::string &str_=std::string(), unsigned flags_=0)
Constructor.
Definition: queryparser.h:375
bool operator<=(const ESetIterator &a, const ESetIterator &b)
Inequality test for ESetIterator objects.
Definition: eset.h:327
A relevance set (R-Set).
Definition: enquire.h:60
ESetIterator back() const
Return iterator pointing to the last object in this ESet.
Definition: eset.h:362
Indicates an attempt to use a feature which is unavailable.
Definition: error.h:719
const Query operator&=(Query &a, const InvertedQuery_ &b)
Combine two Xapian::Query objects using OP_AND_NOT with result in the first.
Definition: query.h:726
int revision()
Report the revision of the library which the program is linked with.
Definition: xapian.h:142
std::string sortable_serialise(double value)
Convert a floating point number to a string, preserving sort order.
Definition: queryparser.h:1305
int convert_to_percent(double weight) const
Convert a weight to a percentage.
Hierarchy of classes which Xapian can throw as exceptions.
bool is_wordchar(unsigned ch)
Test if a given Unicode character is "word character".
Definition: unicode.h:343
Handle a number range.
Definition: queryparser.h:335
Decide if a Xapian::Error exception should be ignored.
Xapian::termcount get_doclength_lower_bound() const
A lower bound on the minimum length of any document in the database.
Definition: weight.h:378
MSetIterator operator+(difference_type n) const
Return the iterator incremented by n positions.
Definition: mset.h:435
const Query operator|(const Query &a, const Query &b)
Combine two Xapian::Query objects using OP_OR.
Definition: query.h:643
Class for iterating over document values.
Definition: valueiterator.h:40
int flags
For backward compatibility with Xapian 1.2.
Definition: termgenerator.h:98
void index_text(const std::string &text, Xapian::termcount wdf_inc=1, const std::string &prefix=std::string())
Index some text in a std::string.
Definition: termgenerator.h:216
std::string get_description() const
Return a string describing this object.
void compact(int fd, unsigned flags, int block_size, Xapian::Compactor &compactor)
Produce a compact version of this database.
Definition: database.h:766
Class for counting the frequencies of values in the matching documents.
Definition: matchspy.h:205
RangeProcessor * release()
Start reference counting this object.
Definition: queryparser.h:223
std::string serialise() const
Serialise this object into a string.
const ExpandDecider * release() const
Start reference counting this object.
Definition: expanddecider.h:77
const Query get_subquery(size_t n) const
Read a top level subquery.
InvalidArgumentError(const std::string &msg_, int errno_)
Construct from message and errno value.
Definition: error.h:265
DatabaseError indicates some sort of database related error.
Definition: error.h:367
const Query operator/(const Query &q, double factor)
Inverse-scale a Xapian::Query object using OP_SCALE_WEIGHT.
Definition: query.h:683
FeatureUnavailableError(const std::string &msg_, const std::string &context_=std::string(), int errno_=0)
General purpose constructor.
Definition: error.h:735
The base class for exceptions indicating errors in the program logic.
Definition: error.h:154
@ LINE_SEPARATOR
Separator, line (Zl)
Definition: unicode.h:234
A sequence of latitude-longitude coordinates.
Definition: geospatial.h:232
Indicates an attempt to access a closed database.
Definition: error.h:1097
DatabaseError(const std::string &msg_, int errno_)
Construct from message and errno value.
Definition: error.h:391
DateValueRangeProcessor(Xapian::valueno slot_, bool prefer_mdy_=false, int epoch_year_=1970)
Constructor.
Definition: queryparser.h:527
Class for iterating over a list of terms.
Definition: termiterator.h:41
@ MODIFIER_SYMBOL
Symbol, modified (Sk)
Definition: unicode.h:249
LatLongCoords()
Construct an empty container.
Definition: geospatial.h:266
DatabaseModifiedError(const std::string &msg_, const std::string &context_=std::string(), int errno_=0)
General purpose constructor.
Definition: error.h:555
Xapian::termcount get_doclength_upper_bound() const
An upper bound on the maximum length of any document in the database.
Definition: weight.h:368
bool operator>(const ESetIterator &a, const ESetIterator &b)
Inequality test for ESetIterator objects.
Definition: eset.h:307
Class representing a stemming algorithm.
Definition: stem.h:62
@ OP_AND_NOT
Match documents which the first subquery matches but no others do.
Definition: query.h:99
Query(op op_, I begin, I end, Xapian::termcount window=0)
Construct a Query object from a begin/end iterator pair.
Definition: query.h:458
DatabaseCorruptError indicates database corruption was detected.
Definition: error.h:409
void remove_value(const std::string &value)
Remove a value from the test set.
Definition: valuesetmatchdecider.h:84
double operator()(const LatLongCoords &a, const std::string &b) const
Return the distance between two coordinate lists, in metres.
Definition: geospatial.h:337
An iterator across the values in a LatLongCoords object.
Definition: geospatial.h:165
Indicates an error in the std::string serialisation of an object.
Definition: error.h:929
const int DBCHECK_FIX
Fix problems.
Definition: constants.h:243
int major_version()
Report the major version of the library which the program is linked with.
Definition: xapian.h:124
#define XAPIAN_TOTALLENGTH_TYPE
Type for returning total document length.
Definition: version.h:80
Class for looking up user subclasses during unserialisation.
void set_termfreq_min(Xapian::doccount termfreq_min_)
Set a lower bound on the term frequency.
Definition: postingsource.h:540
StringValueRangeProcessor(Xapian::valueno slot_)
Constructor.
Definition: queryparser.h:474
Xapian::valueno get_slot() const
The slot we're reading values from.
Definition: postingsource.h:508
DateRangeProcessor(Xapian::valueno slot_, const std::string &str_, unsigned flags_=0, int epoch_year_=1970)
Constructor.
Definition: queryparser.h:309
DatabaseNotFoundError(const std::string &msg_, const std::string &context_=std::string(), int errno_=0)
General purpose constructor.
Definition: error.h:1071
Compact a database, or merge and compact several.
Definition: compactor.h:42
Handle a date range.
Definition: queryparser.h:245
std::string str
The prefix (or suffix if prefix==false) string to look for.
Definition: queryparser.h:467
const int DB_NO_SYNC
Don't attempt to ensure changes have hit disk.
Definition: constants.h:66
void set_multipass(bool multipass)
Set whether to merge postlists in multiple passes.
Definition: compactor.h:102
Class for iterating over a list of terms.
PositionIterator positionlist_end() const
Return an end PositionIterator for the current term.
Definition: termiterator.h:104
void set_max_expansion(Xapian::termcount max_expansion, int max_type=Xapian::Query::WILDCARD_LIMIT_ERROR, unsigned flags=FLAG_WILDCARD|FLAG_PARTIAL)
Specify the maximum expansion of a wildcard and/or partial term.
This class implements the IneB2 weighting scheme.
Definition: weight.h:960
const std::string & get_context() const
Optional context information.
Definition: error.h:133
Xapian::TermIterator spellings_end() const
Corresponding end iterator to spellings_begin().
Definition: database.h:424
const std::string & get_msg() const
Message giving details of the error, intended for human consumption.
Definition: error.h:122
static const Xapian::Query MatchNothing
A query matching no documents.
Definition: query.h:65
UnimplementedError(const std::string &msg_, int errno_)
Construct from message and errno value.
Definition: error.h:349
TermIterator()
Default constructor.
Definition: termiterator.h:80
size_t size() const
Get the number of coordinates in the container.
Definition: geospatial.h:248
@ OTHER_SYMBOL
Symbol, other (So)
Definition: unicode.h:250
AssertionError(const std::string &msg_, int errno_)
Construct from message and errno value.
Definition: error.h:223
Handle a number range.
Definition: queryparser.h:654
WritableDatabase open()
Construct a WritableDatabase object for a new, empty InMemory database.
Definition: dbfactory.h:104
Iterator over a Xapian::MSet.
Definition: mset.h:347
PostingSource * release()
Start reference counting this object.
Definition: postingsource.h:372
ExpandDecider subclass which rejects terms using two ExpandDeciders.
Definition: expanddecider.h:88
const TermIterator get_unique_terms_end() const
End iterator for unique terms in the query object.
Definition: query.h:507
PositionIterator()
Default constructor.
Definition: positioniterator.h:81
DatabaseVersionError indicates that a database is in an unsupported format.
Definition: error.h:632
const int DB_DANGEROUS
Update the database in-place.
Definition: constants.h:103
PositionIterator positionlist_end() const
Return an end PositionIterator for the current document.
Definition: postingiterator.h:109
DocNotFoundError(const std::string &msg_, const std::string &context_=std::string(), int errno_=0)
General purpose constructor.
Definition: error.h:690
BM25Weight(double k1, double k2, double k3, double b, double min_normlen)
Construct a BM25Weight.
Definition: weight.h:558
const int DBCHECK_FULL_TREE
Show a full display of the B-tree contents.
Definition: constants.h:216
@ SPACE_SEPARATOR
Separator, space (Zs)
Definition: unicode.h:233
ValueIterator()
Default constructor.
Definition: valueiterator.h:81
const int DBCHECK_SHORT_TREE
Show a short-format display of the B-tree contents.
Definition: constants.h:210
MSetIterator & operator-=(difference_type n)
Move the iterator back by n positions.
Definition: mset.h:426
Class for iterating over a list of terms.
Definition: postingiterator.h:41
Indicates a query string can't be parsed.
Definition: error.h:887
Decide if a Xapian::Error exception should be ignored.
Definition: errorhandler.h:50
const ErrorHandler * release() const
Start reference counting this object.
Definition: errorhandler.h:117
ErrorHandler * release()
Start reference counting this object.
Definition: errorhandler.h:105
void done()
End the iteration.
Definition: postingsource.h:522
@ DASH_PUNCTUATION
Punctuation, dash (Pd)
Definition: unicode.h:241
ESetIterator & operator+=(difference_type n)
Move the iterator forwards by n positions.
Definition: eset.h:233
const ValueRangeProcessor * release() const
Start reference counting this object.
Definition: queryparser.h:446
MultiValueKeyMaker(Iterator begin, Iterator end)
Construct a MultiValueKeyMaker from a pair of iterators.
Definition: keymaker.h:125
DatabaseError(const std::string &msg_, const std::string &context_=std::string(), int errno_=0)
General purpose constructor.
Definition: error.h:383
DatabaseCorruptError(const std::string &msg_, const std::string &context_=std::string(), int errno_=0)
General purpose constructor.
Definition: error.h:425
const Query operator^(const Query &a, const Query &b)
Combine two Xapian::Query objects using OP_XOR.
Definition: query.h:650
double metres_to_miles(double metres)
Convert from metres to miles.
Definition: geospatial.h:67
ESetIterator operator--(int)
Move the iterator to the previous position (postfix version).
Definition: eset.h:203
Utf8Iterator & operator++()
Move forward to the next Unicode character.
Definition: unicode.h:176
LatLongDistanceKeyMaker(Xapian::valueno slot_, const LatLongCoord ¢re_, const LatLongMetric &metric_)
Construct a LatLongDistanceKeyMaker.
Definition: geospatial.h:650
Query(op op_, const std::string &a, const std::string &b)
Construct a Query object by combining two terms.
Definition: query.h:390
MSetIterator end() const
Return iterator pointing to just after the last item in this MSet.
Definition: mset.h:608
Xapian::termcount get_wdf_upper_bound() const
An upper bound on the wdf of this term.
Definition: weight.h:386
unsigned valueno
The number for a value slot in a document.
Definition: types.h:108
SerialisationError(const std::string &msg_, const std::string &context_=std::string(), int errno_=0)
General purpose constructor.
Definition: error.h:945
Compact a database, or merge and compact several.
size_t get_total() const
Return the total number of documents tallied.
Definition: matchspy.h:241
int percent
The percentage score for a document in an MSet.
Definition: types.h:66
double doclength
A normalised document length.
Definition: types.h:59
QueryParserError(const std::string &msg_, int errno_)
Construct from message and errno value.
Definition: error.h:911
The base class for exceptions indicating errors only detectable at runtime.
Definition: error.h:176
const int DB_BACKEND_INMEMORY
Use the "in memory" backend.
Definition: constants.h:195
API for working with Xapian databases.
DPHWeight()
Construct a DPHWeight.
Definition: weight.h:1348
Constants in the Xapian namespace.
All exceptions thrown by Xapian are subclasses of Xapian::Error.
Definition: error.h:43
double sortable_unserialise(const std::string &serialised)
Convert a string encoded using sortable_serialise back to a floating point number.
External sources of posting information.
Class for iterating over term positions.
ExpandDecider subclass which rejects terms in a specified list.
Definition: expanddecider.h:119
Xapian::doccount get_firstitem() const
Rank of first item in this MSet.
bool empty() const
Return true if this MSet object is empty.
Definition: mset.h:279
BM25PlusWeight(double k1, double k2, double k3, double b, double min_normlen, double delta)
Construct a BM25PlusWeight.
Definition: weight.h:672
Simple implementation of Stopper class - this will suit most users.
Definition: queryparser.h:96
unsigned XAPIAN_TERMPOS_BASE_TYPE termpos
A term position within a document or query.
Definition: types.h:83
TermIterator stoplist_end() const
End iterator over terms omitted from the query as stopwords.
Definition: queryparser.h:1210
A posting source which looks up weights in a map using values as the key.
Definition: postingsource.h:685
UnimplementedError indicates an attempt to use an unimplemented feature.
Definition: error.h:325
WritableDatabase open_writable(const std::string &host, unsigned int port, useconds_t timeout=0, useconds_t connect_timeout=10000, int flags=0)
Construct a WritableDatabase object for update access to a remote database accessed via a TCP connect...
Virtual base class for expand decider functor.
Definition: expanddecider.h:37
virtual ~Stopper()
Class has virtual methods, so provide a virtual destructor.
Definition: queryparser.h:65
size_t left() const
Return the number of bytes left in the iterator's buffer.
Definition: unicode.h:59
LatLongDistanceKeyMaker(Xapian::valueno slot_, const LatLongCoord ¢re_, const LatLongMetric &metric_, double defdistance)
Construct a LatLongDistanceKeyMaker.
Definition: geospatial.h:629
DateValueRangeProcessor(Xapian::valueno slot_, const std::string &str_, bool prefix_=true, bool prefer_mdy_=false, int epoch_year_=1970)
Constructor.
Definition: queryparser.h:569
std::string get_value() const
Read current value.
Definition: postingsource.h:514
Class representing a list of search results.
Definition: mset.h:44
ESetIterator operator-(difference_type n) const
Return the iterator decremented by n positions.
Definition: eset.h:256
unsigned XAPIAN_DOCID_BASE_TYPE doccount
A count of documents.
Definition: types.h:38
DatabaseLockError indicates failure to lock a database.
Definition: error.h:493
Abstract base class for weighting schemes.
Definition: weight.h:35
@ ENCLOSING_MARK
Mark, enclosing (Me)
Definition: unicode.h:228
@ LETTER_NUMBER
Number, letter (Nl)
Definition: unicode.h:231
void set_termfreq_max(Xapian::doccount termfreq_max_)
An upper bound on the term frequency.
Definition: postingsource.h:562
DatabaseCorruptError(const std::string &msg_, int errno_)
Construct from message and errno value.
Definition: error.h:433
void remove_document(const Xapian::MSetIterator &i)
Remove a document from the relevance set.
Definition: enquire.h:104
This class implements the InL2 weighting scheme.
Definition: weight.h:816
~PostingIterator()
Destructor.
Definition: postingiterator.h:84
RangeError(const std::string &msg_, const std::string &context_=std::string(), int errno_=0)
General purpose constructor.
Definition: error.h:987
Xapian::Weight subclass implementing the PL2+ probabilistic formula.
Definition: weight.h:1235
Base class for value range processors.
Definition: queryparser.h:396
FeatureUnavailableError(const std::string &msg_, int errno_)
Construct from message and errno value.
Definition: error.h:743
MSetIterator operator--(int)
Move the iterator to the previous position (postfix version).
Definition: mset.h:390
Unicode and UTF-8 related classes and functions.
#define XAPIAN_TERMPOS_BASE_TYPE
Base (signed) type for Xapian::termpos.
Definition: version.h:77
void set_termfreq_est(Xapian::doccount termfreq_est_)
An estimate of the term frequency.
Definition: postingsource.h:551
const int DB_BACKEND_STUB
Open a stub database file.
Definition: constants.h:179
void compact(int fd, unsigned flags=0, int block_size=0)
Produce a compact version of this database.
Definition: database.h:663
ExpandDeciderAnd(const ExpandDecider *first_, const ExpandDecider *second_)
Compatibility method.
Definition: expanddecider.h:107
@ WILDCARD_LIMIT_ERROR
Throw an error if OP_WILDCARD exceeds its expansion limit.
Definition: query.h:282
DateRangeProcessor(Xapian::valueno slot_, unsigned flags_=0, int epoch_year_=1970)
Constructor.
Definition: queryparser.h:262
LatLongDistanceKeyMaker(Xapian::valueno slot_, const LatLongCoord ¢re_)
Construct a LatLongDistanceKeyMaker.
Definition: geospatial.h:671
InvalidOperationError indicates the API was used in an invalid way.
Definition: error.h:283
NetworkError(const std::string &msg_, int errno_)
Construct from message and errno value.
Definition: error.h:827
size_t size() const
Return number of shards in this Database object.
Definition: database.h:93
MSetIterator back() const
Return iterator pointing to the last object in this MSet.
Definition: mset.h:620
#define XAPIAN_TERMCOUNT_BASE_TYPE
Base (signed) type for Xapian::termcount and related types.
Definition: version.h:74
const MatchSpy * release() const
Start reference counting this object.
Definition: matchspy.h:196
void add_valuerangeprocessor(Xapian::ValueRangeProcessor *vrproc)
Register a ValueRangeProcessor.
Definition: queryparser.h:1231
Indicates a timeout expired while communicating with a remote database.
Definition: error.h:845
Base class for matcher decision functor.
Definition: enquire.h:118
@ UPPERCASE_LETTER
Letter, uppercase (Lu)
Definition: unicode.h:222
Xapian::termcount get_length() const
Return the length of this query object.
WildcardError(const std::string &msg_, int errno_)
Construct from message and errno value.
Definition: error.h:1037
Class representing a stemming algorithm implementation.
Definition: stem.h:38
const int DBCHECK_SHOW_STATS
Show statistics for the B-tree.
Definition: constants.h:228
StringValueRangeProcessor(Xapian::valueno slot_, const std::string &str_, bool prefix_=true)
Constructor.
Definition: queryparser.h:485
Parses a piece of text and generate terms.
Definition: termgenerator.h:48
#define XAPIAN_REVISION_TYPE
Underlying type for Xapian::rev.
Definition: version.h:83
Iterator over a Xapian::ESet.
Definition: eset.h:160
MSetIterator & operator++()
Advance the iterator to the next position.
Definition: mset.h:371
bool operator==(const LatLongCoordsIterator &other) const
Equality test for LatLongCoordsIterator objects.
Definition: geospatial.h:199
bool empty() const
Check if this query is Xapian::Query::MatchNothing.
Definition: query.h:515
Xapian::doclength get_average_length() const
The average length of a document in the collection.
Definition: weight.h:347
KeyMaker subclass which sorts by distance from a latitude/longitude.
Definition: geospatial.h:551
DatabaseOpeningError(const std::string &msg_, const std::string &context_=std::string(), int errno_=0)
General purpose constructor.
Definition: error.h:597
Posting source which returns a weight based on geospatial distance.
Definition: geospatial.h:454
Xapian::doccount get_reltermfreq() const
The number of relevant documents which this term indexes.
Definition: weight.h:353
StemImplementation()
Default constructor.
Definition: stem.h:49
DerefWrapper_< LatLongCoord > operator++(int)
Advance the iterator to the next position (postfix version).
Definition: geospatial.h:192
double latitude
A latitude, as decimal degrees.
Definition: geospatial.h:88
Xapian::docid range_start
Start of range of docids for which weights are known to be decreasing.
Definition: postingsource.h:632
MatchDecider subclass for filtering results by value.
static const Query unserialise(const std::string &serialised, const Registry ®=Registry())
Unserialise a string and return a Query object.
Xapian::Weight subclass implementing the Language Model formula.
Definition: weight.h:1384
Xapian::termcount get_collection_freq() const
The collection frequency of the term.
Definition: weight.h:356
ESetIterator & operator--()
Move the iterator to the previous position.
Definition: eset.h:197
@ FORMAT
Other, format (Cf)
Definition: unicode.h:237
void add_boolean_prefix(const std::string &field, const std::string &prefix, bool exclusive)
Add a boolean term prefix allowing the user to restrict a search with a boolean filter specified in t...
Definition: queryparser.h:1176
Xapian::doccount get_rset_size() const
The number of documents marked as relevant.
Definition: weight.h:344
unsigned XAPIAN_DOCID_BASE_TYPE docid
A unique identifier for a document.
Definition: types.h:52
const char * get_type() const
The type of this error (e.g. "DocNotFoundError".)
Definition: error.h:117
Read weights from a value which is known to decrease as docid increases.
Definition: postingsource.h:625
DerefWrapper_< Xapian::termpos > operator++(int)
Advance the iterator to the next position (postfix version).
Definition: positioniterator.h:96
double get_maxweight() const
Return the currently set upper bound on what get_weight() can return.
Definition: postingsource.h:131
LatLongDistanceKeyMaker(Xapian::valueno slot_, const LatLongCoords ¢re_)
Construct a LatLongDistanceKeyMaker.
Definition: geospatial.h:614
LatLongDistanceKeyMaker(Xapian::valueno slot_, const LatLongCoords ¢re_, const LatLongMetric &metric_)
Construct a LatLongDistanceKeyMaker.
Definition: geospatial.h:594
bool get_started() const
Flag indicating if we've started (true if we have).
Definition: postingsource.h:531
parse free text and generate terms
This class provides read/write access to a database.
Definition: database.h:777
const int DBCOMPACT_MULTIPASS
If merging more than 3 databases, merge the postlists in multiple passes.
Definition: constants.h:262
RangeProcessor()
Default constructor.
Definition: queryparser.h:165
DocNotFoundError(const std::string &msg_, int errno_)
Construct from message and errno value.
Definition: error.h:698
TfIdfWeight()
Construct a TfIdfWeight using the default normalizations ("ntn").
Definition: weight.h:487
MatchSpy * release()
Start reference counting this object.
Definition: matchspy.h:184
The Xapian namespace contains public interfaces for the Xapian library.
Definition: error.h:34
DatabaseLockError(const std::string &msg_, int errno_)
Construct from message and errno value.
Definition: error.h:517
WildcardError(const std::string &msg_, const std::string &context_=std::string(), int errno_=0)
General purpose constructor.
Definition: error.h:1029
Calculate the great-circle distance between two coordinates on a sphere.
Definition: geospatial.h:399
@ CURRENCY_SYMBOL
Symbol, currency (Sc)
Definition: unicode.h:248
void assign(const std::string &s)
Assign a new string to the iterator.
Definition: unicode.h:92
NetworkTimeoutError(const std::string &msg_, int errno_)
Construct from message and errno value.
Definition: error.h:869
DatabaseCreateError(const std::string &msg_, int errno_)
Construct from message and errno value.
Definition: error.h:475
TermIterator top_values_end(size_t) const
End iterator corresponding to top_values_begin()
Definition: matchspy.h:272
compaction_level
Compaction level.
Definition: compactor.h:48
DatabaseClosedError(const std::string &msg_, int errno_)
Construct from message and errno value.
Definition: error.h:1121
LatLongCoordsIterator end() const
Get an end iterator for the coordinates.
Definition: geospatial.h:243
Xapian::Weight subclass implementing the tf-idf weighting scheme.
Definition: weight.h:425
Class representing a query.
Definition: query.h:46
TermIterator values_end() const
End iterator corresponding to values_begin()
Definition: matchspy.h:255
void set_max_wildcard_expansion(Xapian::termcount)
Specify the maximum expansion of a wildcard.
Definition: queryparser.h:1268
ESetIterator operator+(difference_type n) const
Return the iterator incremented by n positions.
Definition: eset.h:248
void set_renumber(bool renumber)
Set whether to preserve existing document id values.
Definition: compactor.h:90
ESetIterator operator++(int)
Advance the iterator to the next position (postfix version).
Definition: eset.h:190
bool empty() const
Return true if and only if there are no coordinates in the container.
Definition: geospatial.h:254
void swap(MSet &o)
Efficiently swap this MSet object with another.
Definition: mset.h:282
Mechanism for accessing a struct of constant information.
@ FLAG_WILDCARD
Support wildcards.
Definition: queryparser.h:801
RangeError indicates an attempt to access outside the bounds of a container.
Definition: error.h:971
void index_text_without_positions(const std::string &text, Xapian::termcount wdf_inc=1, const std::string &prefix=std::string())
Index some text in a std::string without positional information.
Definition: termgenerator.h:246
void add_boolean_prefix(const std::string &field, Xapian::FieldProcessor *proc, bool exclusive)
Register a FieldProcessor for a boolean prefix.
Definition: queryparser.h:1196
DerefWrapper_< Xapian::docid > operator++(int)
Advance the iterator to the next position (postfix version).
Definition: postingiterator.h:117
Xapian::valueno slot
The value slot to process.
Definition: queryparser.h:145
MSetIterator operator-(difference_type n) const
Return the iterator decremented by n positions.
Definition: mset.h:443
ESetIterator begin() const
Return iterator pointing to the first item in this ESet.
Definition: eset.h:345
ESetIterator()
Create an unpositioned ESetIterator.
Definition: eset.h:178
bool operator!=(const ESetIterator &a, const ESetIterator &b)
Inequality test for ESetIterator objects.
Definition: eset.h:287
FieldProcessor()
Default constructor.
Definition: queryparser.h:731
Geospatial search support routines.
const int DB_NO_TERMLIST
When creating a database, don't create a termlist table.
Definition: constants.h:136
A handle representing a document in a Xapian database.
Definition: document.h:61
Xapian::Weight subclass implementing the BM25+ probabilistic formula.
Definition: weight.h:617
const int DB_BACKEND_CHERT
Use the chert backend.
Definition: constants.h:170
This class is used to access a database, or a group of databases.
Definition: database.h:68
DateValueRangeProcessor(Xapian::valueno slot_, const char *str_, bool prefix_=true, bool prefer_mdy_=false, int epoch_year_=1970)
Constructor.
Definition: queryparser.h:620
Class representing a list of search results.
UnimplementedError(const std::string &msg_, const std::string &context_=std::string(), int errno_=0)
General purpose constructor.
Definition: error.h:341
~PositionIterator()
Destructor.
Definition: positioniterator.h:85
bool contains(const Xapian::MSetIterator &i) const
Test if a given document in the relevance set.
Definition: enquire.h:110
@ LEAF_MATCH_ALL
Value returned by get_type() for MatchAll or equivalent.
Definition: query.h:267
MSet get_mset(Xapian::doccount first, Xapian::doccount maxitems, const RSet *omrset, const MatchDecider *mdecider=0) const
Get (a portion of) the match set for the current query.
Definition: enquire.h:576
KeyMaker()
Default constructor.
Definition: keymaker.h:51
void add_boolean_term(const std::string &term)
Add a boolean filter term to the document.
Definition: document.h:191
Indicates a problem communicating with a remote database.
Definition: error.h:803
static std::string get_available_languages()
Return a list of available languages.
Definition: stem.h:181
Documentation for Xapian (version 1.4.16).
Generated on Mon Jun 8 2020 by
Doxygen 1.8.17.