9Rc @ s^1 d Z d d l m Z e d d d f k r7 d Z n d d l m Z e d d d f k rt d Z e Z [ n d d
l Z [ y
e Z Wn e
k
r n Xd d Z d
Z d Z
d Z y e Z d Z Wn* e k
rd f d YZ d Z n Xd Z y d d
l Z e j Z Wn d Z n Xd e f d YZ e e j e e e _ e e j e e e _ e e j e e e _ e e j e e e _ e e j! e e e _" e e j# e e e _$ e e j% e e e _& e e j' e e e _( e e j) e e e _* e e j+ e e e _, e e j- e e e _. e e j/ e e e _0 e e j1 e e e _2 e e j3 e e e _4 e e j5 e e e _6 e e j7 e e e _8 e j9 Z9 e9 e d Z: e j; Z; e j< Z< e j= Z= e j> Z> e j? Z? e j@ Z@ e jA ZA e jB ZB d eC f d YZD e e jE e eD eD _F e e jG e eD eD _H e e jI e eD eD _J e e jK e eD eD _L e e jM e eD eD _N e jO ZO eO eD d eD f d YZP e jQ ZQ eQ eP d eD f d YZR e jS ZS eS eR d eP f d YZT e jU ZU eU eT d eP f d YZV e jW ZW eW eV d! eP f d" YZX e jY ZY eY eX d# eP f d$ YZZ e j[ Z[ e[ eZ d% eR f d& YZ\ e j] Z] e] e\ d' e\ f d( YZ^ e j_ Z_ e_ e^ d) e\ f d* YZ` e ja Za ea e` d+ e\ f d, YZb e jc Zc ec eb d- e\ f d. YZd e je Ze ee ed d/ e\ f d0 YZf e jg Zg eg ef d1 ef f d2 YZh e ji Zi ei eh d3 eR f d4 YZj e jk Zk ek ej d5 eR f d6 YZl e jm Zm em el d7 eR f d8 YZn e jo Zo eo en d9 eR f d: YZp e jq Zq eq ep d; ep f d< YZr e js Zs es er d= eR f d> YZt e ju Zu eu et d? eR f d@ YZv e jw Zw ew ev dA eR f dB YZx e jy Zy ey ex dC Zz e jz Zz dD Z{ e j{ Z{ dE Z| e j| Z| dF Z} e j} Z} dG e f dH YZ~ e e j e e~ e~ _ e e j e e~ e~ _& e e j e e~ e~ _ e e j e e~ e~ _ e e j e e~ e~ _N e e j e e~ e~ _. e e j e e~ e~ _0 e j Z e e~ dI e f dJ YZ e e j e e e _ e e j e e e _ e e j e e e _ e e j e e e _ e e j e e e _ e e j e e e _N e e j e e e _. e e j e e e _0 e e j e e e _ e e j e e e _& e e j e e e _ e j Z e e dK Z. e j. Z. dL Z0 e j0 Z0 dM e f dN YZ e e j e e e _ e e j e e e _& e e j e e e _ e e j e e e _ e e j e e e _ e e j e e e _ e e j e e e _ e e j e e e _ e e j e e e _ e e j e e e _N e e j e e e _. e e j e e e _0 e j Z e e dO e f dP YZ e e j e e e _ e e j e e e _& e e j e e e _ e e j e e e _ e e j e e e _ e e j e e e _ e e j e e e _ e e j e e e _N e e j e e e _. e e j e e e _0 e j Z e e dQ e f dR YZ e e j e e e _ e e j e e e _ e e j e e e _ e e j e e e _ e e j e e e _ e e j e e e _ e e j e e e _ e e j e e e _ e e j e e e _ e e j e e e _ e e j e e e _ e e j e e e _ e e j e e e _ e e j e e e _ e e j e e e _ e e j e e e _ e e j e e e _ e e j e e e _ e e j e e e _ e e j e e e _ e e j e e e _N e j Z e e dS Z e j Z dT e f dU YZ e e j e e e _ e e j e e e _ e e j e e e _ e e j e e e _ e e j e e e _ e e j e e e _ e e j e e e _& e e j e e e _ e e j e e e _ e e j e e e _ e e j e e e _ e e j e e e _ e e j e e e _N e j Z e e dV e f dW YZ e j Z e e dX e f dY YZ e j Z e e dZ e f d[ YZe jZee d\ e f d] YZe e je e e_e e je e e_e e je e e_ e j
Z
e
e d^ e f d_ YZ e j Z e e d` e f da YZ
e e je e
e
_e e je e
e
_e e je e
e
_ e e je e
e
_e e je e
e
_e e je e
e
_e e je e
e
_e e je e
e
_ e e j e e
e
_ e e j e e
e
_ e e j!e e
e
_"e e j#e e
e
_$e e j%e e
e
_&e e j'e e
e
_(e e j)e e
e
_*e e j+e e
e
_,e e j-e e
e
_.e e j/e e
e
_0e e j1e e
e
_2e e j3e e
e
_4e e j5e e
e
_6e e j7e e
e
_ e e j8e e
e
_N e e j9e e
e
_:e j;Z;e;e
db e f dc YZ<e e j=e e< e<_ e e j>e e< e<_& e e j?e e< e<_@e e jAe e< e<_ e e jBe e< e<_6e e jCe e< e<_De e jEe e< e<_ e e jFe e< e<_Ge e jHe e< e<_Ie e jJe e< e<_Ke e jLe e< e<_N e e jMe e< e<_. e e jNe e< e<_0 e jOZOeOe< dd e f de YZPe e jQe eP eP_Re e jSe eP eP_(e e jTe eP eP_*e e jUe eP eP_,e e jVe eP eP_.e e jWe eP eP_0e e jXe eP eP_N e jYZYeYeP df e f dg YZZe e j[e eZ eZ_ e e j\e eZ eZ_& e e j]e eZ eZ_@e e j^e eZ eZ_ e e j_e eZ eZ_ e e j`e eZ eZ_N e e jae eZ eZ_. e e jbe eZ eZ_0 e jcZceceZ dh e f di YZde e jee ed ed_(e e jfe ed ed_*e e jge ed ed_he e jie ed ed_je e jke ed ed_le e jme ed ed_N e jnZnened dj e f dk YZoe e jpe eo eo_qe jrZrereo dl e f dm YZse e jte es es_qe juZueues dn e f do YZve e jwe ev ev_xe e jye ev ev_ze e j{e ev ev_|e e j}e ev ev_~e e je ev ev_e e je ev ev_e e je ev ev_e e je ev ev_e e je ev ev_e e je ev ev_e e je ev ev_e e je ev ev_e e je ev ev_e e je ev ev_e e je ev ev_e e je ev ev_e e je ev ev_e e je ev ev_e e je ev ev_e e je ev ev_N e jZeev dp e f dq YZe e je e e_e e je e e_e e je e e_e e je e e_e e je e e_e e je e e_e jZee dr e f ds YZe e je e e_ e e je e e_e e je e e_e e je e e_e e je e e_e e je e e_e e je e e_e jZee dt ef du YZe jZee dv ef dw YZe jZee dx ef dy YZe jZee dz e f d{ YZe e je e e_qe e je e e_ e e je e e_e e je e e_N e jZee d| ef d} YZe e je e e_e e je e e_ e e je e e_ e e je e e_e e je e e_e jZee d~ e f d YZe e je e e_e e je e e_e e je e e_e e je e e_N e e je e e_e e je e e_e e je e e_ e e je e e_ e e je e e_ e e je e e_ e e je e e_e e je e e_e e je e e_e e je e e_e e je e e_e e je e e_ e e je e e_e e je e e_e e je e e_e e je e e_e e je e e_e e je e e_e e je e e_e e je e e_e e je e e_e e j e e e_e e je e e_ e e je e e_e e je e e_6e e je e e_e e je e e_ e e j
e e e_ e e j e e e_
e e je e e_e e je e e_e e je e e_e e je e e_e e je e e_e e je e e_e e je e e_e e j e e e_ e j Z e e d ef d YZ e e j e e e _!e e j"e e e _#e e j$e e e _%e e j&e e e _'e e j(e e e _)e e j*e e e _he e j+e e e _,e e j-e e e _.e e j/e e e _0e e j1e e e _2e e j3e e e _4e e j5e e e _6e e j7e e e _8e e j9e e e _:e e j;e e e _N e j<Z<e<e e j=Z=e j>Z>e j?Z?e j@Z@d ZAd ZBd ZCd ZDd ZEd ZFd ZGd e f d YZHe e jIe eH eH_Je e jKe eH eH_Le e jMe eH eH_Ne e jOe eH eH_*e e jPe eH eH_ e e jQe eH eH_N e jRZReReH d ZSe jSZSd e f d YZTe e jUe eT eT_qe e jVe eT eT_N e jWZWeWeT d eTf d YZXe e jYe eX eX_Ze j[Z[e[eX d e f d YZ\e e j]e e\ e\_qe j^Z^e^e\ d e\f d YZ_e j`Z`e`e_ d e_f d YZae jbZbebea d e_f d YZce jdZdedec d e f d YZee e jfe ee ee_ge e jhe ee ee_ie e jje ee ee_ke e jle ee ee_me e jne ee ee_oe e jpe ee ee_qe e jre ee ee_se e jte ee ee_ue e jve ee ee_we e jxe ee ee_ye e jze ee ee_{e e j|e ee ee_}e e j~e ee ee_e e je ee ee_e e je ee ee_e e je ee ee_e e je ee ee_N e jZeee d Ze jZd Ze jZd e f d YZe e je e e_qe e je e e_N e jZee d e f d YZe e je e e_qe e je e e_N e jZee d Ze jZd e f d YZe e je e e_ge e je e e_ke e je e e_e e je e e_6e e je e e_qe e je e e_e e je e e_ie e je e e_e e je e e_e e je e e_e e je e e_e e je e e_ e e je e e_e e je e e_N e jZee d e f d YZe e je e e_qe jZee d ef d YZe e je e e_ e jZee d ef d YZe jZee d ef d YZe e je e e_Ze jZee d eof d YZe e je e e_ e e je e e_ e jZee d e f d YZe e je e e_e e je e e_e e je e e_e e je e e_e e je e e_e e je e e_e e je e e_e e je e e_e e je e e_e jZee d Zd e f d YZd e f d YZd Zee
_d e
_d Zee
_ee
_d e f d YZd e f d YZd ZeeP_d eP_d e f d YZd e f d YZd Zeev_d ZeeH_e d Zee_ee_d Zee_d Zee_d Zee_d d Zee_d d Zee_d Zee _ee _d Zeee_d Zeee_d Ze e_[d Ze e_[eHjZd ZeeH_[evjxZd d Zej e_ eev_x[evjzZd Zej e_ eev_z[eejZd Zej e_ eee_[eejkZd Zej e_ eee_k[ejkZd Zej e_ ee_k[d ZevjZ e d Ze j e_ eev_[evjZe d Zej e_ eev_[evjZe d Zej e_ eev_[evjZe d Zej e_ eev_[evjZe d Z ej e _ e ev_[ evjZ
e d Z e
j e _ e ev_[ d e f d YZ d e f d YZ
d Zee_d e f d YZd Zee_d e f d YZd e f d YZd Zee _d e f d YZd e f d YZd Ze e_[e`e`evj|Zd Zevj|j e_ eev_|evj~Zd Z evj~j e _ e ev_~ejZ d Z ejj e _ e e_[ [SeHd eH_ eH eH_ d eZ_( d e<_( d e _( d e~ _( d e _( d e _( g Z!xQ e" D]F Z#e#j$d p41e#j%d p41e#j%d r=1q1n e!j&e# q1We'e! Z!d
S( sz
Xapian is a highly adaptable toolkit which allows developers to easily
add advanced indexing and search facilities to their own
applications. It supports the Probabilistic Information Retrieval
model and also supports a rich set of boolean query operators.
In addition to the doc strings provided by this python library, you
may wish to look at the library's overall documentation, either
installed along with the bindings or online at
, as well as the library's
documentation, possibly installed with the library or with its
development files, or again online at .
i( t version_infoi i c C s
t j | S( N( t _xapiant SWIG_PyInstanceMethod_New( t funct instt cls( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt s ( t instancemethodi i c C s d d l m } d d l } d } y( | j d | t g \ } } } Wn t k
rj d d l } | SX| d k r z | j d | | | } Wd | j X| Sd S( Ni( t dirnameR (
t os.pathR t impt Nonet find_modulet __file__t ImportErrorR t load_modulet close( R R
t fpt pathnamet descriptionR t _mod( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt swig_import_helper s (
Ni c C s | d k r | j j | S| d k rQ t | j d k rQ | | j | | | St | d S( NR ( R R t __swig_getmethods__R R R ( R R! R" R% ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt
_swig_getattrD s
c C sD y d | j j } Wn
d } n Xd | j j | j j | f S( Ns proxy of t s <%s.%s; %s >( R t __repr__t __class__t
__module__R ( R t strthis( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt
_swig_reprJ s
t _objectc B s e Z RS( ( R R- ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR0 S s c s f d } | S( Nc s^ | d k r | j j | St | | s7 | d k rJ | | | n t d | d S( NR R s You cannot add attributes to %s( R R t hasattrR ( R R" R# ( t set( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt set_attrX s
( ( R2 R3 ( ( R2 s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt _swig_setattr_nondynamic_methodW s c C s | S( N( ( t x( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR e s t SwigPyIteratorc B sD e Z e d d d d Z d Z e Z e j Z d Z
RS( c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR i s c C s | j j | S( N( R R ( R5 t v( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR i s t docs The membership flagc O s t d d S( Ns* No constructor defined - class is abstract( R ( R t argst kwargs( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt __init__j s c C s | S( N( ( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt __iter__m s ( R R- t _swig_propertyR R; R/ R+ R t delete_SwigPyIteratort __swig_destroy__R< ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR6 h s
s 1.2.16t Errorc B sh e Z d Z i Z d Z i Z d Z d Z e Z d Z
d Z d Z d Z
e j Z RS( s
All exceptions thrown by Xapian are subclasses of Xapian::Error.
This class can not be instantiated directly - instead a subclass
should be used.
c C s t | t | | S( N( R' R@ ( R R" R# ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c C s t | t | S( N( R) R@ ( R R" ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c O s t d d S( Ns No constructor defined( R ( R R9 R: ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; s c C s
t j | S( sy
The type of this error (e.g. "DocNotFoundError".)
const char* Xapian::Error::get_type() const
( R t Error_get_type( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_type s c C s
t j | S( s
Message giving details of the error, intended for human consumption.
const std::string& Xapian::Error::get_msg() const
( R t
Error_get_msg( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_msg s c C s
t j | S( s
Optional context information.
const std::string& Xapian::Error::get_context() const
This context is intended for use by Xapian::ErrorHandler (for example
so it can know which remote server is unreliable and report the
problem and remove that server from those being searched). But it's
typically a plain-text string, and so also fit for human consumption.
( R t Error_get_context( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_context s c C s
t j | S( sL
Returns any system error string associated with this exception.
const char* Xapian::Error::get_error_string() const
The system error string may come from errno, h_errno (on UNIX), or
GetLastError() (on MS Windows). If there is no associated system error
string, NULL is returned.
( R t Error_get_error_string( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_error_string s
( R R- t __doc__R t __setattr__R( t __getattr__R; R/ R+ RB RD RF RH R t delete_ErrorR? ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR@ s t
LogicErrorc B s e Z d Z i Z x* e g D] Z e j e e d i q Wd Z i Z x* e g D] Z e j e e d i qX Wd Z
d Z e Z
e j Z RS( s
The base class for exceptions indicating errors in the program logic.
A subclass of LogicError will be thrown if Xapian detects a violation
of a class invariant or a logical precondition or postcondition, etc.
R c C s t | t | | S( N( R' RM ( R R" R# ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s R( c C s t | t | S( N( R) RM ( R R" ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c O s t d d S( Ns No constructor defined( R ( R R9 R: ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; s ( R R- RI R R@ t _st updatet getattrRJ R( RK R; R/ R+ R t delete_LogicErrorR? ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyRM s t RuntimeErrorc B s e Z d Z i Z x* e g D] Z e j e e d i q Wd Z i Z x* e g D] Z e j e e d i qX Wd Z
d Z e Z
e j Z RS( sK
The base class for exceptions indicating errors only detectable at
runtime.
A subclass of RuntimeError will be thrown if Xapian detects an error
which is exception derived from RuntimeError is thrown when an error
is caused by problems with the data or environment rather than a
programming mistake.
R c C s t | t | | S( N( R' RR ( R R" R# ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s R( c C s t | t | S( N( R) RR ( R R" ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c O s t d d S( Ns No constructor defined( R ( R R9 R: ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; s ( R R- RI R R@ RN RO RP RJ R( RK R; R/ R+ R t delete_RuntimeErrorR? ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyRR s t AssertionErrorc B s e Z d Z i Z x* e g D] Z e j e e d i q Wd Z i Z x* e g D] Z e j e e d i qX Wd Z
e Z d Z
e j Z RS( sL
AssertionError is thrown if a logical assertion inside Xapian fails.
In a debug build of Xapian, a failed assertion in the core library
code will cause AssertionError to be thrown.
This represents a bug in Xapian (either an invariant, precondition,
etc has been violated, or the assertion is incorrect!)
R c C s t | t | | S( N( R' RT ( R R" R# ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s R( c C s t | t | S( N( R) RT ( R R" ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c G s t j | t j | d S( s`
Construct from message and errno value.
Xapian::AssertionError::AssertionError(const std::string &msg_, int
errno_)
Parameters:
-----------
msg_: Message giving details of the error, intended for human
consumption.
errno_: Optional errno value associated with this error.
N( R t AssertionError_swiginitt new_AssertionError( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; s ( R R- RI R RM RN RO RP RJ R( RK R/ R+ R; R t delete_AssertionErrorR? ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyRT s t InvalidArgumentErrorc B s e Z d Z i Z x* e g D] Z e j e e d i q Wd Z i Z x* e g D] Z e j e e d i qX Wd Z
e Z d Z
e j Z RS( s_
InvalidArgumentError indicates an invalid parameter value was passed
to the API.
R c C s t | t | | S( N( R' RX ( R R" R# ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR ! s R( c C s t | t | S( N( R) RX ( R R" ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR $ s c G s t j | t j | d S( sl
Construct from message and errno value.
Xapian::InvalidArgumentError::InvalidArgumentError(const std::string
&msg_, int errno_)
Parameters:
-----------
msg_: Message giving details of the error, intended for human
consumption.
errno_: Optional errno value associated with this error.
N( R t InvalidArgumentError_swiginitt new_InvalidArgumentError( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; & s ( R R- RI R RM RN RO RP RJ R( RK R/ R+ R; R t delete_InvalidArgumentErrorR? ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyRX s t InvalidOperationErrorc B s e Z d Z i Z x* e g D] Z e j e e d i q Wd Z i Z x* e g D] Z e j e e d i qX Wd Z
e Z d Z
e j Z RS( sN
InvalidOperationError indicates the API was used in an invalid way.
R c C s t | t | | S( N( R' R\ ( R R" R# ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR @ s R( c C s t | t | S( N( R) R\ ( R R" ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR C s c G s t j | t j | d S( sn
Construct from message and errno value.
Xapian::InvalidOperationError::InvalidOperationError(const std::string
&msg_, int errno_)
Parameters:
-----------
msg_: Message giving details of the error, intended for human
consumption.
errno_: Optional errno value associated with this error.
N( R t InvalidOperationError_swiginitt new_InvalidOperationError( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; E s ( R R- RI R RM RN RO RP RJ R( RK R/ R+ R; R t delete_InvalidOperationErrorR? ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR\ : s t UnimplementedErrorc B s e Z d Z i Z x* e g D] Z e j e e d i q Wd Z i Z x* e g D] Z e j e e d i qX Wd Z
e Z d Z
e j Z RS( sW
UnimplementedError indicates an attempt to use an unimplemented
feature.
R c C s t | t | | S( N( R' R` ( R R" R# ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR ` s R( c C s t | t | S( N( R) R` ( R R" ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR c s c G s t j | t j | d S( sh
Construct from message and errno value.
Xapian::UnimplementedError::UnimplementedError(const std::string
&msg_, int errno_)
Parameters:
-----------
msg_: Message giving details of the error, intended for human
consumption.
errno_: Optional errno value associated with this error.
N( R t UnimplementedError_swiginitt new_UnimplementedError( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; e s ( R R- RI R RM RN RO RP RJ R( RK R/ R+ R; R t delete_UnimplementedErrorR? ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR` Y s t
DatabaseErrorc B s e Z d Z i Z x* e g D] Z e j e e d i q Wd Z i Z x* e g D] Z e j e e d i qX Wd Z
e Z d Z
e j Z RS( sG
DatabaseError indicates some sort of database related error.
R c C s t | t | | S( N( R' Rd ( R R" R# ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s R( c C s t | t | S( N( R) Rd ( R R" ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c G s t j | t j | d S( s^
Construct from message and errno value.
Xapian::DatabaseError::DatabaseError(const std::string &msg_, int
errno_)
Parameters:
-----------
msg_: Message giving details of the error, intended for human
consumption.
errno_: Optional errno value associated with this error.
N( R t DatabaseError_swiginitt new_DatabaseError( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; s ( R R- RI R RR RN RO RP RJ R( RK R/ R+ R; R t delete_DatabaseErrorR? ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyRd y s t DatabaseCorruptErrorc B s e Z d Z i Z x* e g D] Z e j e e d i q Wd Z i Z x* e g D] Z e j e e d i qX Wd Z
e Z d Z
e j Z RS( sK
DatabaseCorruptError indicates database corruption was detected.
R c C s t | t | | S( N( R' Rh ( R R" R# ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s R( c C s t | t | S( N( R) Rh ( R R" ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c G s t j | t j | d S( sl
Construct from message and errno value.
Xapian::DatabaseCorruptError::DatabaseCorruptError(const std::string
&msg_, int errno_)
Parameters:
-----------
msg_: Message giving details of the error, intended for human
consumption.
errno_: Optional errno value associated with this error.
N( R t DatabaseCorruptError_swiginitt new_DatabaseCorruptError( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; s ( R R- RI R Rd RN RO RP RJ R( RK R/ R+ R; R t delete_DatabaseCorruptErrorR? ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyRh s t DatabaseCreateErrorc B s e Z d Z i Z x* e g D] Z e j e e d i q Wd Z i Z x* e g D] Z e j e e d i qX Wd Z
e Z d Z
e j Z RS( sH
DatabaseCreateError indicates a failure to create a database.
R c C s t | t | | S( N( R' Rl ( R R" R# ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s R( c C s t | t | S( N( R) Rl ( R R" ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c G s t j | t j | d S( sj
Construct from message and errno value.
Xapian::DatabaseCreateError::DatabaseCreateError(const std::string
&msg_, int errno_)
Parameters:
-----------
msg_: Message giving details of the error, intended for human
consumption.
errno_: Optional errno value associated with this error.
N( R t DatabaseCreateError_swiginitt new_DatabaseCreateError( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; s ( R R- RI R Rd RN RO RP RJ R( RK R/ R+ R; R t delete_DatabaseCreateErrorR? ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyRl s t DatabaseLockErrorc B s e Z d Z i Z x* e g D] Z e j e e d i q Wd Z i Z x* e g D] Z e j e e d i qX Wd Z
e Z d Z
e j Z RS( sB
DatabaseLockError indicates failure to lock a database.
R c C s t | t | | S( N( R' Rp ( R R" R# ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s R( c C s t | t | S( N( R) Rp ( R R" ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c G s t j | t j | d S( sf
Construct from message and errno value.
Xapian::DatabaseLockError::DatabaseLockError(const std::string &msg_,
int errno_)
Parameters:
-----------
msg_: Message giving details of the error, intended for human
consumption.
errno_: Optional errno value associated with this error.
N( R t DatabaseLockError_swiginitt new_DatabaseLockError( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; s ( R R- RI R Rd RN RO RP RJ R( RK R/ R+ R; R t delete_DatabaseLockErrorR? ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyRp s t DatabaseModifiedErrorc B s e Z d Z i Z x* e g D] Z e j e e d i q Wd Z i Z x* e g D] Z e j e e d i qX Wd Z
e Z d Z
e j Z RS( s
DatabaseModifiedError indicates a database was modified.
To recover after catching this error, you need to call
Xapian::Database::reopen() on the Database and repeat the operation
which failed.
R c C s t | t | | S( N( R' Rt ( R R" R# ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s R( c C s t | t | S( N( R) Rt ( R R" ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c G s t j | t j | d S( sn
Construct from message and errno value.
Xapian::DatabaseModifiedError::DatabaseModifiedError(const std::string
&msg_, int errno_)
Parameters:
-----------
msg_: Message giving details of the error, intended for human
consumption.
errno_: Optional errno value associated with this error.
N( R t DatabaseModifiedError_swiginitt new_DatabaseModifiedError( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; s ( R R- RI R Rd RN RO RP RJ R( RK R/ R+ R; R t delete_DatabaseModifiedErrorR? ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyRt s t DatabaseOpeningErrorc B s e Z d Z i Z x* e g D] Z e j e e d i q Wd Z i Z x* e g D] Z e j e e d i qX Wd Z
e Z d Z
e j Z RS( sE
DatabaseOpeningError indicates failure to open a database.
R c C s t | t | | S( N( R' Rx ( R R" R# ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s R( c C s t | t | S( N( R) Rx ( R R" ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR ! s c G s t j | t j | d S( sl
Construct from message and errno value.
Xapian::DatabaseOpeningError::DatabaseOpeningError(const std::string
&msg_, int errno_)
Parameters:
-----------
msg_: Message giving details of the error, intended for human
consumption.
errno_: Optional errno value associated with this error.
N( R t DatabaseOpeningError_swiginitt new_DatabaseOpeningError( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; # s ( R R- RI R Rd RN RO RP RJ R( RK R/ R+ R; R t delete_DatabaseOpeningErrorR? ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyRx s t DatabaseVersionErrorc B s e Z d Z i Z x* e g D] Z e j e e d i q Wd Z i Z x* e g D] Z e j e e d i qX Wd Z
e Z d Z
e j Z RS( s
DatabaseVersionError indicates that a database is in an unsupported
format.
From time to time, new versions of Xapian will require the database
format to be changed, to allow new information to be stored or new
optimisations to be performed. Backwards compatibility will sometimes
be maintained, so that new versions of Xapian can open old databases,
but in some cases Xapian will be unable to open a database because it
is in too old (or new) a format. This can be resolved either be
upgrading or downgrading the version of Xapian in use, or by
rebuilding the database from scratch with the current version of
Xapian.
R c C s t | t | | S( N( R' R| ( R R" R# ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR H s R( c C s t | t | S( N( R) R| ( R R" ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR K s c G s t j | t j | d S( sl
Construct from message and errno value.
Xapian::DatabaseVersionError::DatabaseVersionError(const std::string
&msg_, int errno_)
Parameters:
-----------
msg_: Message giving details of the error, intended for human
consumption.
errno_: Optional errno value associated with this error.
N( R t DatabaseVersionError_swiginitt new_DatabaseVersionError( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; M s ( R R- RI R Rx RN RO RP RJ R( RK R/ R+ R; R t delete_DatabaseVersionErrorR? ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR| 7 s t DocNotFoundErrorc B s e Z d Z i Z x* e g D] Z e j e e d i q Wd Z i Z x* e g D] Z e j e e d i qX Wd Z
e Z d Z
e j Z RS( sQ
Indicates an attempt to access a document not present in the database.
R c C s t | t | | S( N( R' R ( R R" R# ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR h s R( c C s t | t | S( N( R) R ( R R" ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR k s c G s t j | t j | d S( sd
Construct from message and errno value.
Xapian::DocNotFoundError::DocNotFoundError(const std::string &msg_,
int errno_)
Parameters:
-----------
msg_: Message giving details of the error, intended for human
consumption.
errno_: Optional errno value associated with this error.
N( R t DocNotFoundError_swiginitt new_DocNotFoundError( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; m s ( R R- RI R RR RN RO RP RJ R( RK R/ R+ R; R t delete_DocNotFoundErrorR? ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR a s t FeatureUnavailableErrorc B s e Z d Z i Z x* e g D] Z e j e e d i q Wd Z i Z x* e g D] Z e j e e d i qX Wd Z
e Z d Z
e j Z RS( s
Indicates an attempt to use a feature which is unavailable.
Typically a feature is unavailable because it wasn't compiled in, or
because it requires other software or facilities which aren't
available.
R c C s t | t | | S( N( R' R ( R R" R# ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s R( c C s t | t | S( N( R) R ( R R" ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c G s t j | t j | d S( sr
Construct from message and errno value.
Xapian::FeatureUnavailableError::FeatureUnavailableError(const
std::string &msg_, int errno_)
Parameters:
-----------
msg_: Message giving details of the error, intended for human
consumption.
errno_: Optional errno value associated with this error.
N( R t FeatureUnavailableError_swiginitt new_FeatureUnavailableError( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; s ( R R- RI R RR RN RO RP RJ R( RK R/ R+ R; R t delete_FeatureUnavailableErrorR? ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s t
InternalErrorc B s e Z d Z i Z x* e g D] Z e j e e d i q Wd Z i Z x* e g D] Z e j e e d i qX Wd Z
e Z d Z
e j Z RS( sB
InternalError indicates a runtime problem of some sort.
R c C s t | t | | S( N( R' R ( R R" R# ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s R( c C s t | t | S( N( R) R ( R R" ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c G s t j | t j | d S( s^
Construct from message and errno value.
Xapian::InternalError::InternalError(const std::string &msg_, int
errno_)
Parameters:
-----------
msg_: Message giving details of the error, intended for human
consumption.
errno_: Optional errno value associated with this error.
N( R t InternalError_swiginitt new_InternalError( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; s ( R R- RI R RR RN RO RP RJ R( RK R/ R+ R; R t delete_InternalErrorR? ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s t NetworkErrorc B s e Z d Z i Z x* e g D] Z e j e e d i q Wd Z i Z x* e g D] Z e j e e d i qX Wd Z
e Z d Z
e j Z RS( sD
Indicates a problem communicating with a remote database.
R c C s t | t | | S( N( R' R ( R R" R# ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s R( c C s t | t | S( N( R) R ( R R" ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c G s t j | t j | d S( s\
Construct from message and errno value.
Xapian::NetworkError::NetworkError(const std::string &msg_, int
errno_)
Parameters:
-----------
msg_: Message giving details of the error, intended for human
consumption.
errno_: Optional errno value associated with this error.
N( R t NetworkError_swiginitt new_NetworkError( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; s ( R R- RI R RR RN RO RP RJ R( RK R/ R+ R; R t delete_NetworkErrorR? ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s t NetworkTimeoutErrorc B s e Z d Z i Z x* e g D] Z e j e e d i q Wd Z i Z x* e g D] Z e j e e d i qX Wd Z
e Z d Z
e j Z RS( sV
Indicates a timeout expired while communicating with a remote
database.
R c C s t | t | | S( N( R' R ( R R" R# ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s R( c C s t | t | S( N( R) R ( R R" ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c G s t j | t j | d S( sj
Construct from message and errno value.
Xapian::NetworkTimeoutError::NetworkTimeoutError(const std::string
&msg_, int errno_)
Parameters:
-----------
msg_: Message giving details of the error, intended for human
consumption.
errno_: Optional errno value associated with this error.
N( R t NetworkTimeoutError_swiginitt new_NetworkTimeoutError( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; s ( R R- RI R R RN RO RP RJ R( RK R/ R+ R; R t delete_NetworkTimeoutErrorR? ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s t QueryParserErrorc B s e Z d Z i Z x* e g D] Z e j e e d i q Wd Z i Z x* e g D] Z e j e e d i qX Wd Z
e Z d Z
e j Z RS( s4
Indicates a query string can't be parsed.
R c C s t | t | | S( N( R' R ( R R" R# ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s R( c C s t | t | S( N( R) R ( R R" ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c G s t j | t j | d S( sd
Construct from message and errno value.
Xapian::QueryParserError::QueryParserError(const std::string &msg_,
int errno_)
Parameters:
-----------
msg_: Message giving details of the error, intended for human
consumption.
errno_: Optional errno value associated with this error.
N( R t QueryParserError_swiginitt new_QueryParserError( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR;
s ( R R- RI R RR RN RO RP RJ R( RK R/ R+ R; R t delete_QueryParserErrorR? ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s t SerialisationErrorc B s e Z d Z i Z x* e g D] Z e j e e d i q Wd Z i Z x* e g D] Z e j e e d i qX Wd Z
e Z d Z
e j Z RS( sL
Indicates an error in the std::string serialisation of an object.
R c C s t | t | | S( N( R' R ( R R" R# ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR ' s R( c C s t | t | S( N( R) R ( R R" ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR * s c G s t j | t j | d S( sh
Construct from message and errno value.
Xapian::SerialisationError::SerialisationError(const std::string
&msg_, int errno_)
Parameters:
-----------
msg_: Message giving details of the error, intended for human
consumption.
errno_: Optional errno value associated with this error.
N( R t SerialisationError_swiginitt new_SerialisationError( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; , s ( R R- RI R RR RN RO RP RJ R( RK R/ R+ R; R t delete_SerialisationErrorR? ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR ! s t
RangeErrorc B s e Z d Z i Z x* e g D] Z e j e e d i q Wd Z i Z x* e g D] Z e j e e d i qX Wd Z
e Z d Z
e j Z RS( s[
RangeError indicates an attempt to access outside the bounds of a
container.
R c C s t | t | | S( N( R' R ( R R" R# ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR G s R( c C s t | t | S( N( R) R ( R R" ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR J s c G s t j | t j | d S( sP
Construct from message and errno value.
Xapian::RangeError::RangeError(const std::string &msg_, int errno_)
Parameters:
-----------
msg_: Message giving details of the error, intended for human
consumption.
errno_: Optional errno value associated with this error.
N( R t RangeError_swiginitt new_RangeError( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; L s ( R R- RI R RR RN RO RP RJ R( RK R/ R+ R; R t delete_RangeErrorR? ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR @ s c C s
t j S( N( R t version_string( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR ` s c C s
t j S( N( R t
major_version( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR d s c C s
t j S( N( R t
minor_version( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR h s c C s
t j S( N( R t revision( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR l s t PositionIteratorc B sS e Z d Z e d d d d Z e Z d Z e j Z
d Z d Z RS( s@
An iterator pointing to items in a list of positions.
c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s s c C s | j j | S( N( R R ( R5 R7 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s s R8 s The membership flagc G s t j | t j | d S( s
Copying is allowed.
Xapian::PositionIterator::PositionIterator(const PositionIterator &o)
The internals are reference counted, so copying is also cheap.
N( R t PositionIterator_swiginitt new_PositionIterator( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; u s c G s t j | | S( s4
Advance the iterator to the specified termpos.
void Xapian::PositionIterator::skip_to(Xapian::termpos pos)
If the specified termpos isn't in the list, position ourselves on the
first termpos after it (or at_end() if no greater term positions are
present).
( R t PositionIterator_skip_to( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt skip_to s
c C s
t j | S( s
Return a string describing this object.
std::string Xapian::PositionIterator::get_description() const
( R t PositionIterator___str__( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt __str__ s (
R R- RI R= R R/ R+ R; R t delete_PositionIteratorR? R R ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR o s t PostingIteratorc B sw e Z d Z e d d d d Z e Z e j Z d Z
d Z d Z d Z
d Z d
Z d Z RS( s?
An iterator pointing to items in a list of postings.
c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c C s | j j | S( N( R R ( R5 R7 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s R8 s The membership flagc G s t j | t j | d S( s
Copying is allowed.
Xapian::PostingIterator::PostingIterator(const PostingIterator &other)
The internals are reference counted, so copying is also cheap.
N( R t PostingIterator_swiginitt new_PostingIterator( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; s c G s t j | | S( s&
Advance the iterator to the specified docid.
void Xapian::PostingIterator::skip_to(Xapian::docid did)
If the specified docid isn't in the list, position ourselves on the
first document after it (or at_end() if no greater docids are
present).
( R t PostingIterator_skip_to( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s
c C s
t j | S( s
Get the length of the document at the current position in the
postlist.
Xapian::termcount Xapian::PostingIterator::get_doclength() const
This information may be stored in the postlist, in which case this
lookup should be extremely fast (indeed, not require further disk
access). If the information is not present in the postlist, it will be
retrieved from the database, at a greater performance cost.
( R t PostingIterator_get_doclength( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt
get_doclength s c C s
t j | S( s
Get the within document frequency of the document at the current
position in the postlist.
Xapian::termcount Xapian::PostingIterator::get_wdf() const
( R t PostingIterator_get_wdf( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_wdf s c C s
t j | S( s
Return PositionIterator pointing to start of positionlist for current
document.
PositionIterator Xapian::PostingIterator::positionlist_begin() const
( R t" PostingIterator_positionlist_begin( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt positionlist_begin s c C s
t j | S( s
Return PositionIterator pointing to end of positionlist for current
document.
PositionIterator Xapian::PostingIterator::positionlist_end() const
( R t PostingIterator_positionlist_end( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt positionlist_end s c C s
t j | S( s
Return a string describing this object.
std::string Xapian::PostingIterator::get_description() const
( R t PostingIterator___str__( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s ( R R- RI R= R R/ R+ R t delete_PostingIteratorR? R; R R R R R R ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s
c G s
t j | S( N( R t __eq__( R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c G s
t j | S( N( R t __ne__( R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s t TermIteratorc B s e Z d Z e d d d d Z e Z d Z e j Z
d Z d Z d Z
d Z d
Z d Z d Z RS(
s<
An iterator pointing to items in a list of terms.
c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c C s | j j | S( N( R R ( R5 R7 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s R8 s The membership flagc G s t j | t j | d S( s
Copying is allowed.
Xapian::TermIterator::TermIterator(const TermIterator &other)
The internals are reference counted, so copying is also cheap.
N( R t TermIterator_swiginitt new_TermIterator( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; s c G s t j | | S( s
Advance the iterator to the specified term.
void Xapian::TermIterator::skip_to(const std::string &tname)
If the specified term isn't in the list, position ourselves on the
first term after it (or at_end() if no greater terms are present).
( R t TermIterator_skip_to( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c C s
t j | S( s
Return the wdf of the current term (if meaningful).
Xapian::termcount Xapian::TermIterator::get_wdf() const
The wdf (within document frequency) is the number of occurrences of a
term in a particular document.
( R t TermIterator_get_wdf( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c C s
t j | S( s
Return the term frequency of the current term (if meaningful).
Xapian::doccount Xapian::TermIterator::get_termfreq() const
The term frequency is the number of documents which a term indexes.
( R t TermIterator_get_termfreq( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_termfreq' s c C s
t j | S( s
Return length of positionlist for current term.
Xapian::termcount Xapian::TermIterator::positionlist_count() const
( R t TermIterator_positionlist_count( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt positionlist_count1 s c C s
t j | S( s
Return PositionIterator pointing to start of positionlist for current
term.
PositionIterator Xapian::TermIterator::positionlist_begin() const
( R t TermIterator_positionlist_begin( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR 9 s c C s
t j | S( s
Return PositionIterator pointing to end of positionlist for current
term.
PositionIterator Xapian::TermIterator::positionlist_end() const
( R t TermIterator_positionlist_end( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR B s c C s
t j | S( s}
Return a string describing this object.
std::string Xapian::TermIterator::get_description() const
( R t TermIterator___str__( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR K s ( R R- RI R= R R/ R+ R; R t delete_TermIteratorR? R R R R R R R ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s
t
ValueIteratorc B sn e Z d Z e d d d d Z e Z d Z e j Z
d Z d Z d Z
d Z d
Z RS( s4
Class for iterating over document values.
c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR f s c C s | j j | S( N( R R ( R5 R7 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR f s R8 s The membership flagc G s t j | t j | d S( s
Default constructor.
Xapian::ValueIterator::ValueIterator()
Creates an uninitialised iterator, which can't be used before being
assigned to, but is sometimes syntactically convenient.
N( R t ValueIterator_swiginitt new_ValueIterator( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; h s c C s
t j | S( s
Return the docid at the current position.
Xapian::docid Xapian::ValueIterator::get_docid() const
If we're iterating over values of a document, this method will throw
Xapian::InvalidOperationError.
( R t ValueIterator_get_docid( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_docids s c C s
t j | S( s^
Return the value slot number for the current position.
Xapian::valueno Xapian::ValueIterator::get_valueno() const
If the iterator is over all values in a slot, this returns that slot's
number. If the iterator is over the values in a particular document,
it returns the number of each slot in turn.
( R t ValueIterator_get_valueno( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_valueno~ s
c G s t j | | S( s
Advance the iterator to document id or value slot docid_or_slot.
void Xapian::ValueIterator::skip_to(Xapian::docid docid_or_slot)
If this iterator is over values in a document, then this method
advances the iterator to value slot docid_or_slot, or the first slot
after it if there is no value in slot slot.
If this iterator is over values in a particular slot, then this method
advances the iterator to document id docid_or_slot, or the first
document id after it if there is no value in the slot we're iterating
over for document docid_or_slot.
Note: The "two-faced" nature of this method is due to how C++
overloading works. Xapian::docid and Xapian::valueno are both typedefs
for the same unsigned integer type, so overloading can't distinguish
them.
Parameters:
-----------
docid_or_slot: The docid/slot to advance to.
( R t ValueIterator_skip_to( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c G s t j | | S( sP
Check if the specified docid occurs.
bool Xapian::ValueIterator::check(Xapian::docid docid)
The caller is required to ensure that the specified document id did
actually exists in the database.
This method acts like skip_to() if that can be done at little extra
cost, in which case it then returns true. This is how brass and chert
databases behave because they store values in streams which allow for
an efficient implementation of skip_to().
Otherwise it simply checks if a particular docid is present. If it is,
it returns true. If it isn't, it returns false, and leaves the
position unspecified (and hence the result of calling methods which
depends on the current position, such as get_docid(), are also
unspecified). In this state, next() will advance to the first matching
position after document did, and skip_to() will act as it would if the
position was the first matching position after document did.
Currently the inmemory, flint, and remote backends behave in the
latter way because they don't support streamed values and so skip_to()
must check each document it skips over which is significantly slower.
Parameters:
-----------
docid: The document id to check.
( R t ValueIterator_check( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt check s c C s
t j | S( s~
Return a string describing this object.
std::string Xapian::ValueIterator::get_description() const
( R t ValueIterator___str__( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s ( R R- RI R= R R/ R+ R; R t delete_ValueIteratorR? R R R R R ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR b s
!t Documentc B s
e Z d Z e d d d d Z e Z d Z e j Z
d Z d Z d Z
d Z d
Z d Z d Z d
Z d Z d Z d Z d Z d Z d Z d Z d Z d Z d Z d Z d Z e e j Z! d Z" RS( s_
A handle representing a document in a Xapian database.
The Document class fetches information from the database lazily.
Usually this behaviour isn't visible to users (except for the speed
benefits), but if the document in the database is modified or deleted,
then preexisting Document objects may return the old or new versions
of data (or throw Xapian::DocNotFoundError in the case of deletion).
Since Database objects work on a snapshot of the database's state, the
situation above can only happen with a WritableDatabase object, or if
you call Database::reopen() on a Database object.
We recommend you avoid designs where this behaviour is an issue, but
if you need a way to make a non-lazy version of a Document object, you
can do this like so:doc =
Xapian::Document::unserialise(doc.serialise());
c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c C s | j j | S( N( R R ( R5 R7 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s R8 s The membership flagc G s t j | t j | d S( sS
Make a new empty Document.
Xapian::Document::Document()
N( R t Document_swiginitt new_Document( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; s c G s t j | | S( s-
Get value by number.
std::string Xapian::Document::get_value(Xapian::valueno slot) const
Returns an empty string if no value with the given number is present
in the document.
Parameters:
-----------
slot: The number of the value.
( R t Document_get_value( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_value s c G s t j | | S( s
Add a new value.
void Xapian::Document::add_value(Xapian::valueno slot, const
std::string &value)
The new value will replace any existing value with the same number (or
if the new value is empty, it will remove any existing value with the
same number).
Parameters:
-----------
slot: The value slot to add the value in.
value: The value to set.
( R t Document_add_value( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt add_value s c G s t j | | S( s}
Remove any value with the given number.
void Xapian::Document::remove_value(Xapian::valueno slot)
( R t Document_remove_value( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt remove_value s c C s
t j | S( sq
Remove all values associated with the document.
void Xapian::Document::clear_values()
( R t Document_clear_values( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt clear_values$ s c C s
t j | S( s\
Get data stored in the document.
std::string Xapian::Document::get_data() const
This is potentially a relatively expensive operation, and shouldn't
normally be used during the match (e.g. in a PostingSource or match
decider functor. Put data for use by match deciders in a value
instead.
( R t Document_get_data( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_data, s c G s t j | | S( sg
Set data stored in the document.
void Xapian::Document::set_data(const std::string &data)
Xapian treats the data as an opaque blob. It may try to compress it,
but other than that it will just store it and return it when
requested.
Parameters:
-----------
data: The data to store.
( R t Document_set_data( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt set_data9 s c G s t j | | S( sw
Add an occurrence of a term at a particular position.
void Xapian::Document::add_posting(const std::string &tname,
Xapian::termpos tpos, Xapian::termcount wdfinc=1)
Multiple occurrences of the term at the same position are represented
only once in the positional information, but do increase the wdf.
If the term is not already in the document, it will be added to it.
Parameters:
-----------
tname: The name of the term.
tpos: The position of the term.
wdfinc: The increment that will be applied to the wdf for this term.
( R t Document_add_posting( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt add_postingJ s c G s t j | | S( s
Add a term to the document, without positional information.
void Xapian::Document::add_term(const std::string &tname,
Xapian::termcount wdfinc=1)
Any existing positional information for the term will be left
unmodified.
Parameters:
-----------
tname: The name of the term.
wdfinc: The increment that will be applied to the wdf for this term
(default: 1).
( R t Document_add_term( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt add_termb s c G s t j | | S( s
Add a boolean filter term to the document.
void Xapian::Document::add_boolean_term(const std::string &term)
This method adds term to the document with wdf of 0 - this is
generally what you want for a term used for boolean filtering as the
wdf of such terms is ignored, and it doesn't make sense for them to
contribute to the document's length.
If the specified term already indexes this document, this method has
no effect.
It is exactly the same as add_term(term, 0).
This method was added in Xapian 1.0.18.
Parameters:
-----------
term: The term to add.
( R t Document_add_boolean_term( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt add_boolean_termv s c G s t j | | S( s
Remove a posting of a term from the document.
void Xapian::Document::remove_posting(const std::string &tname,
Xapian::termpos tpos, Xapian::termcount wdfdec=1)
Note that the term will still index the document even if all
occurrences are removed. To remove a term from a document completely,
use remove_term().
Parameters:
-----------
tname: The name of the term.
tpos: The position of the term.
wdfdec: The decrement that will be applied to the wdf when removing
this posting. The wdf will not go below the value of 0.
Parameters:
-----------
Xapian::InvalidArgumentError: will be thrown if the term is not at
the position specified in the position list for this term in this
document.
Xapian::InvalidArgumentError: will be thrown if the term is not in
the document
( R t Document_remove_posting( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt remove_posting s c G s t j | | S( sf
Remove a term and all postings associated with it.
void Xapian::Document::remove_term(const std::string &tname)
Parameters:
-----------
tname: The name of the term.
Parameters:
-----------
Xapian::InvalidArgumentError: will be thrown if the term is not in
the document
( R t Document_remove_term( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt remove_term s c C s
t j | S( ss
Remove all terms (and postings) from the document.
void Xapian::Document::clear_terms()
( R t Document_clear_terms( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt clear_terms s c C s
t j | S( s
The length of the termlist - i.e.
Xapian::termcount Xapian::Document::termlist_count() const
the number of different terms which index this document.
( R t Document_termlist_count( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt termlist_count s c C s
t j | S( sz
Iterator for the terms in this document.
TermIterator Xapian::Document::termlist_begin() const
( R t Document_termlist_begin( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt termlist_begin s c C s
t j | S( s}
Equivalent end iterator for termlist_begin().
TermIterator Xapian::Document::termlist_end() const
( R t Document_termlist_end( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt termlist_end s c C s
t j | S( sw
Count the values in this document.
Xapian::termcount Xapian::Document::values_count() const
( R t Document_values_count( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt values_count s c C s
t j | S( sz
Iterator for the values in this document.
ValueIterator Xapian::Document::values_begin() const
( R t Document_values_begin( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt values_begin s c C s
t j | S( s~
Equivalent end iterator for values_begin().
ValueIteratorEnd_ Xapian::Document::values_end() const
( R t Document_values_end( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt
values_end s c C s
t j | S( s
Get the document id which is associated with this document (if any).
docid Xapian::Document::get_docid() const
NB If multiple databases are being searched together, then this will
be the document id in the individual database, not the merged
database!
If this document came from a database, return the document id in that
database. Otherwise, return 0 (in Xapian 1.0.22/1.2.4 or later; prior
to this the returned value was uninitialised).
( R t Document_get_docid( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c C s
t j | S( sM
Serialise document into a string.
std::string Xapian::Document::serialise() const
The document representation may change between Xapian releases: even
between minor versions. However, it is guaranteed not to change if the
remote database protocol has not changed between releases.
( R t Document_serialise( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt serialise
s
c C s
t j | S( sy
Return a string describing this object.
std::string Xapian::Document::get_description() const
( R t Document___str__( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s (# R R- RI R= R R/ R+ R; R t delete_DocumentR? R R R R R R R R R R R R R R R R R R R R t staticmethodt Document_unserialiset unserialiseR ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s6
!
c G s
t j | S( N( R R ( R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR : s t
PostingSourcec B s e Z d Z e d d d d Z e Z d Z e j Z
d Z d Z d Z
d Z d
Z d Z d Z d
Z d Z d Z d Z d Z d Z d Z RS( sF
Base class which provides an "external" source of postings.
c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR B s c C s | j j | S( N( R R ( R5 R7 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR B s R8 s The membership flagc C s; | j t k r d } n | } t j | t j | d S( N( R, R R R t PostingSource_swiginitt new_PostingSource( R t _self( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; D s c C s
t j | S( s
A lower bound on the number of documents this object can return.
virtual Xapian::doccount Xapian::PostingSource::get_termfreq_min()
const =0
Xapian will always call init() on a PostingSource before calling this
for the first time.
( R t PostingSource_get_termfreq_min( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_termfreq_minK s
c C s
t j | S( s
An estimate of the number of documents this object can return.
virtual Xapian::doccount Xapian::PostingSource::get_termfreq_est()
const =0
It must always be true that:
get_termfreq_min() <= get_termfreq_est() <= get_termfreq_max()
Xapian will always call init() on a PostingSource before calling this
for the first time.
( R t PostingSource_get_termfreq_est( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_termfreq_estW s c C s
t j | S( s
An upper bound on the number of documents this object can return.
virtual Xapian::doccount Xapian::PostingSource::get_termfreq_max()
const =0
Xapian will always call init() on a PostingSource before calling this
for the first time.
( R t PostingSource_get_termfreq_max( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_termfreq_maxg s
c C s
t j | S( s
Return the currently set upper bound on what get_weight() can return.
Xapian::weight Xapian::PostingSource::get_maxweight() const
( R t PostingSource_get_maxweight( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt
get_maxweights s c C s
t j | S( s
Return the weight contribution for the current document.
virtual Xapian::weight Xapian::PostingSource::get_weight() const
This default implementation always returns 0, for convenience when
implementing "weight-less" PostingSource subclasses.
This method may assume that it will only be called when there is a
"current document". In detail: Xapian will always call init() on a
PostingSource before calling this for the first time. It will also
only call this if the PostingSource reports that it is pointing to a
valid document (ie, it will not call it before calling at least one of
next(), skip_to() or check(), and will ensure that the PostingSource
is not at the end by calling at_end()).
( R t PostingSource_get_weight( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt
get_weight{ s c C s
t j | S( s
Return the current docid.
virtual Xapian::docid Xapian::PostingSource::get_docid() const =0
This method may assume that it will only be called when there is a
"current document". See get_weight() for details.
Note: in the case of a multi-database search, the returned docid
should be in the single subdatabase relevant to this posting source.
See the init() method for details.
( R t PostingSource_get_docid( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s
c G s t j | | S( s[
Advance the current position to the next matching document.
virtual void Xapian::PostingSource::next(Xapian::weight min_wt)=0
The PostingSource starts before the first entry in the list, so next()
must be called before any methods which need the context of the
current position.
Xapian will always call init() on a PostingSource before calling this
for the first time.
Parameters:
-----------
min_wt: The minimum weight contribution that is needed (this is just
a hint which subclasses may ignore).
( R t PostingSource_next( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt next s c G s t j | | S( sI
Advance to the specified docid.
virtual void Xapian::PostingSource::skip_to(Xapian::docid did,
Xapian::weight min_wt)
If the specified docid isn't in the list, position ourselves on the
first document after it (or at_end() if no greater docids are
present).
If the current position is already the specified docid, this method
will leave the position unmodified.
If the specified docid is earlier than the current position, the
behaviour is unspecified. A sensible behaviour would be to leave the
current position unmodified, but it is also reasonable to move to the
specified docid.
The default implementation calls next() repeatedly, which works but
skip_to() can often be implemented much more efficiently.
Xapian will always call init() on a PostingSource before calling this
for the first time.
Note: in the case of a multi-database search, the docid specified is
the docid in the single subdatabase relevant to this posting source.
See the init() method for details.
Parameters:
-----------
did: The document id to advance to.
min_wt: The minimum weight contribution that is needed (this is just
a hint which subclasses may ignore).
( R t PostingSource_skip_to( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s %c G s t j | | S( s-
Check if the specified docid occurs.
virtual bool Xapian::PostingSource::check(Xapian::docid did,
Xapian::weight min_wt)
The caller is required to ensure that the specified document id did
actually exists in the database. If it does, it must move to that
document id, and return true. If it does not, it may either:
return true, having moved to a definite position (including
"at_end"), which must be the same position as skip_to() would have
moved to.
or
return false, having moved to an "indeterminate" position, such that
a subsequent call to next() or skip_to() will move to the next
matching position after did.
Generally, this method should act like skip_to() and return true if
that can be done at little extra cost.
Otherwise it should simply check if a particular docid is present,
returning true if it is, and false if it isn't.
The default implementation calls skip_to() and always returns true.
Xapian will always call init() on a PostingSource before calling this
for the first time.
Note: in the case of a multi-database search, the docid specified is
the docid in the single subdatabase relevant to this posting source.
See the init() method for details.
Parameters:
-----------
did: The document id to check.
min_wt: The minimum weight contribution that is needed (this is just
a hint which subclasses may ignore).
( R t PostingSource_check( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s ,c C s
t j | S( s
Return true if the current position is past the last entry in this
list.
virtual bool Xapian::PostingSource::at_end() const =0
At least one of next(), skip_to() or check() will be called before
this method is first called.
( R t PostingSource_at_end( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt at_end s
c C s
t j | S( sB
Name of the posting source class.
virtual std::string Xapian::PostingSource::name() const
This is used when serialising and unserialising posting sources; for
example, for performing remote searches.
If the subclass is in a C++ namespace, the namespace should be
included in the name, using "::" as a separator. For example, for a
PostingSource subclass called "FooPostingSource" in the "Xapian"
namespace the result of this call should be
"Xapian::FooPostingSource".
This should only be implemented if serialise() and unserialise() are
also implemented. The default implementation returns an empty string.
If this returns an empty string, Xapian will assume that serialise()
and unserialise() are not implemented.
( R t PostingSource_name( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR" s c G s t j | | S( s
Set this PostingSource to the start of the list of postings.
virtual void Xapian::PostingSource::init(const Database &db)=0
This is called automatically by the matcher prior to each query being
processed.
If a PostingSource is used for multiple searches, init() will
therefore be called multiple times, and must handle this by using the
database passed in the most recent call.
Parameters:
-----------
db: The database which the PostingSource should iterate through.
Note: the database supplied to this method must not be modified: in
particular, the reopen() method should not be called on it.
Note: in the case of a multi-database search, a separate PostingSource
will be used for each database (the separate PostingSources will be
obtained using clone()), and each PostingSource will be passed one of
the sub-databases as the db parameter here. The db parameter will
therefore always refer to a single database. All docids passed to, or
returned from, the PostingSource refer to docids in that single
database, rather than in the multi- database.
( R t PostingSource_init( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt init* s c C s
t j | S( s
Return a string describing this object.
virtual std::string Xapian::PostingSource::get_description() const
This default implementation returns a generic answer. This default it
provided to avoid forcing those deriving their own PostingSource
subclass from having to implement this (they may not care what
get_description() gives for their subclass).
( R t PostingSource___str__( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR I s c C s$ | j j t j | t | S( N( R t disownR t disown_PostingSourcet
weakref_proxy( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt
__disown__V s
( R R- RI R= R R/ R+ R; R t delete_PostingSourceR? R R R
R R R R R R R R" R R R ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR > s& ' .
t ValuePostingSourcec B sA e Z d Z e d d d d Z e Z d Z e j Z
RS( s
A posting source which generates weights from a value slot.
This is a base class for classes which generate weights using values
stored in the specified slot. For example, ValueWeightPostingSource
uses sortable_unserialise to convert values directly to weights.
The upper bound on the weight returned is set to DBL_MAX. Subclasses
should call set_maxweight() in their init() methods after calling
ValuePostingSource::init() if they know a tighter bound on the weight.
c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR w s c C s | j j | S( N( R R ( R5 R7 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR w s R8 s The membership flagc G s t j | t j | d S( s
Construct a ValuePostingSource.
Xapian::ValuePostingSource::ValuePostingSource(Xapian::valueno slot_)
Parameters:
-----------
slot_: The value slot to read values from.
N( R t ValuePostingSource_swiginitt new_ValuePostingSource( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; y s ( R R- RI R= R R/ R+ R; R t delete_ValuePostingSourceR? ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR" j s
t ValueWeightPostingSourcec B sA e Z d Z e d d d d Z e Z d Z e j Z
RS( s
A posting source which reads weights from a value slot.
This returns entries for all documents in the given database which
have a non empty values in the specified slot. It returns a weight
calculated by applying sortable_unserialise to the value stored in the
slot (so the values stored should probably have been calculated by
applying sortable_serialise to a floating point number at index time).
The upper bound on the weight returned is set using the upper bound on
the values in the specified slot, or DBL_MAX if value bounds aren't
supported by the current backend.
For efficiency, this posting source doesn't check that the stored
values are valid in any way, so it will never raise an exception due
to invalid stored values. In particular, it doesn't ensure that the
unserialised values are positive, which is a requirement for weights.
The behaviour if the slot contains values which unserialise to
negative values is undefined.
c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c C s | j j | S( N( R R ( R5 R7 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s R8 s The membership flagc G s t j | t j | d S( s
Construct a ValueWeightPostingSource.
Xapian::ValueWeightPostingSource::ValueWeightPostingSource(Xapian::valueno
slot_)
Parameters:
-----------
slot_: The value slot to read values from.
N( R t! ValueWeightPostingSource_swiginitt new_ValueWeightPostingSource( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; s ( R R- RI R= R R/ R+ R; R t delete_ValueWeightPostingSourceR? ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR& s
t" DecreasingValueWeightPostingSourcec B sA e Z d Z e d d d d Z e Z d Z e j Z
RS( s
Read weights from a value which is known to decrease as docid
increases.
This posting source can be used, like ValueWeightPostingSource, to add
a weight contribution to a query based on the values stored in a slot.
The values in the slot must be serialised as by sortable_serialise().
However, this posting source is additionally given a range of document
IDs, within which the weight is known to be decreasing. ie, for all
documents with ids A and B within this range (including the
endpoints), where A is less than B, the weight of A is less than or
equal to the weight of B. This can allow the posting source to skip to
the end of the range quickly if insufficient weight is left in the
posting source for a particular source.
By default, the range is assumed to cover all document IDs.
The ordering property can be arranged at index time, or by sorting an
indexed database to produce a new, sorted, database.
c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c C s | j j | S( N( R R ( R5 R7 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s R8 s The membership flagc G s t j | t j | d S( s
Xapian::DecreasingValueWeightPostingSource::DecreasingValueWeightPostingSource(Xapian::valueno
slot_, Xapian::docid range_start_=0, Xapian::docid range_end_=0)
N( R t+ DecreasingValueWeightPostingSource_swiginitt& new_DecreasingValueWeightPostingSource( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; s ( R R- RI R= R R/ R+ R; R t) delete_DecreasingValueWeightPostingSourceR? ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR* s
t ValueMapPostingSourcec B s\ e Z d Z e d d d d Z e Z d Z d Z d Z d Z
e j Z
RS( s
A posting source which looks up weights in a map using values as the
key.
This allows will return entries for all documents in the given
database which have a value in the slot specified. The values will be
mapped to the corresponding weight in the weight map. If there is no
mapping for a particular value, the default weight will be returned
(which itself defaults to 0.0).
c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c C s | j j | S( N( R R ( R5 R7 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s R8 s The membership flagc G s t j | t j | d S( s
Construct a ValueWeightPostingSource.
Xapian::ValueMapPostingSource::ValueMapPostingSource(Xapian::valueno
slot_)
Parameters:
-----------
slot_: The value slot to read values from.
N( R t ValueMapPostingSource_swiginitt new_ValueMapPostingSource( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; s c G s t j | | S( s
Add a mapping.
void Xapian::ValueMapPostingSource::add_mapping(const std::string
&key, double wt)
Parameters:
-----------
key: The key looked up from the value slot.
wt: The weight to give this key.
( R t! ValueMapPostingSource_add_mapping( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt add_mapping s c C s
t j | S( sd
Clear all mappings.
void Xapian::ValueMapPostingSource::clear_mappings()
( R t$ ValueMapPostingSource_clear_mappings( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt clear_mappings s c G s t j | | S( s
Set a default weight for document values not in the map.
void Xapian::ValueMapPostingSource::set_default_weight(double wt)
Parameters:
-----------
wt: The weight to set as the default.
( R t( ValueMapPostingSource_set_default_weight( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt set_default_weight s ( R R- RI R= R R/ R+ R; R2 R4 R6 R t delete_ValueMapPostingSourceR? ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR. s
t FixedWeightPostingSourcec B sA e Z d Z e d d d d Z e Z d Z e j Z
RS( s
A posting source which returns a fixed weight for all documents.
This returns entries for all documents in the given database, with a
fixed weight (specified by a parameter to the constructor).
c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c C s | j j | S( N( R R ( R5 R7 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s R8 s The membership flagc G s t j | t j | d S( s
Construct a FixedWeightPostingSource.
Xapian::FixedWeightPostingSource::FixedWeightPostingSource(Xapian::weight
wt)
Parameters:
-----------
wt: The fixed weight to return.
N( R t! FixedWeightPostingSource_swiginitt new_FixedWeightPostingSource( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; " s ( R R- RI R= R R/ R+ R; R t delete_FixedWeightPostingSourceR? ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR8 s
t MSetc B s e Z d Z e d d d d Z e Z d Z e j Z
d Z d Z d Z
d Z d
Z d Z d Z d
Z d Z d Z d Z d Z d Z d Z d Z d Z d Z d Z d Z d Z e e j Z RS( sa
A match set ( MSet).
This class represents (a portion of) the results of a query.
c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR 9 s c C s | j j | S( N( R R ( R5 R7 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR 9 s R8 s The membership flagc G s t j | t j | d S( sd
Copying is allowed (and is cheap).
Xapian::MSet::MSet(const MSet &other)
N( R t
MSet_swiginitt new_MSet( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; ; s c G s t j | | S( s]
Fetch all the items in the MSet.
void Xapian::MSet::fetch() const
( R t
MSet_fetch( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt fetchC s c G s t j | | S( s
Return the percentage score for a particular item.
Xapian::percent Xapian::MSet::convert_to_percent(const MSetIterator
&it) const
( R t MSet_convert_to_percent( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt convert_to_percentK s c G s t j | | S( s
Return the term frequency of the given query term.
Xapian::doccount Xapian::MSet::get_termfreq(const std::string &tname)
const
Parameters:
-----------
tname: The term to look for.
This is sometimes more efficient than asking the database directly for
the term frequency - in particular, if the term was in the query, its
frequency will usually be cached in the MSet.
( R t MSet_get_termfreq( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR T s c G s t j | | S( st
Return the term weight of the given query term.
Xapian::weight Xapian::MSet::get_termweight(const std::string &tname)
const
Parameters:
-----------
tname: The term to look for.
Parameters:
-----------
Xapian::InvalidArgumentError: is thrown if the term was not in the
query.
( R t MSet_get_termweight( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_termweightf s c C s
t j | S( sU
The index of the first item in the result which was put into the MSet.
Xapian::doccount Xapian::MSet::get_firstitem() const
This corresponds to the parameter "first" specified in
Xapian::Enquire::get_mset(). A value of 0 corresponds to the highest
result being the first item in the MSet.
( R t MSet_get_firstitem( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt
get_firstitemz s
c C s
t j | S( s
A lower bound on the number of documents in the database which match
the query.
Xapian::doccount Xapian::MSet::get_matches_lower_bound() const
This figure takes into account collapsing of duplicates, and weighting
cutoff values.
This number is usually considerably less than the actual number of
documents which match the query.
( R t MSet_get_matches_lower_bound( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_matches_lower_bound s
c C s
t j | S( sg
An estimate for the number of documents in the database which match
the query.
Xapian::doccount Xapian::MSet::get_matches_estimated() const
This figure takes into account collapsing of duplicates, and weighting
cutoff values.
This value is returned because there is sometimes a request to display
such information. However, our experience is that presenting this
value to users causes them to worry about the large number of results,
rather than how useful those at the top of the result set are, and is
thus undesirable.
( R t MSet_get_matches_estimated( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_matches_estimated s c C s
t j | S( s
An upper bound on the number of documents in the database which match
the query.
Xapian::doccount Xapian::MSet::get_matches_upper_bound() const
This figure takes into account collapsing of duplicates, and weighting
cutoff values.
This number is usually considerably greater than the actual number of
documents which match the query.
( R t MSet_get_matches_upper_bound( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_matches_upper_bound s
c C s
t j | S( s
A lower bound on the number of documents in the database which would
match the query if collapsing wasn't used.
Xapian::doccount Xapian::MSet::get_uncollapsed_matches_lower_bound()
const
( R t( MSet_get_uncollapsed_matches_lower_bound( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt# get_uncollapsed_matches_lower_bound s c C s
t j | S( s
A estimate of the number of documents in the database which would
match the query if collapsing wasn't used.
Xapian::doccount Xapian::MSet::get_uncollapsed_matches_estimated()
const
( R t& MSet_get_uncollapsed_matches_estimated( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt! get_uncollapsed_matches_estimated s c C s
t j | S( s
A upper bound on the number of documents in the database which would
match the query if collapsing wasn't used.
Xapian::doccount Xapian::MSet::get_uncollapsed_matches_upper_bound()
const
( R t( MSet_get_uncollapsed_matches_upper_bound( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt# get_uncollapsed_matches_upper_bound s c C s
t j | S( s2
The maximum possible weight in the MSet.
Xapian::weight Xapian::MSet::get_max_possible() const
This weight is likely not to be attained in the set of results, but
represents an upper bound on the weight which a document could attain
for the given query.
( R t MSet_get_max_possible( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_max_possible s
c C s
t j | S( si
The greatest weight which is attained by any document in the database.
Xapian::weight Xapian::MSet::get_max_attained() const
If firstitem == 0 and the primary ordering is by relevance, this is
the weight of the first entry in the MSet.
If no documents are found by the query, this will be 0.
Note that calculation of max_attained requires calculation of at least
one result item - therefore, if no items were requested when the query
was performed (by specifying maxitems = 0 in
Xapian::Enquire::get_mset()), this value will be 0.
( R t MSet_get_max_attained( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_max_attained s c C s
t j | S( si
The number of items in this MSet.
Xapian::doccount Xapian::MSet::size() const
( R t MSet_size( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt size s c C s
t j | S( sX
Test if this MSet is empty.
bool Xapian::MSet::empty() const
( R t
MSet_empty( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt empty s c C s
t j | S( si
Iterator for the items in this MSet.
MSetIterator Xapian::MSet::begin() const
( R t
MSet_begin( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt begin s c C s
t j | S( sh
End iterator corresponding to begin()
MSetIterator Xapian::MSet::end() const
( R t MSet_end( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt end
s c C s
t j | S( sw
Iterator pointing to the last element of this MSet.
MSetIterator Xapian::MSet::back() const
( R t MSet_back( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt back s c G s t j | | S( s
Get an item from the MSet.
The supplied index is relative to the start of the MSet, not the absolute rank
of the item.
( R t MSet__get_hit_internal( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt _get_hit_internal s c C s
t j | S( su
Return a string describing this object.
std::string Xapian::MSet::get_description() const
( R t MSet___str__( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR # s (! R R- RI R= R R/ R+ R; R t delete_MSetR? R@ RB R RE RG RI RK RM RO RQ RS RU RW RY R[ R] R_ Ra Rc R t MSet_items_gett items( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR< 3 s4
t MSetIteratorc B s e Z d Z e d d d d Z e Z d Z e j Z
d Z d Z d Z
d Z d
Z d Z d Z RS(
ss
An iterator pointing to items in an MSet.
This is used for access to individual results of a match.
c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR M s c C s | j j | S( N( R R ( R5 R7 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR M s R8 s The membership flagc G s t j | t j | d S( s|
Copying is allowed (and is cheap).
Xapian::MSetIterator::MSetIterator(const MSetIterator &other)
N( R t MSetIterator_swiginitt new_MSetIterator( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; O s c C s
t j | S( s>
Get a Xapian::Document object for the current position.
Xapian::Document Xapian::MSetIterator::get_document() const
This method returns a Xapian::Document object which provides the
information about the document pointed to by the MSetIterator.
If the underlying database has suitable support, using this call
(rather than asking the database for a document based on its document
ID) will enable the system to ensure that the correct data is
returned, and that the document has not been deleted or changed since
the query was performed.
A Xapian::Document object containing the document data.
Parameters:
-----------
Xapian::DocNotFoundError: The document specified could not be found
in the database.
( R t MSetIterator_get_document( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_documentW s c C s
t j | S( sG
Get the rank of the document at the current position.
Xapian::doccount Xapian::MSetIterator::get_rank() const
The rank is the position that this document is at in the ordered list
of results of the query. The result is 0-based - i.e. the top-ranked
document has a rank of 0.
( R t MSetIterator_get_rank( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_rankp s
c C s
t j | S( s
Get the weight of the document at the current position.
Xapian::weight Xapian::MSetIterator::get_weight() const
( R t MSetIterator_get_weight( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR | s c C s
t j | S( s~
Get the collapse key for this document.
std::string Xapian::MSetIterator::get_collapse_key() const
( R t MSetIterator_get_collapse_key( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_collapse_key s c C s
t j | S( s
Get an estimate of the number of documents that have been collapsed
into this one.
Xapian::doccount Xapian::MSetIterator::get_collapse_count() const
The estimate will always be less than or equal to the actual number of
other documents satisfying the match criteria with the same collapse
key as this document.
This method may return 0 even though there are other documents with
the same collapse key which satisfying the match criteria. However if
this method returns non-zero, there definitely are other such
documents. So this method may be used to inform the user that there
are "at least N other matches in this group", or to control whether
to offer a "show other documents in this group" feature (but note
that it may not offer it in every case where it would show other
documents).
( R t MSetIterator_get_collapse_count( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_collapse_count s c C s
t j | S( sp
This returns the weight of the document as a percentage score.
Xapian::percent Xapian::MSetIterator::get_percent() const
The return value will be an integer in the range 0 to 100: 0 meaning
that the item did not match the query at all.
The intention is that the highest weighted document will get 100 if it
matches all the weight-contributing terms in the query. However,
currently it may get a lower percentage score if you use a
MatchDecider and the sorting is primarily by value. In this case, the
percentage for a particular document may vary depending on the first,
max_size, and checkatleast parameters passed to Enquire::get_mset()
(this bug is hard to fix without having to apply the MatchDecider to
potentially many more documents, which is potentially costly).
( R t MSetIterator_get_percent( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_percent s c C s
t j | S( s}
Return a string describing this object.
std::string Xapian::MSetIterator::get_description() const
( R t MSetIterator___str__( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s ( R R- RI R= R R/ R+ R; R t delete_MSetIteratorR? Rl Rn R Rq Rs Ru R ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyRh G s t ESetc B s e Z d Z e d d d d Z e Z d Z e j Z
d Z d Z d Z
d Z d
Z d Z d Z e e j Z RS(
s
Class representing an ordered set of expand terms (an ESet).
This set represents the results of an expand operation, which is
performed by Xapian::Enquire::get_eset().
c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c C s | j j | S( N( R R ( R5 R7 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s R8 s The membership flagc G s t j | t j | d S( sd
Copying is allowed (and is cheap).
Xapian::ESet::ESet(const ESet &other)
N( R t
ESet_swiginitt new_ESet( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; s c C s
t j | S( s
A lower bound on the number of terms which are in the full set of
results of the expand.
Xapian::termcount Xapian::ESet::get_ebound() const
This will be greater than or equal to size()
( R t ESet_get_ebound( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt
get_ebound s c C s
t j | S( sk
The number of terms in this E-Set.
Xapian::termcount Xapian::ESet::size() const
( R t ESet_size( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyRY s c C s
t j | S( sY
Test if this E-Set is empty.
bool Xapian::ESet::empty() const
( R t
ESet_empty( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR[ s c C s
t j | S( sj
Iterator for the terms in this E-Set.
ESetIterator Xapian::ESet::begin() const
( R t
ESet_begin( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR] s c C s
t j | S( sh
End iterator corresponding to begin()
ESetIterator Xapian::ESet::end() const
( R t ESet_end( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR_
s c C s
t j | S( sx
Iterator pointing to the last element of this E-Set.
ESetIterator Xapian::ESet::back() const
( R t ESet_back( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyRa
s c C s
t j | S( su
Return a string describing this object.
std::string Xapian::ESet::get_description() const
( R t ESet___str__( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR
s ( R R- RI R= R R/ R+ R; R t delete_ESetR? R| RY R[ R] R_ Ra R t ESet_items_getRg ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyRx s t ESetIteratorc B sS e Z d Z e d d d d Z e Z d Z e j Z
d Z d Z RS( s-
Iterate through terms in the ESet.
c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR )
s c C s | j j | S( N( R R ( R5 R7 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR )
s R8 s The membership flagc G s t j | t j | d S( s|
Copying is allowed (and is cheap).
Xapian::ESetIterator::ESetIterator(const ESetIterator &other)
N( R t ESetIterator_swiginitt new_ESetIterator( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; +
s c C s
t j | S( s
Get the weight of the term at the current position.
Xapian::weight Xapian::ESetIterator::get_weight() const
( R t ESetIterator_get_weight( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR 3
s c C s
t j | S( s}
Return a string describing this object.
std::string Xapian::ESetIterator::get_description() const
( R t ESetIterator___str__( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR ;
s (
R R- RI R= R R/ R+ R; R t delete_ESetIteratorR? R R ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR %
s t RSetc B sw e Z d Z e d d d d Z e Z d Z e j Z
d Z d Z d Z
d Z d
Z d Z RS( s
A relevance set (R-Set).
This is the set of documents which are marked as relevant, for use in
modifying the term weights, and in performing query expansion.
c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR U
s c C s | j j | S( N( R R ( R5 R7 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR U
s R8 s The membership flagc G s t j | t j | d S( sE
Default constructor.
Xapian::RSet::RSet()
N( R t
RSet_swiginitt new_RSet( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; W
s c C s
t j | S( sn
The number of documents in this R-Set.
Xapian::doccount Xapian::RSet::size() const
( R t RSet_size( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyRY _
s c C s
t j | S( sY
Test if this R-Set is empty.
bool Xapian::RSet::empty() const
( R t
RSet_empty( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR[ g
s c G s t j | | S( s
Add a document to the relevance set.
void Xapian::RSet::add_document(const Xapian::MSetIterator &i)
( R t RSet_add_document( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt add_documento
s c G s t j | | S( s
Remove a document from the relevance set.
void Xapian::RSet::remove_document(const Xapian::MSetIterator &i)
( R t RSet_remove_document( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt remove_documentw
s c G s t j | | S( s
Test if a given document in the relevance set.
bool Xapian::RSet::contains(const Xapian::MSetIterator &i) const
( R t
RSet_contains( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt contains
s c C s
t j | S( su
Return a string describing this object.
std::string Xapian::RSet::get_description() const
( R t RSet___str__( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR
s ( R R- RI R= R R/ R+ R; R t delete_RSetR? RY R[ R R R R ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR N
s t MatchDeciderc B sJ e Z d Z e d d d d Z e Z e j Z d Z
d Z RS( s3
Base class for matcher decision functor.
c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR
s c C s | j j | S( N( R R ( R5 R7 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR
s R8 s The membership flagc C s; | j t k r d } n | } t j | t j | d S( N( R, R R R t MatchDecider_swiginitt new_MatchDecider( R R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR;
s c C s$ | j j t j | t | S( N( R R R t disown_MatchDeciderR ( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR
s
( R R- RI R= R R/ R+ R t delete_MatchDeciderR? R; R ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR
s t
ExpandDeciderc B sJ e Z d Z e d d d d Z e Z e j Z d Z
d Z RS( s9
Virtual base class for expand decider functor.
c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR
s c C s | j j | S( N( R R ( R5 R7 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR
s R8 s The membership flagc C s; | j t k r d } n | } t j | t j | d S( N( R, R R R t ExpandDecider_swiginitt new_ExpandDecider( R R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR;
s c C s$ | j j t j | t | S( N( R R R t disown_ExpandDeciderR ( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR
s
( R R- RI R= R R/ R+ R t delete_ExpandDeciderR? R; R ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR
s t Enquirec B s e Z d Z e d d d d Z e Z d Z e j Z
d Z d Z d Z
d Z d
Z d Z e j Z e j Z e j Z d Z d
Z d Z d Z d Z d Z d Z d Z d Z e j Z! e j" Z# d Z$ d Z% d Z& d Z' RS( s
This class provides an interface to the information retrieval system
for the purpose of searching.
Databases are usually opened lazily, so exceptions may not be thrown
where you would expect them to be. You should catch Xapian::Error
exceptions when calling any method in Xapian::Enquire.
Parameters:
-----------
Xapian::InvalidArgumentError: will be thrown if an invalid argument
is supplied, for example, an unknown database type.
c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR
s c C s | j j | S( N( R R ( R5 R7 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR
s R8 s The membership flagc G s t j | t j | d S( s
Create a Xapian::Enquire object.
Xapian::Enquire::Enquire(const Database &database, ErrorHandler
*errorhandler_=0)
This specification cannot be changed once the Xapian::Enquire is
opened: you must create a new Xapian::Enquire object to access a
different database, or set of databases.
The database supplied must have been initialised (ie, must not be the
result of calling the Database::Database() constructor). If you need
to handle a situation where you have no index gracefully, a database
created with InMemory::open() can be passed here, which represents a
completely empty database.
Parameters:
-----------
database: Specification of the database or databases to use.
errorhandler_: A pointer to the error handler to use. Ownership of
the object pointed to is not assumed by the Xapian::Enquire object -
the user should delete the Xapian::ErrorHandler object after the
Xapian::Enquire object is deleted. To use no error handler, this
parameter should be 0.
Parameters:
-----------
Xapian::InvalidArgumentError: will be thrown if an empty Database
object is supplied.
N( R t Enquire_swiginitt new_Enquire( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR;
s "c G s t j | | S( s\
Set the query to run.
void Xapian::Enquire::set_query(const Xapian::Query &query,
Xapian::termcount qlen=0)
Parameters:
-----------
query: the new query to run.
qlen: the query length to use in weight calculations - by default the
sum of the wqf of all terms is used.
( R t Enquire_set_query( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt set_query
s c C s
t j | S( s;
Get the query which has been set.
const Xapian::Query& Xapian::Enquire::get_query() const
This is only valid after set_query() has been called.
Parameters:
-----------
Xapian::InvalidArgumentError: will be thrown if query has not yet
been set.
( R t Enquire_get_query( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_query s c G s t j | | S( s
Add a matchspy.
void Xapian::Enquire::add_matchspy(MatchSpy *spy)
This matchspy will be called with some of the documents which match
the query, during the match process. Exactly which of the matching
documents are passed to it depends on exactly when certain
optimisations occur during the match process, but it can be controlled
to some extent by setting the checkatleast parameter to get_mset().
In particular, if there are enough matching documents, at least the
number specified by checkatleast will be passed to the matchspy. This
means that you can force the matchspy to be shown all matching
documents by setting checkatleast to the number of documents in the
database.
Parameters:
-----------
spy: The MatchSpy subclass to add. The caller must ensure that this
remains valid while the Enquire object remains active, or until
clear_matchspies() is called.
( R t Enquire_add_matchspy( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt add_matchspy s c C s
t j | S( s_
Remove all the matchspies.
void Xapian::Enquire::clear_matchspies()
( R t Enquire_clear_matchspies( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt clear_matchspies3 s c G s t j | | S( s>
Set the weighting scheme to use for queries.
void Xapian::Enquire::set_weighting_scheme(const Weight &weight_)
Parameters:
-----------
weight_: the new weighting scheme. If no weighting scheme is
specified, the default is BM25 with the default parameters.
( R t Enquire_set_weighting_scheme( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt set_weighting_scheme; s c G s t j | | S( s
Set the collapse key to use for queries.
void Xapian::Enquire::set_collapse_key(Xapian::valueno collapse_key,
Xapian::doccount collapse_max=1)
Parameters:
-----------
collapse_key: value number to collapse on - at most one MSet entry
with each particular value will be returned (default is
Xapian::BAD_VALUENO which means no collapsing).
collapse_max: Max number of items with the same key to leave after
collapsing (default 1).
The MSet returned by get_mset() will have only the "best" (at most)
collapse_max entries with each particular value of collapse_key
("best" being highest ranked - i.e. highest weight or highest
sorting key).
An example use might be to create a value for each document containing
an MD5 hash of the document contents. Then duplicate documents from
different sources can be eliminated at search time by collapsing with
collapse_max = 1 (it's better to eliminate duplicates at index time,
but this may not be always be possible - for example the search may be
over more than one Xapian database).
Another use is to group matches in a particular category (e.g. you
might collapse a mailing list search on the Subject: so that there's
only one result per discussion thread). In this case you can use
get_collapse_count() to give the user some idea how many other results
there are. And if you index the Subject: as a boolean term as well as
putting it in a value, you can offer a link to a non-collapsed search
restricted to that thread using a boolean filter.
( R t Enquire_set_collapse_key( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt set_collapse_keyI s %c G s t j | | S( s3
Set the direction in which documents are ordered by document id in the
returned MSet.
void Xapian::Enquire::set_docid_order(docid_order order)
This order only has an effect on documents which would otherwise have
equal rank. For a weighted probabilistic match with no sort value,
this means documents with equal weight. For a boolean match, with no
sort value, this means all documents. And if a sort value is used,
this means documents with equal sort value (and also equal weight if
ordering on relevance after the sort).
Parameters:
-----------
order: This can be: Xapian::Enquire::ASCENDING docids sort in
ascending order (default)
Xapian::Enquire::DESCENDING docids sort in descending order
Xapian::Enquire::DONT_CARE docids sort in whatever order is most
efficient for the backend
Note: If you add documents in strict date order, then a boolean search
- i.e. set_weighting_scheme( Xapian::BoolWeight()) - with
set_docid_order(Xapian::Enquire::DESCENDING) is an efficient way to
perform "sort by date, newest first", and with
set_docid_order(Xapian::Enquire::ASCENDING) a very efficient way to
perform "sort by date, oldest first".
( R t Enquire_set_docid_order( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt set_docid_orders s c G s t j | | S( sp
Set the percentage and/or weight cutoffs.
void Xapian::Enquire::set_cutoff(Xapian::percent percent_cutoff,
Xapian::weight weight_cutoff=0)
Parameters:
-----------
percent_cutoff: Minimum percentage score for returned documents. If a
document has a lower percentage score than this, it will not appear in
the MSet. If your intention is to return only matches which contain
all the terms in the query, then it's more efficient to use
Xapian::Query::OP_AND instead of Xapian::Query::OP_OR in the query
than to use set_cutoff(100). (default 0 => no percentage cut-off).
weight_cutoff: Minimum weight for a document to be returned. If a
document has a lower score that this, it will not appear in the MSet.
It is usually only possible to choose an appropriate weight for cutoff
based on the results of a previous run of the same query; this is thus
mainly useful for alerting operations. The other potential use is with
a user specified weighting scheme. (default 0 => no weight cut-off).
( R t Enquire_set_cutoff( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt
set_cutoff s c C s
t j | S( s
Set the sorting to be by relevance only.
void Xapian::Enquire::set_sort_by_relevance()
This is the default.
( R t Enquire_set_sort_by_relevance( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt set_sort_by_relevance s c G s t j | | S( s\
void
Xapian::Enquire::set_sort_by_value(Xapian::valueno sort_key)
( R t Enquire_set_sort_by_value( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt set_sort_by_value s c G s t j | | S( ss
void
Xapian::Enquire::set_sort_by_value_then_relevance(Xapian::valueno
sort_key)
( R t( Enquire_set_sort_by_value_then_relevance( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt set_sort_by_value_then_relevance s c G s t j | | S( ss
void
Xapian::Enquire::set_sort_by_relevance_then_value(Xapian::valueno
sort_key)
( R t( Enquire_set_sort_by_relevance_then_value( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt set_sort_by_relevance_then_value s c G s t j | | S( sZ
void
Xapian::Enquire::set_sort_by_key(Xapian::KeyMaker *sorter)
( R t Enquire_set_sort_by_key( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt set_sort_by_key s c G s t j | | S( sq
void
Xapian::Enquire::set_sort_by_key_then_relevance(Xapian::KeyMaker
*sorter)
( R t& Enquire_set_sort_by_key_then_relevance( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt set_sort_by_key_then_relevance s c G s t j | | S( sq
void
Xapian::Enquire::set_sort_by_relevance_then_key(Xapian::KeyMaker
*sorter)
( R t& Enquire_set_sort_by_relevance_then_key( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt set_sort_by_relevance_then_key s c G s t j | | S( s
Get the expand set for the given rset.
ESet Xapian::Enquire::get_eset(Xapian::termcount maxitems, const RSet
&omrset, int flags, double k, const Xapian::ExpandDecider *edecider,
Xapian::weight min_wt) const
Parameters:
-----------
maxitems: the maximum number of items to return.
omrset: the relevance set to use when performing the expand
operation.
flags: zero or more of these values |-ed together:
Xapian::Enquire::INCLUDE_QUERY_TERMS query terms may be returned from
expand
Xapian::Enquire::USE_EXACT_TERMFREQ for multi dbs, calculate the exact
termfreq; otherwise an approximation is used which can greatly improve
efficiency, but still returns good results.
k: the parameter k in the query expansion algorithm (default is 1.0)
edecider: a decision functor to use to decide whether a given term
should be put in the ESet
min_wt: the minimum weight for included terms
An ESet object containing the results of the expand.
Parameters:
-----------
Xapian::InvalidArgumentError: See class documentation.
( R t Enquire_get_eset( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_eset s &c G s t j | | S( s~
Get terms which match a given document, by match set item.
TermIterator Xapian::Enquire::get_matching_terms_begin(const
MSetIterator &it) const
This method returns the terms in the current query which match the
given document.
If the underlying database has suitable support, using this call
(rather than passing a Xapian::docid) will enable the system to ensure
that the correct data is returned, and that the document has not been
deleted or changed since the query was performed.
Parameters:
-----------
it: The iterator for which to retrieve the matching terms.
An iterator returning the terms which match the document. The terms
will be returned (as far as this makes any sense) in the same order as
the terms in the query. Terms will not occur more than once, even if
they do in the query.
Parameters:
-----------
Xapian::InvalidArgumentError: See class documentation.
Xapian::DocNotFoundError: The document specified could not be found
in the database.
( R t Enquire_get_matching_terms_begin( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_matching_terms_begin s !c G s t j | | S( s
End iterator corresponding to get_matching_terms_begin()
TermIterator Xapian::Enquire::get_matching_terms_end(const
MSetIterator &) const
( R t Enquire_get_matching_terms_end( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_matching_terms_end5 s c C s
t j | S( sx
Return a string describing this object.
std::string Xapian::Enquire::get_description() const
( R t Enquire___str__( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR > s (( R R- RI R= R R/ R+ R; R t delete_EnquireR? R R R R R R t Enquire_ASCENDINGt ASCENDINGt Enquire_DESCENDINGt
DESCENDINGt Enquire_DONT_CAREt DONT_CARER R R R R R R R R t Enquire_INCLUDE_QUERY_TERMSt INCLUDE_QUERY_TERMSt Enquire_USE_EXACT_TERMFREQt USE_EXACT_TERMFREQR R R R ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR
s: # ' "
( # t Registryc B sw e Z d Z e d d d d Z e Z d Z e j Z
d Z d Z d Z
d Z d
Z d Z RS( s
Registry for user subclasses.
This class provides a way for the remote server to look up user
subclasses when unserialising.
c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR d s c C s | j j | S( N( R R ( R5 R7 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR d s R8 s The membership flagc G s t j | t j | d S( s
Default constructor.
Xapian::Registry::Registry()
The registry will contain all standard subclasses of user-subclassable
classes.
N( R t Registry_swiginitt new_Registry( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; f s c G s t j | | S( s
Register a weighting scheme.
void Xapian::Registry::register_weighting_scheme(const Xapian::Weight
&wt)
Parameters:
-----------
wt: The weighting scheme to register.
( R t" Registry_register_weighting_scheme( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt register_weighting_schemeq s c G s t j | | S( s
Get the weighting scheme given a name.
const Xapian::Weight* Xapian::Registry::get_weighting_scheme(const
std::string &name) const
Parameters:
-----------
name: The name of the weighting scheme to find.
An object with the requested name, or NULL if the weighting scheme
could not be found. The returned object is owned by the registry and
so must not be deleted by the caller.
( R t Registry_get_weighting_scheme( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_weighting_scheme s c G s t j | | S( s
Register a user-defined posting source class.
void Xapian::Registry::register_posting_source(const
Xapian::PostingSource &source)
Parameters:
-----------
source: The posting source to register.
( R t Registry_register_posting_source( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt register_posting_source s c G s t j | | S( s
Get a posting source given a name.
const Xapian::PostingSource*
Xapian::Registry::get_posting_source(const std::string &name) const
Parameters:
-----------
name: The name of the posting source to find.
An object with the requested name, or NULL if the posting source could
not be found. The returned object is owned by the registry and so must
not be deleted by the caller.
( R t Registry_get_posting_source( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_posting_source s c G s t j | | S( s
Register a user-defined match spy class.
void Xapian::Registry::register_match_spy(const Xapian::MatchSpy &spy)
Parameters:
-----------
spy: The match spy to register.
( R t Registry_register_match_spy( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt register_match_spy s c G s t j | | S( s
Get a match spy given a name.
const Xapian::MatchSpy* Xapian::Registry::get_match_spy(const
std::string &name) const
Parameters:
-----------
name: The name of the match spy to find.
An object with the requested name, or NULL if the match spy could not
be found. The returned object is owned by the registry and so must not
be deleted by the caller.
( R t Registry_get_match_spy( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt
get_match_spy s ( R R- RI R= R R/ R+ R; R t delete_RegistryR? R R R R R R ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR ] s
t Weightc B sn e Z d Z e d d d d Z d Z e Z e j Z
d Z d Z d Z
d Z d
Z RS( s5
Abstract base class for weighting schemes.
c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c C s | j j | S( N( R R ( R5 R7 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s R8 s The membership flagc O s t d d S( Ns* No constructor defined - class is abstract( R ( R R9 R: ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; s c C s
t j | S( s
Return the name of this weighting scheme.
virtual std::string Xapian::Weight::name() const
This name is used by the remote backend. It is passed along with the
serialised parameters to the remote server so that it knows which
class to create.
Return the full namespace-qualified name of your class here - if your
class is called FooWeight, return "FooWeight" from this method (
Xapian::BM25Weight returns "Xapian::BM25Weight" here).
If you don't want to support the remote backend, you can use the
default implementation which simply returns an empty string.
( R t Weight_name( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR" s c G s t j | | S( s
Calculate the weight contribution for this object's term to a
document.
virtual Xapian::weight Xapian::Weight::get_sumpart(Xapian::termcount
wdf, Xapian::termcount doclen) const =0
The parameters give information about the document which may be used
in the calculations:
Parameters:
-----------
wdf: The within document frequency of the term in the document.
doclen: The document's length (unnormalised).
( R t Weight_get_sumpart( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_sumpart s c C s
t j | S( s7
Return an upper bound on what get_sumpart() can return for any
document.
virtual Xapian::weight Xapian::Weight::get_maxpart() const =0
This information is used by the matcher to perform various
optimisations, so strive to make the bound as tight as possible.
( R t Weight_get_maxpart( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_maxpart
s
c G s t j | | S( s
Calculate the term-independent weight component for a document.
virtual Xapian::weight Xapian::Weight::get_sumextra(Xapian::termcount
doclen) const =0
The parameter gives information about the document which may be used
in the calculations:
Parameters:
-----------
doclen: The document's length (unnormalised).
( R t Weight_get_sumextra( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_sumextra
s c C s
t j | S( s9
Return an upper bound on what get_sumextra() can return for any
document.
virtual Xapian::weight Xapian::Weight::get_maxextra() const =0
This information is used by the matcher to perform various
optimisations, so strive to make the bound as tight as possible.
( R t Weight_get_maxextra( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_maxextra%
s
( R R- RI R= R R; R/ R+ R t
delete_WeightR? R" R R R R ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s t
BoolWeightc B sA e Z d Z e d d d d Z e Z d Z e j Z
RS( sw
Class implementing a "boolean" weighting scheme.
This weighting scheme gives all documents zero weight.
c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR A
s c C s | j j | S( N( R R ( R5 R7 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR A
s R8 s The membership flagc C s t j | t j d S( sT
Construct a BoolWeight.
Xapian::BoolWeight::BoolWeight()
N( R t BoolWeight_swiginitt new_BoolWeight( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; C
s ( R R- RI R= R R/ R+ R; R t delete_BoolWeightR? ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR ;
s
t
BM25Weightc B sA e Z d Z e d d d d Z e Z d Z e j Z
RS( sO
Xapian::Weight subclass implementing the BM25 probabilistic formula.
c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR S
s c C s | j j | S( N( R R ( R5 R7 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR S
s R8 s The membership flagc G s t j | t j | d S( s! Xapian::BM25Weight::BM25Weight() N( R t BM25Weight_swiginitt new_BM25Weight( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; U
s ( R R- RI R= R R/ R+ R; R t delete_BM25WeightR? ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR N
s
t
TradWeightc B sD e Z d Z e d d d d Z e Z d d Z e j Z
RS( s
Xapian::Weight subclass implementing the traditional probabilistic
formula.
This class implements the "traditional" Probabilistic Weighting
scheme, as described by the early papers on Probabilistic Retrieval.
BM25 generally gives better results.
TradWeight(k) is equivalent to BM25Weight(k, 0, 0, 1, 0), except that
the latter returns weights (k+1) times larger.
c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR h
s c C s | j j | S( N( R R ( R5 R7 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR h
s R8 s The membership flagg ?c C s t j | t j | d S( s
Construct a TradWeight.
Xapian::TradWeight::TradWeight(double k=1.0)
Parameters:
-----------
k: A non-negative parameter controlling how influential within-
document- frequency (wdf) and document length are. k=0 means that wdf
and document length don't affect the weights. The larger k is, the
more they do. (default 1)
N( R t TradWeight_swiginitt new_TradWeight( R t k( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; j
s ( R R- RI R= R R/ R+ R; R t delete_TradWeightR? ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR \
s
t MatchSpyc B se e Z d Z e d d d d Z e Z d Z e j Z
d Z d Z d Z
d Z RS(
s
Abstract base class for match spies.
The subclasses will generally accumulate information seen during the
match, to calculate aggregate functions, or other profiles of the
matching documents.
c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR
s c C s | j j | S( N( R R ( R5 R7 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR
s R8 s The membership flagc C s; | j t k r d } n | } t j | t j | d S( N( R, R R R t MatchSpy_swiginitt new_MatchSpy( R R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR;
s c C s
t j | S( s
Return the name of this match spy.
virtual std::string Xapian::MatchSpy::name() const
This name is used by the remote backend. It is passed with the
serialised parameters to the remote server so that it knows which
class to create.
Return the full namespace-qualified name of your class here - if your
class is called MyApp::FooMatchSpy, return "MyApp::FooMatchSpy" from
this method.
If you don't want to support the remote backend in your match spy, you
can use the default implementation which simply throws
Xapian::UnimplementedError.
( R t
MatchSpy_name( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR"
s c G s t j | | S( sw
Unserialise some results, and merge them into this matchspy.
virtual void Xapian::MatchSpy::merge_results(const std::string &s)
The order in which results are merged should not be significant, since
this order is not specified (and will vary depending on the speed of
the search in each sub-database).
If you don't want to support the remote backend in your match spy, you
can use the default implementation which simply throws
Xapian::UnimplementedError.
Parameters:
-----------
s: A string containing the serialised results.
( R t MatchSpy_merge_results( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt
merge_results
s c C s
t j | S( sy
Return a string describing this object.
virtual std::string Xapian::MatchSpy::get_description() const
This default implementation returns a generic answer, to avoid forcing
those deriving their own MatchSpy subclasses from having to implement
this (they may not care what get_description() gives for their
subclass).
( R t MatchSpy___str__( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR
s c C s$ | j j t j | t | S( N( R R R t disown_MatchSpyR ( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR
s
( R R- RI R= R R/ R+ R; R t delete_MatchSpyR? R" R R R ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR }
s
t ValueCountMatchSpyc B sn e Z d Z e d d d d Z e Z d Z d Z d Z d Z
d Z d
Z e
j Z RS( sV
Class for counting the frequencies of values in the matching
documents.
c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR
s c C s | j j | S( N( R R ( R5 R7 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR
s R8 s The membership flagc G s t j | t j | d S( s
Construct a MatchSpy which counts the values in a particular slot.
Xapian::ValueCountMatchSpy::ValueCountMatchSpy(Xapian::valueno slot_)
N( R t ValueCountMatchSpy_swiginitt new_ValueCountMatchSpy( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR;
s c C s
t j | S( s~
Return the total number of documents tallied.
size_t Xapian::ValueCountMatchSpy::get_total() const
( R t ValueCountMatchSpy_get_total( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_total
s c C s
t j | S( sV
Get an iterator over the values seen in the slot.
TermIterator Xapian::ValueCountMatchSpy::values_begin() const
Items will be returned in ascending alphabetical order.
During the iteration, the frequency of the current value can be
obtained with the get_termfreq() method on the iterator.
( R t ValueCountMatchSpy_values_begin( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR
s c C s
t j | S( s
End iterator corresponding to values_begin()
TermIterator Xapian::ValueCountMatchSpy::values_end() const
( R t ValueCountMatchSpy_values_end( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR
s c G s t j | | S( s@
Get an iterator over the most frequent values seen in the slot.
TermIterator Xapian::ValueCountMatchSpy::top_values_begin(size_t
maxvalues) const
Items will be returned in descending order of frequency. Values with
the same frequency will be returned in ascending alphabetical order.
During the iteration, the frequency of the current value can be
obtained with the get_termfreq() method on the iterator.
Parameters:
-----------
maxvalues: The maximum number of values to return.
( R t# ValueCountMatchSpy_top_values_begin( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt top_values_begin
s c G s t j | | S( s
End iterator corresponding to top_values_begin()
TermIterator Xapian::ValueCountMatchSpy::top_values_end(size_t) const
( R t! ValueCountMatchSpy_top_values_end( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt top_values_end s ( R R- RI R= R R/ R+ R; R
R R R R R t delete_ValueCountMatchSpyR? ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR
s
t Databasec B s e Z d Z e d d d d Z e Z d Z e j Z
d Z d Z d Z
d Z d
Z d Z d Z d
Z d Z d Z d Z d Z d Z d Z d Z d Z d Z d Z d Z d Z d Z d Z d Z! d Z" d Z# d Z$ d Z% d! Z& d" Z' d# Z( d$ Z) d% Z* d& Z+ d' Z, d( d) Z- d( d* Z. d+ Z/ d( d, Z0 d( d- Z1 d. Z2 d/ Z3 RS(0 sm
This class is used to access a database, or a group of databases.
For searching, this class is used in conjunction with an Enquire
object.
Parameters:
-----------
InvalidArgumentError: will be thrown if an invalid argument is
supplied, for example, an unknown database type.
DatabaseOpeningError: may be thrown if the database cannot be opened
(for example, a required file cannot be found).
DatabaseVersionError: may be thrown if the database is in an
unsupported format (for example, created by a newer version of Xapian
which uses an incompatible format).
c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR 5 s c C s | j j | S( N( R R ( R5 R7 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR 5 s R8 s The membership flagc G s t j | | S( s
Add an existing database (or group of databases) to those accessed by
this object.
void Xapian::Database::add_database(const Database &database)
Parameters:
-----------
database: the database(s) to add.
( R t Database_add_database( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt add_database7 s c G s t j | t j | d S( s
Copying is allowed.
Xapian::Database::Database(const Database &other)
The internals are reference counted, so copying is cheap.
Parameters:
-----------
other: The object to copy.
N( R t Database_swiginitt new_Database( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; F s
c C s
t j | S( s
Re-open the database.
void Xapian::Database::reopen()
This re-opens the database(s) to the latest available version(s). It
can be used either to make sure the latest results are returned, or to
recover from a Xapian::DatabaseModifiedError.
Calling reopen() on a database which has been closed (with close())
will always raise a Xapian::DatabaseError.
( R t Database_reopen( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt reopenT s
c C s
t j | S( s
Close the database.
virtual void Xapian::Database::close()
This closes the database and closes all its file handles.
For a WritableDatabase, if a transaction is active it will be aborted,
while if no transaction is active commit() will be implicitly called.
Also the write lock is released.
Closing a database cannot be undone - in particular, calling reopen()
after close() will not reopen it, but will instead throw a
Xapian::DatabaseError exception.
Calling close() again on a database which has already been closed has
no effect (and doesn't raise an exception).
After close() has been called, calls to other methods of the database,
and to methods of other objects associated with the database, will
either:
behave exactly as they would have done if the database had not been
closed (this can only happen if all the required data is cached)
raise a Xapian::DatabaseError exception indicating that the database
is closed.
The reason for this behaviour is that otherwise we'd have to check
that the database is still open on every method call on every object
associated with a Database, when in many cases they are working on
data which has already been loaded and so they are able to just behave
correctly.
This method was added in Xapian 1.1.0.
( R t Database_close( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR c s %c C s
t j | S( s
Return a string describing this object.
virtual std::string Xapian::Database::get_description() const
( R t Database___str__( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c G s t j | | S( s
An iterator pointing to the start of the postlist for a given term.
PostingIterator Xapian::Database::postlist_begin(const std::string
&tname) const
Parameters:
-----------
tname: The termname to iterate postings for. If the term name is the
empty string, the iterator returned will list all the documents in the
database. Such an iterator will always return a WDF value of 1, since
there is no obvious meaning for this quantity in this case.
( R t Database_postlist_begin( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt postlist_begin s c G s t j | | S( s
Corresponding end iterator to postlist_begin().
PostingIterator Xapian::Database::postlist_end(const std::string &)
const
( R t Database_postlist_end( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt postlist_end s c G s t j | | S( s
An iterator pointing to the start of the termlist for a given
document.
TermIterator Xapian::Database::termlist_begin(Xapian::docid did) const
Parameters:
-----------
did: The document id of the document to iterate terms for.
( R t Database_termlist_begin( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c G s t j | | S( s
Corresponding end iterator to termlist_begin().
TermIterator Xapian::Database::termlist_end(Xapian::docid) const
( R t Database_termlist_end( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c G s t j | | S( s
An iterator pointing to the start of the position list for a given
term in a given document.
PositionIterator Xapian::Database::positionlist_begin(Xapian::docid
did, const std::string &tname) const
( R t Database_positionlist_begin( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c G s t j | | S( s
Corresponding end iterator to positionlist_begin().
PositionIterator Xapian::Database::positionlist_end(Xapian::docid,
const std::string &) const
( R t Database_positionlist_end( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c G s t j | | S( s
An iterator which runs across all terms with a given prefix.
TermIterator Xapian::Database::allterms_begin(const std::string
&prefix) const
This is functionally similar to getting an iterator with
allterms_begin() and then calling skip_to(prefix) on that iterator to
move to the start of the prefix, but is more convenient (because it
detects the end of the prefixed terms), and may be more efficient than
simply calling skip_to() after opening the iterator, particularly for
remote databases.
Parameters:
-----------
prefix: The prefix to restrict the returned terms to.
( R t Database_allterms_begin( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt allterms_begin s c G s t j | | S( s
Corresponding end iterator to allterms_begin(prefix).
TermIterator Xapian::Database::allterms_end(const std::string &) const
( R t Database_allterms_end( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt allterms_end s c C s
t j | S( s
Get the number of documents in the database.
Xapian::doccount Xapian::Database::get_doccount() const
( R t Database_get_doccount( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_doccount s c C s
t j | S( s
Get the highest document id which has been used in the database.
Xapian::docid Xapian::Database::get_lastdocid() const
( R t Database_get_lastdocid( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt
get_lastdocid s c C s
t j | S( s
Get the average length of the documents in the database.
Xapian::doclength Xapian::Database::get_avlength() const
( R t Database_get_avlength( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_avlength s c G s t j | | S( s
Get the number of documents in the database indexed by a given term.
Xapian::doccount Xapian::Database::get_termfreq(const std::string
&tname) const
( R t Database_get_termfreq( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c G s t j | | S( s
Check if a given term exists in the database.
bool Xapian::Database::term_exists(const std::string &tname) const
Parameters:
-----------
tname: The term to test the existence of.
true if and only if the term exists in the database. This is the same
as (get_termfreq(tname) != 0), but will often be more efficient.
( R t Database_term_exists( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt term_exists s c G s t j | | S( s
Return the total number of occurrences of the given term.
Xapian::termcount Xapian::Database::get_collection_freq(const
std::string &tname) const
This is the sum of the number of occurrences of the term in each
document it indexes: i.e., the sum of the within document frequencies
of the term.
Parameters:
-----------
tname: The term whose collection frequency is being requested.
( R t Database_get_collection_freq( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_collection_freq$ s c G s t j | | S( s
Return the frequency of a given value slot.
Xapian::doccount Xapian::Database::get_value_freq(Xapian::valueno
slot) const
This is the number of documents which have a (non-empty) value stored
in the slot.
Parameters:
-----------
slot: The value slot to examine.
Parameters:
-----------
UnimplementedError: The frequency of the value isn't available for
this database type.
( R t Database_get_value_freq( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_value_freq6 s c G s t j | | S( s
Get a lower bound on the values stored in the given value slot.
std::string Xapian::Database::get_value_lower_bound(Xapian::valueno
slot) const
If there are no values stored in the given value slot, this will
return an empty string.
If the lower bound isn't available for the given database type, this
will return the lowest possible bound - the empty string.
Parameters:
-----------
slot: The value slot to examine.
( R t Database_get_value_lower_bound( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_value_lower_boundM s c G s t j | | S( s
Get an upper bound on the values stored in the given value slot.
std::string Xapian::Database::get_value_upper_bound(Xapian::valueno
slot) const
If there are no values stored in the given value slot, this will
return an empty string.
Parameters:
-----------
slot: The value slot to examine.
Parameters:
-----------
UnimplementedError: The upper bound of the values isn't available for
this database type.
( R t Database_get_value_upper_bound( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_value_upper_bounda s c C s
t j | S( s
Get a lower bound on the length of a document in this DB.
Xapian::termcount Xapian::Database::get_doclength_lower_bound() const
This bound does not include any zero-length documents.
( R t" Database_get_doclength_lower_bound( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_doclength_lower_boundx s c C s
t j | S( s
Get an upper bound on the length of a document in this DB.
Xapian::termcount Xapian::Database::get_doclength_upper_bound() const
( R t" Database_get_doclength_upper_bound( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_doclength_upper_bound s c G s t j | | S( s
Get an upper bound on the wdf of term term.
Xapian::termcount Xapian::Database::get_wdf_upper_bound(const
std::string &term) const
( R t Database_get_wdf_upper_bound( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_wdf_upper_bound s c G s t j | | S( s
Return an iterator over the value in slot slot for each document.
ValueIterator Xapian::Database::valuestream_begin(Xapian::valueno
slot) const
( R t Database_valuestream_begin( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt valuestream_begin s c G s t j | | S( s
Return end iterator corresponding to valuestream_begin().
ValueIteratorEnd_ Xapian::Database::valuestream_end(Xapian::valueno)
const
( R t Database_valuestream_end( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt valuestream_end s c G s t j | | S( s
Get the length of a document.
Xapian::termcount Xapian::Database::get_doclength(Xapian::docid did)
const
( R t Database_get_doclength( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c C s
t j | S( s
Send a "keep-alive" to remote databases to stop them timing out.
void Xapian::Database::keep_alive()
Has no effect on non-remote databases.
( R t Database_keep_alive( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt
keep_alive s c G s t j | | S( s
Get a document from the database, given its document id.
Xapian::Document Xapian::Database::get_document(Xapian::docid did)
const
This method returns a Xapian::Document object which provides the
information about a document.
Parameters:
-----------
did: The document id of the document to retrieve.
A Xapian::Document object containing the document data
Parameters:
-----------
Xapian::DocNotFoundError: The document specified could not be found
in the database.
Xapian::InvalidArgumentError: did was 0, which is not a valid
document id.
( R t Database_get_document( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyRl s c G s t j | | S( s
Suggest a spelling correction.
std::string Xapian::Database::get_spelling_suggestion(const
std::string &word, unsigned max_edit_distance=2) const
Parameters:
-----------
word: The potentially misspelled word.
max_edit_distance: Only consider words which are at most
max_edit_distance edits from word. An edit is a character insertion,
deletion, or the transposition of two adjacent characters (default is
2).
( R t Database_get_spelling_suggestion( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_spelling_suggestion s c C s
t j | S( sz
An iterator which returns all the spelling correction targets.
Xapian::TermIterator Xapian::Database::spellings_begin() const
This returns all the words which are considered as targets for the
spelling correction algorithm. The frequency of each word is available
as the term frequency of each entry in the returned iterator.
( R t Database_spellings_begin( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt spellings_begin s
c C s
t j | S( s
Corresponding end iterator to spellings_begin().
Xapian::TermIterator Xapian::Database::spellings_end() const
( R t Database_spellings_end( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt
spellings_end s c G s t j | | S( s
An iterator which returns all the synonyms for a given term.
Xapian::TermIterator Xapian::Database::synonyms_begin(const
std::string &term) const
Parameters:
-----------
term: The term to return synonyms for.
( R t Database_synonyms_begin( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt synonyms_begin s c G s t j | | S( s
Corresponding end iterator to synonyms_begin(term).
Xapian::TermIterator Xapian::Database::synonyms_end(const std::string
&) const
( R t Database_synonyms_end( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt synonyms_end
s R* c C s t j | | S( s8
An iterator which returns all terms which have synonyms.
Xapian::TermIterator Xapian::Database::synonym_keys_begin(const
std::string &prefix=std::string()) const
Parameters:
-----------
prefix: If non-empty, only terms with this prefix are returned.
( R t Database_synonym_keys_begin( R t prefix( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt synonym_keys_begin s c C s t j | | S( s
Corresponding end iterator to synonym_keys_begin(prefix).
Xapian::TermIterator Xapian::Database::synonym_keys_end(const
std::string &=std::string()) const
( R t Database_synonym_keys_end( R RQ ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt synonym_keys_end! s c G s t j | | S( sD
Get the user-specified metadata associated with a given key.
std::string Xapian::Database::get_metadata(const std::string &key)
const
User-specified metadata allows you to store arbitrary information in
the form of (key,tag) pairs. See WritableDatabase::set_metadata() for
more information.
When invoked on a Xapian::Database object representing multiple
databases, currently only the metadata for the first is considered but
this behaviour may change in the future.
If there is no piece of metadata associated with the specified key, an
empty string is returned (this applies even for backends which don't
support metadata).
Empty keys are not valid, and specifying one will cause an exception.
Parameters:
-----------
key: The key of the metadata item to access.
The retrieved metadata item's value.
Parameters:
-----------
Xapian::InvalidArgumentError: will be thrown if the key supplied is
empty.
( R t Database_get_metadata( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_metadata* s "c C s t j | | S( s
An iterator which returns all user-specified metadata keys.
Xapian::TermIterator Xapian::Database::metadata_keys_begin(const
std::string &prefix=std::string()) const
When invoked on a Xapian::Database object representing multiple
databases, currently only the metadata for the first is considered but
this behaviour may change in the future.
If the backend doesn't support metadata, then this method returns an
iterator which compares equal to that returned by metadata_keys_end().
Parameters:
-----------
prefix: If non-empty, only keys with this prefix are returned.
Parameters:
-----------
Xapian::UnimplementedError: will be thrown if the backend implements
user-specified metadata, but doesn't implement iterating its keys
(currently this happens for the InMemory backend).
( R t Database__metadata_keys_begin( R RQ ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt _metadata_keys_beginN s c C s t j | | S( s
Corresponding end iterator to metadata_keys_begin().
Xapian::TermIterator Xapian::Database::metadata_keys_end(const
std::string &=std::string()) const
( R t Database__metadata_keys_end( R RQ ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt _metadata_keys_endj s c C s
t j | S( s}
Get a UUID for the database.
std::string Xapian::Database::get_uuid() const
The UUID will persist for the lifetime of the database.
Replicas (eg, made with the replication protocol, or by copying all
the database files) will have the same UUID. However, copies (made
with copydatabase, or xapian-compact) will have different UUIDs.
If the backend does not support UUIDs or this database has no
subdatabases, the UUID will be empty.
If this database has multiple sub-databases, the UUID string will
contain the UUIDs of all the sub-databases.
( R t Database_get_uuid( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_uuids s c C s
t j | S( s|
Does this database have any positional information?
bool Xapian::Database::has_positions() const
( R t Database_has_positions( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt
has_positions s (4 R R- RI R= R R/ R+ R R t delete_DatabaseR? R; R R R R R R R R R R$ R& R( R* R, R R/ R1 R3 R5 R7 R9 R; R= R? RA R RD Rl RG RI RK RM RO RR RT RV RX RZ R\ R^ ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR ! s\ '
$ t WritableDatabasec B s e Z d Z e d d d d Z e Z e j Z d Z
d Z d Z e
d Z d Z d
Z d Z d Z d
Z d Z d Z d Z d Z d Z d Z d Z RS( s?
This class provides read/write access to a database.
c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c C s | j j | S( N( R R ( R5 R7 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s R8 s The membership flagc G s t j | t j | d S( s
Copying is allowed.
Xapian::WritableDatabase::WritableDatabase(const WritableDatabase
&other)
The internals are reference counted, so copying is cheap.
Parameters:
-----------
other: The object to copy.
N( R t WritableDatabase_swiginitt new_WritableDatabase( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; s c C s
t j | S( sX
Commit any pending modifications made to the database.
void Xapian::WritableDatabase::commit()
For efficiency reasons, when performing multiple updates to a database
it is best (indeed, almost essential) to make as many modifications as
memory will permit in a single pass through the database. To ensure
this, Xapian batches up modifications.
This method may be called at any time to commit any pending
modifications to the database.
If any of the modifications fail, an exception will be thrown and the
database will be left in a state in which each separate addition,
replacement or deletion operation has either been fully performed or
not performed at all: it is then up to the application to work out
which operations need to be repeated.
It's not valid to call commit() within a transaction.
Beware of calling commit() too frequently: this will make indexing
take much longer.
Note that commit() need not be called explicitly: it will be called
automatically when the database is closed, or when a sufficient number
of modifications have been made. By default, this is every 10000
documents added, deleted, or modified. This value is rather
conservative, and if you have a machine with plenty of memory, you can
improve indexing throughput dramatically by setting
XAPIAN_FLUSH_THRESHOLD in the environment to a larger value.
This method was new in Xapian 1.1.0 - in earlier versions it was
called flush().
Parameters:
-----------
Xapian::DatabaseError: will be thrown if a problem occurs while
modifying the database.
Xapian::DatabaseCorruptError: will be thrown if the database is in a
corrupt state.
( R t WritableDatabase_commit( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt commit s -c C s
t j | S( s
Pre-1.1.0 name for commit().
void Xapian::WritableDatabase::flush()
Use commit() instead in new code. This alias may be deprecated in the
future.
( R t WritableDatabase_flush( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt flush s c C s t j | | S( s
Begin a transaction.
void Xapian::WritableDatabase::begin_transaction(bool flushed=true)
In Xapian a transaction is a group of modifications to the database
which are linked such that either all will be applied simultaneously
or none will be applied at all. Even in the case of a power failure,
this characteristic should be preserved (as long as the filesystem
isn't corrupted, etc).
A transaction is started with begin_transaction() and can either be
committed by calling commit_transaction() or aborted by calling
cancel_transaction().
By default, a transaction implicitly calls commit() before and after
so that the modifications stand and fall without affecting
modifications before or after.
The downside of these implicit calls to commit() is that small
transactions can harm indexing performance in the same way that
explicitly calling commit() frequently can.
If you're applying atomic groups of changes and only wish to ensure
that each group is either applied or not applied, then you can prevent
the automatic commit() before and after the transaction by starting
the transaction with begin_transaction(false). However, if
cancel_transaction is called (or if commit_transaction isn't called
before the WritableDatabase object is destroyed) then any changes
which were pending before the transaction began will also be
discarded.
Transactions aren't currently supported by the InMemory backend.
Parameters:
-----------
flushed: Is this a flushed transaction? By default transactions are
"flushed", which means that committing a transaction will ensure
those changes are permanently written to the database. By contrast,
unflushed transactions only ensure that changes within the transaction
are either all applied or all aren't.
Parameters:
-----------
Xapian::UnimplementedError: will be thrown if transactions are not
available for this database type.
Xapian::InvalidOperationError: will be thrown if this is called at an
invalid time, such as when a transaction is already in progress.
( R t" WritableDatabase_begin_transaction( R t flushed( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt begin_transaction s 5c C s
t j | S( s&
Complete the transaction currently in progress.
void Xapian::WritableDatabase::commit_transaction()
If this method completes successfully and this is a flushed
transaction, all the database modifications made during the
transaction will have been committed to the database.
If an error occurs, an exception will be thrown, and none of the
modifications made to the database during the transaction will have
been applied to the database.
In all cases the transaction will no longer be in progress.
Parameters:
-----------
Xapian::DatabaseError: will be thrown if a problem occurs while
modifying the database.
Xapian::DatabaseCorruptError: will be thrown if the database is in a
corrupt state.
Xapian::InvalidOperationError: will be thrown if a transaction is not
currently in progress.
Xapian::UnimplementedError: will be thrown if transactions are not
available for this database type.
( R t# WritableDatabase_commit_transaction( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt commit_transactionB s c C s
t j | S( s
Abort the transaction currently in progress, discarding the pending
modifications made to the database.
void Xapian::WritableDatabase::cancel_transaction()
If an error occurs in this method, an exception will be thrown, but
the transaction will be cancelled anyway.
Parameters:
-----------
Xapian::DatabaseError: will be thrown if a problem occurs while
modifying the database.
Xapian::DatabaseCorruptError: will be thrown if the database is in a
corrupt state.
Xapian::InvalidOperationError: will be thrown if a transaction is not
currently in progress.
Xapian::UnimplementedError: will be thrown if transactions are not
available for this database type.
( R t# WritableDatabase_cancel_transaction( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt cancel_transactionc s c G s t j | | S( s>
Add a new document to the database.
Xapian::docid Xapian::WritableDatabase::add_document(const
Xapian::Document &document)
This method adds the specified document to the database, returning a
newly allocated document ID. Automatically allocated document IDs come
from a per-database monotonically increasing counter, so IDs from
deleted documents won't be reused.
If you want to specify the document ID to be used, you should call
replace_document() instead.
Note that changes to the database won't be immediately committed to
disk; see commit() for more details.
As with all database modification operations, the effect is atomic:
the document will either be fully added, or the document fails to be
added and an exception is thrown (possibly at a later time when
commit() is called or the database is closed).
Parameters:
-----------
document: The new document to be added.
The document ID of the newly added document.
Parameters:
-----------
Xapian::DatabaseError: will be thrown if a problem occurs while
writing to the database.
Xapian::DatabaseCorruptError: will be thrown if the database is in a
corrupt state.
( R t WritableDatabase_add_document( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR ~ s 'c G s t j | | S( s
Delete any documents indexed by a term from the database.
void Xapian::WritableDatabase::delete_document(const std::string
&unique_term)
This method removes any documents indexed by the specified term from
the database.
A major use is for convenience when UIDs from another system are
mapped to terms in Xapian, although this method has other uses (for
example, you could add a "deletion date" term to documents at index
time and use this method to delete all documents due for deletion on a
particular date).
Parameters:
-----------
unique_term: The term to remove references to.
Parameters:
-----------
Xapian::DatabaseError: will be thrown if a problem occurs while
writing to the database.
Xapian::DatabaseCorruptError: will be thrown if the database is in a
corrupt state.
( R t WritableDatabase_delete_document( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt delete_document s c G s t j | | S( s]
Replace any documents matching a term.
Xapian::docid Xapian::WritableDatabase::replace_document(const
std::string &unique_term, const Xapian::Document &document)
This method replaces any documents indexed by the specified term with
the specified document. If any documents are indexed by the term, the
lowest document ID will be used for the document, otherwise a new
document ID will be generated as for add_document.
One common use is to allow UIDs from another system to easily be
mapped to terms in Xapian. Note that this method doesn't automatically
add unique_term as a term, so you'll need to call
document.add_term(unique_term) first when using replace_document() in
this way.
Note that changes to the database won't be immediately committed to
disk; see commit() for more details.
As with all database modification operations, the effect is atomic:
the document(s) will either be fully replaced, or the document(s) fail
to be replaced and an exception is thrown (possibly at a later time
when commit() is called or the database is closed).
Parameters:
-----------
unique_term: The "unique" term.
document: The new document.
The document ID that document was given.
Parameters:
-----------
Xapian::DatabaseError: will be thrown if a problem occurs while
writing to the database.
Xapian::DatabaseCorruptError: will be thrown if the database is in a
corrupt state.
( R t! WritableDatabase_replace_document( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt replace_document s ,c G s t j | | S( s
Add a word to the spelling dictionary.
void Xapian::WritableDatabase::add_spelling(const std::string &word,
Xapian::termcount freqinc=1) const
If the word is already present, its frequency is increased.
Parameters:
-----------
word: The word to add.
freqinc: How much to increase its frequency by (default 1).
( R t WritableDatabase_add_spelling( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt add_spelling s c G s t j | | S( s
Remove a word from the spelling dictionary.
void Xapian::WritableDatabase::remove_spelling(const std::string
&word, Xapian::termcount freqdec=1) const
The word's frequency is decreased, and if would become zero or less
then the word is removed completely.
Parameters:
-----------
word: The word to remove.
freqdec: How much to decrease its frequency by (default 1).
( R t WritableDatabase_remove_spelling( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt remove_spelling s c G s t j | | S( sj
Add a synonym for a term.
void Xapian::WritableDatabase::add_synonym(const std::string &term,
const std::string &synonym) const
Parameters:
-----------
term: The term to add a synonym for.
synonym: The synonym to add. If this is already a synonym for term,
then no action is taken.
( R t WritableDatabase_add_synonym( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt add_synonym s c G s t j | | S( s{
Remove a synonym for a term.
void Xapian::WritableDatabase::remove_synonym(const std::string &term,
const std::string &synonym) const
Parameters:
-----------
term: The term to remove a synonym for.
synonym: The synonym to remove. If this isn't currently a synonym for
term, then no action is taken.
( R t WritableDatabase_remove_synonym( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt remove_synonym+ s c G s t j | | S( s'
Remove all synonyms for a term.
void Xapian::WritableDatabase::clear_synonyms(const std::string &term)
const
Parameters:
-----------
term: The term to remove all synonyms for. If the term has no
synonyms, no action is taken.
( R t WritableDatabase_clear_synonyms( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt clear_synonyms< s
c G s t j | | S( si
Set the user-specified metadata associated with a given key.
void Xapian::WritableDatabase::set_metadata(const std::string &key,
const std::string &value)
This method sets the metadata value associated with a given key. If
there is already a metadata value stored in the database with the same
key, the old value is replaced. If you want to delete an existing item
of metadata, just set its value to the empty string.
User-specified metadata allows you to store arbitrary information in
the form of (key,tag) pairs.
There's no hard limit on the number of metadata items, or the size of
the metadata values. Metadata keys have a limited length, which
depends on the backend. We recommend limiting them to 200 bytes. Empty
keys are not valid, and specifying one will cause an exception.
Metadata modifications are committed to disk in the same way as
modifications to the documents in the database are: i.e.,
modifications are atomic, and won't be committed to disk immediately
(see commit() for more details). This allows metadata to be used to
link databases with versioned external resources by storing the
appropriate version number in a metadata item.
You can also use the metadata to store arbitrary extra information
associated with terms, documents, or postings by encoding the termname
and/or document id into the metadata key.
Parameters:
-----------
key: The key of the metadata item to set.
value: The value of the metadata item to set.
Parameters:
-----------
Xapian::DatabaseError: will be thrown if a problem occurs while
writing to the database.
Xapian::DatabaseCorruptError: will be thrown if the database is in a
corrupt state.
Xapian::InvalidArgumentError: will be thrown if the key supplied is
empty.
Xapian::UnimplementedError: will be thrown if the database backend in
use doesn't support user- specified metadata.
( R t WritableDatabase_set_metadata( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt set_metadataK s 5c C s
t j | S( s
Return a string describing this object.
std::string Xapian::WritableDatabase::get_description() const
( R t WritableDatabase___str__( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s ( R R- RI R= R R/ R+ R t delete_WritableDatabaseR? R; Rd Rf t TrueRi Rk Rm R Rp Rr Rt Rv Rx Rz R| R~ R ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR` s( / 7 ! ) . 7c G s
t j | S( s
Construct a WritableDatabase object for a stub database file.
WritableDatabase Xapian::Auto::open_stub(const std::string &file, int
action)
The stub database file must contain serialised parameters for exactly
one database.
Parameters:
-----------
file: pathname of the stub database file.
action: determines handling of existing/non-existing database:
Xapian::DB_CREATE fail if database already exist, otherwise create new
database.
Xapian::DB_CREATE_OR_OPEN open existing database, or create new
database if none exists.
Xapian::DB_CREATE_OR_OVERWRITE overwrite existing database, or create
new database if none exists.
Xapian::DB_OPEN open existing database, failing if none exists.
( R t open_stub( R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c G s
t j | S( s
Construct a Database object for update access to a Brass database.
WritableDatabase Xapian::Brass::open(const std::string &dir, int
action, int block_size=8192)
Parameters:
-----------
dir: pathname of the directory containing the database.
action: determines handling of existing/non-existing database:
Xapian::DB_CREATE fail if database already exist, otherwise create new
database.
Xapian::DB_CREATE_OR_OPEN open existing database, or create new
database if none exists.
Xapian::DB_CREATE_OR_OVERWRITE overwrite existing database, or create
new database if none exists.
Xapian::DB_OPEN open existing database, failing if none exists.
block_size: the Btree blocksize to use (in bytes), which must be a
power of two between 2048 and 65536 (inclusive). The default (also
used if an invalid value if passed) is 8192 bytes. This parameter is
ignored when opening an existing database.
( R t
brass_open( R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c G s
t j | S( s
Construct a Database object for update access to a Chert database.
WritableDatabase Xapian::Chert::open(const std::string &dir, int
action, int block_size=8192)
Parameters:
-----------
dir: pathname of the directory containing the database.
action: determines handling of existing/non-existing database:
Xapian::DB_CREATE fail if database already exist, otherwise create new
database.
Xapian::DB_CREATE_OR_OPEN open existing database, or create new
database if none exists.
Xapian::DB_CREATE_OR_OVERWRITE overwrite existing database, or create
new database if none exists.
Xapian::DB_OPEN open existing database, failing if none exists.
block_size: the Btree blocksize to use (in bytes), which must be a
power of two between 2048 and 65536 (inclusive). The default (also
used if an invalid value if passed) is 8192 bytes. This parameter is
ignored when opening an existing database.
( R t
chert_open( R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c G s
t j | S( s
Construct a Database object for update access to a Flint database.
WritableDatabase Xapian::Flint::open(const std::string &dir, int
action, int block_size=8192)
Parameters:
-----------
dir: pathname of the directory containing the database.
action: determines handling of existing/non-existing database:
Xapian::DB_CREATE fail if database already exist, otherwise create new
database.
Xapian::DB_CREATE_OR_OPEN open existing database, or create new
database if none exists.
Xapian::DB_CREATE_OR_OVERWRITE overwrite existing database, or create
new database if none exists.
Xapian::DB_OPEN open existing database, failing if none exists.
block_size: the Btree blocksize to use (in bytes), which must be a
power of two between 2048 and 65536 (inclusive). The default (also
used if an invalid value if passed) is 8192 bytes. This parameter is
ignored when opening an existing database.
( R t
flint_open( R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c C s
t j S( s
Construct a WritableDatabase object for a new, empty InMemory
database.
WritableDatabase Xapian::InMemory::open()
Only a writable InMemory database can be created, since a read-only
one would always remain empty.
( R t
inmemory_open( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s
c G s
t j | S( s
Construct a Database object for read-only access to a remote database
accessed via a program.
Database Xapian::Remote::open(const std::string &program, const
std::string &args, Xapian::timeout timeout=10000)
Access to the remote database is done by running an external program
and communicating with it on stdin/stdout.
Parameters:
-----------
program: the external program to run.
args: space-separated list of arguments to pass to program.
timeout: timeout in milliseconds. If this timeout is exceeded for any
individual operation on the remote database then
Xapian::NetworkTimeoutError is thrown. A timeout of 0 means don't
timeout. (Default is 10000ms, which is 10 seconds).
( R t remote_open( R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR ' s c G s
t j | S( s
Construct a WritableDatabase object for update access to a remote
database accessed via a program.
WritableDatabase Xapian::Remote::open_writable(const std::string
&program, const std::string &args, Xapian::timeout timeout=0)
Access to the remote database is done by running an external program
and communicating with it on stdin/stdout.
Parameters:
-----------
program: the external program to run.
args: space-separated list of arguments to pass to program.
timeout: timeout in milliseconds. If this timeout is exceeded for any
individual operation on the remote database then
Xapian::NetworkTimeoutError is thrown. (Default is 0, which means
don't timeout).
( R t remote_open_writable( R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR @ s t Queryc B s e Z d Z e d d d d Z e Z e j Z e j
Z e j Z
e j Z e j Z e j Z e j Z e j Z e j Z e j Z e j Z e j Z e j Z! e j" Z# e j$ Z% d Z& d Z' d Z( d Z) d Z* e+ e j, Z- d
Z. d Z/ RS( sY
Class representing a query.
Queries are represented as a tree of objects.
c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR ^ s c C s | j j | S( N( R R ( R5 R7 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR ^ s R8 s The membership flagc C s
t j | S( s
Get the length of the query, used by some ranking formulae.
Xapian::termcount Xapian::Query::get_length() const
This value is calculated automatically - if you want to override it
you can pass a different value to Enquire::set_query().
( R t Query_get_length( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt
get_lengtho s c C s
t j | S( s@
Return a Xapian::TermIterator returning all the terms in the query, in
order of termpos.
TermIterator Xapian::Query::get_terms_begin() const
If multiple terms have the same term position, their order is
unspecified. Duplicates (same term and termpos) will be removed.
( R t Query_get_terms_begin( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_terms_beginz s
c C s
t j | S( s
Return a Xapian::TermIterator to the end of the list of terms in the
query.
TermIterator Xapian::Query::get_terms_end() const
( R t Query_get_terms_end( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt
get_terms_end s c C s
t j | S( s
Test if the query is empty (i.e.
bool Xapian::Query::empty() const
was constructed using the default ctor or with an empty iterator
ctor).
( R t Query_empty( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR[ s c C s
t j | S( sI
Serialise query into a string.
std::string Xapian::Query::serialise() const
The query representation may change between Xapian releases: even
between minor versions. However, it is guaranteed not to change unless
the remote database protocol has also changed between releases.
( R t Query_serialise( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s
c C s
t j | S( sv
Return a string describing this object.
std::string Xapian::Query::get_description() const
( R t
Query___str__( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c G s t j | t j | d S( s9
Construct an external source query.
Xapian::Query::Query(Xapian::PostingSource *external_source)
An attempt to clone the posting source will be made immediately, so if
the posting source supports clone(), the source supplied may be safely
deallocated after this call. If the source does not support clone(),
the caller must ensure that the posting source remains valid until the
Query is deallocated.
Parameters:
-----------
external_source: The source to use in the query.
N( R t Query_swiginitt new_Query( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; s (0 R R- RI R= R R/ R+ R t Query_OP_ANDt OP_ANDt Query_OP_ORt OP_ORt Query_OP_AND_NOTt
OP_AND_NOTt Query_OP_XORt OP_XORt Query_OP_AND_MAYBEt OP_AND_MAYBEt Query_OP_FILTERt OP_FILTERt
Query_OP_NEARt OP_NEARt Query_OP_PHRASEt OP_PHRASEt Query_OP_VALUE_RANGEt OP_VALUE_RANGEt Query_OP_SCALE_WEIGHTt OP_SCALE_WEIGHTt Query_OP_ELITE_SETt OP_ELITE_SETt Query_OP_VALUE_GEt OP_VALUE_GEt Query_OP_VALUE_LEt OP_VALUE_LEt Query_OP_SYNONYMt
OP_SYNONYMt delete_QueryR? R R R R[ R R t Query_unserialiseR R R; ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR X s4 c G s
t j | S( N( R R ( R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s t Stopperc B sS e Z d Z e d d d d Z e Z e j Z d Z
d Z d Z RS( s5
Base class for stop-word decision functor.
c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c C s | j j | S( N( R R ( R5 R7 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s R8 s The membership flagc C s
t j | S( s
Return a string describing this object.
virtual std::string Xapian::Stopper::get_description() const
( R t Stopper___str__( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c C s; | j t k r d } n | } t j | t j | d S( N( R, R R R t Stopper_swiginitt new_Stopper( R R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; s c C s$ | j j t j | t | S( N( R R R t disown_StopperR ( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s
(
R R- RI R= R R/ R+ R t delete_StopperR? R R; R ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s t
SimpleStopperc B sJ e Z d Z e d d d d Z e Z d Z d Z e j
Z RS( sN
Simple implementation of Stopper class - this will suit most users.
c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c C s | j j | S( N( R R ( R5 R7 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s R8 s The membership flagc C s t j | t j d S( s
Initialise from a pair of iterators.
Xapian::SimpleStopper::SimpleStopper(Iterator begin, Iterator end)
N( R t SimpleStopper_swiginitt new_SimpleStopper( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; s c G s t j | | S( sl
Add a single stop word.
void Xapian::SimpleStopper::add(const std::string &word)
( R t SimpleStopper_add( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt add s ( R R- RI R= R R/ R+ R; R R t delete_SimpleStopperR? ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s t ValueRangeProcessorc B sJ e Z d Z e d d d d Z e Z e j Z d Z
d Z RS( s1
Base class for value range processors.
c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR
s c C s | j j | S( N( R R ( R5 R7 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR
s R8 s The membership flagc C s; | j t k r d } n | } t j | t j | d S( N( R, R R R t ValueRangeProcessor_swiginitt new_ValueRangeProcessor( R R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR;
s c C s$ | j j t j | t | S( N( R R R t disown_ValueRangeProcessorR ( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s
( R R- RI R= R R/ R+ R t delete_ValueRangeProcessorR? R; R ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s t StringValueRangeProcessorc B sA e Z d Z e d d d d Z e Z d Z e j Z
RS( sI
Handle a string range.
The end points can be any strings.
c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR ! s c C s | j j | S( N( R R ( R5 R7 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR ! s R8 s The membership flagc G s t j | t j | d S( s
Constructor.
Xapian::StringValueRangeProcessor::StringValueRangeProcessor(Xapian::valueno
slot_, const std::string &str_, bool prefix_=true)
Parameters:
-----------
slot_: The value number to return from operator().
str_: A string to look for to recognise values as belonging to this
range.
prefix_: Flag specifying whether to check for str_ as a prefix or a
suffix.
N( R t" StringValueRangeProcessor_swiginitt new_StringValueRangeProcessor( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; # s ( R R- RI R= R R/ R+ R; R t delete_StringValueRangeProcessorR? ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s
t DateValueRangeProcessorc B sA e Z d Z e d d d d Z e Z d Z e j Z
RS( sX
Handle a date range.
Begin and end must be dates in a recognised format.
c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR @ s c C s | j j | S( N( R R ( R5 R7 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR @ s R8 s The membership flagc G s t j | t j | d S( s
Constructor.
Xapian::DateValueRangeProcessor::DateValueRangeProcessor(Xapian::valueno
slot_, const char *str_, bool prefix_=true, bool prefer_mdy_=false,
int epoch_year_=1970)
This is like the previous version, but with const char * instead of
std::string - we need this overload as otherwise
DateValueRangeProcessor(1, "date:") quietly interprets the second
argument as a boolean in preference to std::string. If you want to be
compatible with 1.2.12 and earlier, then explicitly convert to
std::string, i.e.: DateValueRangeProcessor(1, std::string("date:"))
Parameters:
-----------
slot_: The value number to return from operator().
str_: A string to look for to recognise values as belonging to this
date range.
prefix_: Whether to look for the string at the start or end of the
values. If true, the string is a prefix; if false, the string is a
suffix (default: true).
prefer_mdy_: Should ambiguous dates be interpreted as month/day/year
rather than day/month/year? (default: false)
epoch_year_: Year to use as the epoch for dates with 2 digit years
(default: 1970, so 1/1/69 is 2069 while 1/1/70 is 1970).
The string supplied in str_ is used by operator() to decide whether
the pair of strings supplied to it constitute a valid range. If
prefix_ is true, the first value in a range must begin with str_ (and
the second value may optionally begin with str_); if prefix_ is false,
the second value in a range must end with str_ (and the first value
may optionally end with str_).
If str_ is empty, the setting of prefix_ is irrelevant, and no special
strings are required at the start or end of the strings defining the
range.
The remainder of both strings defining the endpoints must be valid
dates.
For example, if str_ is "created:" and prefix_ is true, and the
range processor has been added to the queryparser, the queryparser
will accept "created:1/1/2000..31/12/2001".
N( R t DateValueRangeProcessor_swiginitt new_DateValueRangeProcessor( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; B s 3( R R- RI R= R R/ R+ R; R t delete_DateValueRangeProcessorR? ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR : s
4t NumberValueRangeProcessorc B sA e Z d Z e d d d d Z e Z d Z e j Z
RS( s
Handle a number range.
This class must be used on values which have been encoded using
Xapian::sortable_serialise() which turns numbers into strings which
will sort in the same order as the numbers (the same values can be
used to implement a numeric sort).
c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c C s | j j | S( N( R R ( R5 R7 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s R8 s The membership flagc G s t j | t j | d S( s
Constructor.
Xapian::NumberValueRangeProcessor::NumberValueRangeProcessor(Xapian::valueno
slot_, const std::string &str_, bool prefix_=true)
Parameters:
-----------
slot_: The value number to return from operator().
str_: A string to look for to recognise values as belonging to this
numeric range.
prefix_: Whether to look for the string at the start or end of the
values. If true, the string is a prefix; if false, the string is a
suffix (default: true).
The string supplied in str_ is used by operator() to decide whether
the pair of strings supplied to it constitute a valid range. If
prefix_ is true, the first value in a range must begin with str_ (and
the second value may optionally begin with str_); if prefix_ is false,
the second value in a range must end with str_ (and the first value
may optionally end with str_).
If str_ is empty, the setting of prefix_ is irrelevant, and no special
strings are required at the start or end of the strings defining the
range.
The remainder of both strings defining the endpoints must be valid
floating point numbers. (FIXME: define format recognised).
For example, if str_ is "$" and prefix_ is true, and the range
processor has been added to the queryparser, the queryparser will
accept "$10..50" or "$10..$50", but not "10..50" or "10..$50"
as valid ranges. If str_ is "kg" and prefix_ is false, the
queryparser will accept "10..50kg" or "10kg..50kg", but not
"10..50" or "10kg..50" as valid ranges.
N( R t" NumberValueRangeProcessor_swiginitt new_NumberValueRangeProcessor( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; s (( R R- RI R= R R/ R+ R; R t delete_NumberValueRangeProcessorR? ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR z s
)t QueryParserc B sm e Z d Z e d d d d Z e Z e j Z e j
Z e j Z
e j Z e j Z e j Z e j Z e j Z e j Z e j Z e j Z e j Z e j Z! e j" Z# e j$ Z% e j& Z' d Z( e j) Z* d Z+ d Z, d d Z. d Z/ d
Z0 d Z1 d Z2 d
Z3 d Z4 d Z5 d Z6 d Z7 d Z8 d Z9 d Z: d Z; d Z< RS( sA
Build a Xapian::Query object from a user query string.
c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c C s | j j | S( N( R R ( R5 R7 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s R8 s The membership flagc C s t j | t j d S( sS
Default constructor.
Xapian::QueryParser::QueryParser()
N( R t QueryParser_swiginitt new_QueryParser( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; s c G s t j | | S( sV
Set the stemmer.
void Xapian::QueryParser::set_stemmer(const Xapian::Stem &stemmer)
This sets the stemming algorithm which will be used by the query
parser. Note that the stemming algorithm will only be used according
to the stemming strategy set by set_stemming_strategy(), which
defaults to STEM_NONE. Therefore, to use a stemming algorithm, you
will also need to call set_stemming_strategy() with a value other than
STEM_NONE.
Parameters:
-----------
stemmer: The Xapian::Stem object to set.
( R t QueryParser_set_stemmer( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt set_stemmer s c G s t j | | S( sA
Set the stemming strategy.
void Xapian::QueryParser::set_stemming_strategy(stem_strategy
strategy)
This controls how the query parser will apply the stemming algorithm.
Note that the stemming algorithm is only applied to words in
probabilistic fields - boolean filter terms are never stemmed.
Parameters:
-----------
strategy: The strategy to use - possible values are: STEM_NONE: Don't
perform any stemming. (default in Xapian <= 1.3.0)
STEM_SOME: Search for stemmed forms of terms except for those which
start with a capital letter, or are followed by certain characters
(currently: (/@<>=*[{" ), or are used with operators which need
positional information. Stemmed terms are prefixed with 'Z'. (default
in Xapian >= 1.3.1)
STEM_ALL: Search for stemmed forms of all words (note: no 'Z' prefix
is added).
STEM_ALL_Z: Search for stemmed forms of all words (note: 'Z' prefix is
added). (new in Xapian 1.2.11 and 1.3.1)
( R t! QueryParser_set_stemming_strategy( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt set_stemming_strategy s c C s t j | | S( s
Set the stopper.
void Xapian::QueryParser::set_stopper(const Stopper *stop=NULL)
Parameters:
-----------
stop: The Stopper object to set (default NULL, which means no
stopwords).
( R t QueryParser_set_stopper( R t stop( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt set_stopper s c G s t j | | S( s
Set the default operator.
void Xapian::QueryParser::set_default_op(Query::op default_op)
Parameters:
-----------
default_op: The operator to use to combine non-filter query items
when no explicit operator is used.
The most useful values for this are OP_OR (the default) and OP_AND.
OP_NEAR and OP_PHRASE can also be useful.
So for example, 'weather forecast' is parsed as if it were 'weather OR
forecast' by default.
( R t QueryParser_set_default_op( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt set_default_op s c C s
t j | S( ss
Get the current default operator.
Query::op Xapian::QueryParser::get_default_op() const
( R t QueryParser_get_default_op( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_default_op% s c G s t j | | S( s
Specify the database being searched.
void Xapian::QueryParser::set_database(const Database &db)
Parameters:
-----------
db: The database to use for wildcard expansion (FLAG_WILDCARD and
FLAG_PARTIAL), spelling correction (FLAG_SPELLING_CORRECTION), and
synonyms (FLAG_SYNONYM, FLAG_AUTO_SYNONYMS, and
FLAG_AUTO_MULTIWORD_SYNONYMS).
( R t QueryParser_set_database( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt set_database- s c G s t j | | S( s
Specify the maximum expansion of a wildcard term.
void Xapian::QueryParser::set_max_wildcard_expansion(Xapian::termcount
limit)
Note: you must also set FLAG_WILDCARD for wildcard expansion to
happen.
Parameters:
-----------
limit: The maximum number of terms each wildcard in the query can
expand to, or 0 for no limit (which is the default).
( R t& QueryParser_set_max_wildcard_expansion( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt set_max_wildcard_expansion= s c G s t j | | S( sR
Parse a query.
Query Xapian::QueryParser::parse_query(const std::string
&query_string, unsigned flags=FLAG_DEFAULT, const std::string
&default_prefix=std::string())
Parameters:
-----------
query_string: A free-text query as entered by a user
flags: Zero or more Query::feature_flag specifying what features the
QueryParser should support. Combine multiple values with bitwise-or
(|) (default FLAG_DEFAULT).
default_prefix: The default term prefix to use (default none). For
example, you can pass "A" when parsing an "Author" field.
Parameters:
-----------
If: the query string can't be parsed, then Xapian::QueryParserError
is thrown. You can get an English error message to report to the user
by catching it and calling get_msg() on the caught exception. The
current possible values (in case you want to translate them) are: @li
Unknown range operation @li parse error @li Syntax:
<expression> AND <expression> @li Syntax:
<expression> AND NOT <expression> @li Syntax:
<expression> NOT <expression> @li Syntax:
<expression> OR <expression> @li Syntax:
<expression> XOR <expression>
( R t QueryParser_parse_query( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt parse_queryO s "c G s t j | | S( s
Add a probabilistic term prefix.
void Xapian::QueryParser::add_prefix(const std::string &field, const
std::string &prefix)
For example:
This allows the user to search for author:Orwell which will be
converted to a search for the term "Aorwell".
Multiple fields can be mapped to the same prefix. For example, you can
make title: and subject: aliases for each other.
As of 1.0.4, you can call this method multiple times with the same
value of field to allow a single field to be mapped to multiple
prefixes. Multiple terms being generated for such a field, and
combined with Xapian::Query::OP_OR.
If any prefixes are specified for the empty field name (i.e. you call
this method with an empty string as the first parameter) these
prefixes will be used for terms without a field specifier. If you do
this and also specify the default_prefix parameter to parse_query(),
then the default_prefix parameter will override.
If the prefix parameter is empty, then "field:word" will produce the
term "word" (and this can be one of several prefixes for a
particular field, or for terms without a field specifier).
If you call add_prefix() and add_boolean_prefix() for the same value
of field, a Xapian::InvalidOperationError exception will be thrown.
In 1.0.3 and earlier, subsequent calls to this method with the same
value of field had no effect.
Parameters:
-----------
field: The user visible field name
prefix: The term prefix to map this to
( R t QueryParser_add_prefix( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt
add_prefixs s +c G s t j | | S( s
void
Xapian::QueryParser::add_boolean_prefix(const std::string &field,
const std::string &prefix)
( R t QueryParser_add_boolean_prefix( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt add_boolean_prefix s c C s
t j | S( s
Iterate over terms omitted from the query as stopwords.
TermIterator Xapian::QueryParser::stoplist_begin() const
( R t QueryParser_stoplist_begin( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt stoplist_begin s c C s
t j | S( s7 TermIterator Xapian::QueryParser::stoplist_end() const ( R t QueryParser_stoplist_end( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt stoplist_end s c G s t j | | S( s
Iterate over unstemmed forms of the given (stemmed) term used in the
query.
TermIterator Xapian::QueryParser::unstem_begin(const std::string
&term) const
( R t QueryParser_unstem_begin( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt unstem_begin s c G s t j | | S( sb
TermIterator
Xapian::QueryParser::unstem_end(const std::string &) const
( R t QueryParser_unstem_end( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt
unstem_end s c G s t j | | S( s
Register a ValueRangeProcessor.
void
Xapian::QueryParser::add_valuerangeprocessor(Xapian::ValueRangeProcessor
*vrproc)
( R t# QueryParser_add_valuerangeprocessor( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt add_valuerangeprocessor s c C s
t j | S( sM
Get the spelling-corrected query string.
std::string Xapian::QueryParser::get_corrected_query_string() const
This will only be set if FLAG_SPELLING_CORRECTION is specified when
QueryParser::parse_query() was last called.
If there were no corrections, an empty string is returned.
( R t& QueryParser_get_corrected_query_string( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_corrected_query_string s c C s
t j | S( s|
Return a string describing this object.
std::string Xapian::QueryParser::get_description() const
( R t QueryParser___str__( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s N(= R R- RI R= R R/ R+ R t QueryParser_FLAG_BOOLEANt FLAG_BOOLEANt QueryParser_FLAG_PHRASEt FLAG_PHRASEt QueryParser_FLAG_LOVEHATEt
FLAG_LOVEHATEt! QueryParser_FLAG_BOOLEAN_ANY_CASEt FLAG_BOOLEAN_ANY_CASEt QueryParser_FLAG_WILDCARDt
FLAG_WILDCARDt QueryParser_FLAG_PURE_NOTt
FLAG_PURE_NOTt QueryParser_FLAG_PARTIALt FLAG_PARTIALt$ QueryParser_FLAG_SPELLING_CORRECTIONt FLAG_SPELLING_CORRECTIONt QueryParser_FLAG_SYNONYMt FLAG_SYNONYMt QueryParser_FLAG_AUTO_SYNONYMSt FLAG_AUTO_SYNONYMSt( QueryParser_FLAG_AUTO_MULTIWORD_SYNONYMSt FLAG_AUTO_MULTIWORD_SYNONYMSt QueryParser_FLAG_DEFAULTt FLAG_DEFAULTt QueryParser_STEM_NONEt STEM_NONEt QueryParser_STEM_SOMEt STEM_SOMEt QueryParser_STEM_ALLt STEM_ALLt QueryParser_STEM_ALL_Zt
STEM_ALL_ZR; t delete_QueryParserR? R R R R R R R R R R R R R R R R R R ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR sL $ -
c G s
t j | S( N( R t sortable_serialise( R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c G s
t j | S( N( R t sortable_unserialise( R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s t StemImplementationc B sS e Z d Z e d d d d Z e Z e j Z d Z
d Z d Z RS( sB
Class representing a stemming algorithm implementation.
c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c C s | j j | S( N( R R ( R5 R7 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s R8 s The membership flagc C s
t j | S( s
Return a string describing this object.
virtual std::string Xapian::StemImplementation::get_description()
const =0
( R t StemImplementation___str__( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c C s; | j t k r d } n | } t j | t j | d S( N( R, R R R t StemImplementation_swiginitt new_StemImplementation( R R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; s c C s$ | j j t j | t | S( N( R R R t disown_StemImplementationR ( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s
(
R R- RI R= R R/ R+ R t delete_StemImplementationR? R R; R ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s t Stemc B sY e Z d Z e d d d d Z e Z d Z e j Z
d Z e e j
Z RS( s3
Class representing a stemming algorithm.
c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR # s c C s | j j | S( N( R R ( R5 R7 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR # s R8 s The membership flagc G s t j | t j | d S( sq
Construct a Xapian::Stem object with a user-provided stemming
algorithm.
Xapian::Stem::Stem(StemImplementation *p)
You can subclass Xapian::StemImplementation to implement your own
stemming algorithm (or to wrap a third-party algorithm) and then wrap
your implementation in a Xapian::Stem object to pass to the Xapian
API.
Parameters:
-----------
p: The user-subclassed StemImplementation object. This is reference
counted, and so will be automatically deleted by the Xapian::Stem
wrapper when no longer required.
N( R t
Stem_swiginitt new_Stem( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; % s c C s
t j | S( su
Return a string describing this object.
std::string Xapian::Stem::get_description() const
( R t Stem___str__( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR : s ( R R- RI R= R R/ R+ R; R t delete_StemR? R R t Stem_get_available_languagest get_available_languages( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c C s
t j S( N( R R# ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR# H s t
TermGeneratorc B s e Z d Z e d d d d Z e Z d Z e j Z
d Z d d Z
d Z d Z d
Z e j Z e j Z e j Z e j Z e j Z d Z d Z d
Z d Z d Z d d Z d Z! d Z" d Z# RS( s#
Parses a piece of text and generate terms.
This module takes a piece of text and parses it to produce words which
are then used to generate suitable terms for indexing. The terms
generated are suitable for use with Query objects produced by the
QueryParser class.
c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR U s c C s | j j | S( N( R R ( R5 R7 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR U s R8 s The membership flagc C s t j | t j d S( sW
Default constructor.
Xapian::TermGenerator::TermGenerator()
N( R t TermGenerator_swiginitt new_TermGenerator( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; W s c G s t j | | S( s
Set the Xapian::Stem object to be used for generating stemmed terms.
void Xapian::TermGenerator::set_stemmer(const Xapian::Stem &stemmer)
( R t TermGenerator_set_stemmer( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR _ s c C s t j | | S( s
Set the Xapian::Stopper object to be used for identifying stopwords.
void Xapian::TermGenerator::set_stopper(const Xapian::Stopper
*stop=NULL)
Stemmed forms of stopwords aren't indexed, but unstemmed forms still
are so that searches for phrases including stop words still work.
Parameters:
-----------
stop: The Stopper object to set (default NULL, which means no
stopwords).
( R t TermGenerator_set_stopper( R R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR h s c G s t j | | S( s{
Set the current document.
void Xapian::TermGenerator::set_document(const Xapian::Document &doc)
( R t TermGenerator_set_document( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt set_documentz s c C s
t j | S( sy
Get the current document.
const Xapian::Document& Xapian::TermGenerator::get_document() const
( R t TermGenerator_get_document( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyRl s c G s t j | | S( s
Set the database to index spelling data to.
void Xapian::TermGenerator::set_database(const
Xapian::WritableDatabase &db)
( R t TermGenerator_set_database( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c G s t j | | S( s
Set flags.
flags Xapian::TermGenerator::set_flags(flags toggle, flags
mask=flags(0))
The new value of flags is: (flags & mask) ^ toggle
To just set the flags, pass the new flags in toggle and the default
value for mask.
Parameters:
-----------
toggle: Flags to XOR.
mask: Flags to AND with first.
The old flags setting.
( R t TermGenerator_set_flags( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt set_flags s c G s t j | | S( s
Set the stemming strategy.
void Xapian::TermGenerator::set_stemming_strategy(stem_strategy
strategy)
This method controls how the stemming algorithm is applied. It was new
in Xapian 1.3.1.
Parameters:
-----------
strategy: The strategy to use - possible values are: STEM_NONE: Don't
perform any stemming - only unstemmed terms are generated.
STEM_SOME: Generate both stemmed (with a "Z" prefix) and unstemmed
terms. This is the default strategy.
STEM_ALL: Generate only stemmed terms (but without a "Z" prefix).
STEM_ALL_Z: Generate only stemmed terms (with a "Z" prefix).
( R t# TermGenerator_set_stemming_strategy( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c G s t j | | S( s
Set the maximum length word to index.
void Xapian::TermGenerator::set_max_word_length(unsigned
max_word_length)
The limit is on the length of a word prior to stemming and prior to
adding any term prefix.
The backends mostly impose a limit on the length of terms (often of
about 240 bytes), but it's generally useful to have a lower limit to
help prevent the index being bloated by useless junk terms from trying
to indexing things like binary data, uuencoded data, ASCII art, etc.
This method was new in Xapian 1.3.1.
Parameters:
-----------
max_word_length: The maximum length word to index, in bytes in UTF-8
representation. Default is 64.
( R t! TermGenerator_set_max_word_length( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt set_max_word_length s c G s t j | | S( s
Index some text in a std::string.
void Xapian::TermGenerator::index_text(const std::string &text,
Xapian::termcount wdf_inc=1, const std::string &prefix=std::string())
Parameters:
-----------
text: The text to index.
wdf_inc: The wdf increment (default 1).
prefix: The term prefix to use (default is no prefix).
( R t TermGenerator_index_text( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt
index_text s c G s t j | | S( s
Index some text in a std::string without positional information.
void Xapian::TermGenerator::index_text_without_positions(const
std::string &text, Xapian::termcount wdf_inc=1, const std::string
&prefix=std::string())
Just like index_text, but no positional information is generated. This
means that the database will be significantly smaller, but that phrase
searching and NEAR won't be supported.
Parameters:
-----------
text: The text to index.
wdf_inc: The wdf increment (default 1).
prefix: The term prefix to use (default is no prefix).
( R t* TermGenerator_index_text_without_positions( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt index_text_without_positions s id c C s t j | | S( s
Increase the term position used by index_text.
void Xapian::TermGenerator::increase_termpos(Xapian::termcount
delta=100)
This can be used between indexing text from different fields or other
places to prevent phrase searches from spanning between them (e.g.
between the title and body text, or between two chapters in a book).
Parameters:
-----------
delta: Amount to increase the term position by (default: 100).
( R t TermGenerator_increase_termpos( R t delta( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt increase_termpos s c C s
t j | S( sw
Get the current term position.
Xapian::termcount Xapian::TermGenerator::get_termpos() const
( R t TermGenerator_get_termpos( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt get_termpos s c G s t j | | S( s
Set the current term position.
void Xapian::TermGenerator::set_termpos(Xapian::termcount termpos)
Parameters:
-----------
termpos: The new term position to set.
( R t TermGenerator_set_termpos( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt set_termpos% s c C s
t j | S( s~
Return a string describing this object.
std::string Xapian::TermGenerator::get_description() const
( R t TermGenerator___str__( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR 2 s N($ R R- RI R= R R/ R+ R; R t delete_TermGeneratorR? R R R R+ Rl R t TermGenerator_FLAG_SPELLINGt
FLAG_SPELLINGt TermGenerator_STEM_NONER t TermGenerator_STEM_SOMER t TermGenerator_STEM_ALLR t TermGenerator_STEM_ALL_ZR R/ R R2 R4 R6 R9 R; R= R ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR% L s0
t KeyMakerc B sJ e Z d Z e d d d d Z e Z e j Z d Z
d Z RS( s6
Virtual base class for key making functors.
c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR O s c C s | j j | S( N( R R ( R5 R7 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR O s R8 s The membership flagc C s; | j t k r d } n | } t j | t j | d S( N( R, RF R R t KeyMaker_swiginitt new_KeyMaker( R R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; R s c C s$ | j j t j | t | S( N( R R R t disown_KeyMakerR ( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR X s
( R R- RI R= R R/ R+ R t delete_KeyMakerR? R; R ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyRF K s t MultiValueKeyMakerc B sJ e Z d Z e d d d d Z e Z d Z d Z e j
Z RS( sc
KeyMaker subclass which combines several values.
When the result is used for sorting, results are ordered by the first
value. In the event of a tie, the second is used. If this is the same
for both, the third is used, and so on. If reverse is true for a
value, then the sort order for that value is reversed.
When used for collapsing, the documents will only be considered equal
if all the values specified match. If none of the specified values are
set then the generated key will be empty, so such documents won't be
collapsed (which is consistent with the behaviour in the "collapse on
a value" case). If you'd prefer that documents with none of the keys
set are collapsed together, then you can set reverse for at least one
of the values. Other than this, it isn't useful to set reverse for
collapsing.
c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR r s c C s | j j | S( N( R R ( R5 R7 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR r s R8 s The membership flagc C s t j | t j d S( sg
Xapian::MultiValueKeyMaker::MultiValueKeyMaker(Iterator begin,
Iterator end)
N( R t MultiValueKeyMaker_swiginitt new_MultiValueKeyMaker( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; t s c G s t j | | S( sw
void
Xapian::MultiValueKeyMaker::add_value(Xapian::valueno slot, bool
reverse=false)
( R t MultiValueKeyMaker_add_value( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR z s ( R R- RI R= R R/ R+ R; R R t delete_MultiValueKeyMakerR? ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyRK ` s t Sorterc B sA e Z d Z e d d d d Z d Z e Z e j Z
RS( s1
Virtual base class for sorter functor.
c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c C s | j j | S( N( R R ( R5 R7 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s R8 s The membership flagc O s t d d S( Ns* No constructor defined - class is abstract( R ( R R9 R: ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; s ( R R- RI R= R R; R/ R+ R t
delete_SorterR? ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyRP s
t MultiValueSorterc B sJ e Z d Z e d d d d Z e Z d Z d Z e j
Z RS( sd
Sorter subclass which sorts by a several values.
Results are ordered by the first value. In the event of a tie, the
second is used. If this is the same for both, the third is used, and
so on.
Deprecated This class is deprecated - you should migrate to using
MultiValueKeyMaker instead. Note that MultiValueSorter::add() becomes
MultiValueKeyMaker::add_value(), but the sense of the direction flag
is reversed (to be consistent with Enquire::set_sort_by_value()).
So: MultiValueSorter sorter; // Primary ordering is forwards on
value 4. sorter.add(4); // Secondary ordering is reverse on value
5. sorter.add(5, false); becomes: MultiValueKeyMaker sorter; //
Primary ordering is forwards on value 4. sorter.add_value(4); //
Secondary ordering is reverse on value 5. sorter.add_value(5, true);
c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c C s | j j | S( N( R R ( R5 R7 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s R8 s The membership flagc C s t j | t j d S( sc
Xapian::MultiValueSorter::MultiValueSorter(Iterator begin, Iterator
end)
N( R t MultiValueSorter_swiginitt new_MultiValueSorter( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; s c G s t j | | S( sf
void
Xapian::MultiValueSorter::add(Xapian::valueno slot, bool forward=true)
( R t MultiValueSorter_add( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s ( R R- RI R= R R/ R+ R; R R t delete_MultiValueSorterR? ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyRR s t ValueSetMatchDeciderc B sS e Z d Z e d d d d Z e Z d Z d Z d Z e
j Z RS( sj
MatchDecider filtering results based on whether document values are in
a user- defined set.
c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c C s | j j | S( N( R R ( R5 R7 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s R8 s The membership flagc G s t j | t j | d S( s
Construct a ValueSetMatchDecider.
Xapian::ValueSetMatchDecider::ValueSetMatchDecider(Xapian::valueno
slot, bool inclusive_)
Parameters:
-----------
slot: The value slot number to look in.
inclusive_: If true, match decider accepts documents which have a
value in the specified slot which is a member of the test set; if
false, match decider accepts documents which do not have a value in
the specified slot.
N( R t ValueSetMatchDecider_swiginitt new_ValueSetMatchDecider( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; s c G s t j | | S( s
Add a value to the test set.
void Xapian::ValueSetMatchDecider::add_value(const std::string &value)
Parameters:
-----------
value: The value to add to the test set.
( R t ValueSetMatchDecider_add_value( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c G s t j | | S( s
Remove a value from the test set.
void Xapian::ValueSetMatchDecider::remove_value(const std::string
&value)
Parameters:
-----------
value: The value to remove from the test set.
( R t! ValueSetMatchDecider_remove_value( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s (
R R- RI R= R R/ R+ R; R R R t delete_ValueSetMatchDeciderR? ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyRW s
t Compactorc B s e Z d Z e d d d d Z e Z e j Z e j
Z e j Z
d Z e j Z d Z d Z d Z d Z d
Z d Z d Z d
Z d Z d Z RS( s<
Compact a database, or merge and compact several.
c C s
| j j S( N( R R ( R5 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c C s | j j | S( N( R R ( R5 R7 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s R8 s The membership flagc C s; | j t k r d } n | } t j | t j | d S( s Xapian::Compactor::Compactor() N( R, R] R R t Compactor_swiginitt
new_Compactor( R R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; s c G s t j | | S( s
Set the block size to use for tables in the output database.
void Xapian::Compactor::set_block_size(size_t block_size)
Parameters:
-----------
block_size: The block size to use. Valid block sizes are currently
powers of two between 2048 and 65536, with the default being 8192, but
the valid sizes and default may change in the future.
( R t Compactor_set_block_size( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt set_block_size s
c G s t j | | S( sf
Set whether to preserve existing document id values.
void Xapian::Compactor::set_renumber(bool renumber)
Parameters:
-----------
renumber: The default is true, which means that document ids will be
renumbered - currently by applying the same offset to all the document
ids in a particular source database.
If false, then the document ids must be unique over all source
databases. Currently the ranges of document ids in each source must
not overlap either, though this restriction may be removed in the
future.
( R t Compactor_set_renumber( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt set_renumber s c G s t j | | S( s
Set whether to merge postlists in multiple passes.
void Xapian::Compactor::set_multipass(bool multipass)
Parameters:
-----------
multipass: If true and merging more than 3 databases, merge the
postlists in multiple passes, which is generally faster but requires
more disk space for temporary files. By default we don't do this.
( R t Compactor_set_multipass( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt
set_multipass) s
c G s t j | | S( s
Set the compaction level.
void Xapian::Compactor::set_compaction_level(compaction_level
compaction)
Parameters:
-----------
compaction: Available values are: - Xapian::Compactor::STANDARD -
Don't split items unnecessarily. - Xapian::Compactor::FULL - Split
items whenever it saves space (the default). -
Xapian::Compactor::FULLER - Allow oversize items to save more space
(not recommended if you ever plan to update the compacted database).
( R t Compactor_set_compaction_level( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt set_compaction_level8 s c G s t j | | S( s
Set where to write the output.
void Xapian::Compactor::set_destdir(const std::string &destdir)
Parameters:
-----------
destdir: Output path. This can be the same as an input if that input
is a stub database (in which case the database(s) listed in the stub
will be compacted to a new database and then the stub will be
atomically updated to point to this new database).
( R t Compactor_set_destdir( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt set_destdirK s c G s t j | | S( s
Add a source database.
void Xapian::Compactor::add_source(const std::string &srcdir)
Parameters:
-----------
srcdir: The path to the source database to add.
( R t Compactor_add_source( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt
add_source[ s c C s
t j | S( sn
Perform the actual compaction/merging operation.
void Xapian::Compactor::compact()
( R t Compactor_compact( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt compacth s c G s t j | | S( s
Update progress.
virtual void Xapian::Compactor::set_status(const std::string &table,
const std::string &status)
Subclass this method if you want to get progress updates during
compaction. This is called for each table first with empty status, And
then one or more times with non-empty status.
The default implementation does nothing.
Parameters:
-----------
table: The table currently being compacted.
status: A status message.
( R t Compactor_set_status( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt
set_statusp s c G s t j | | S( sk
Resolve multiple user metadata entries with the same key.
virtual std::string
Xapian::Compactor::resolve_duplicate_metadata(const std::string &key,
size_t num_tags, const std::string tags[])
When merging, if the same user metadata key is set in more than one
input, then this method is called to allow this to be resolving in an
appropriate way.
The default implementation just returns tags[0].
For multipass this will currently get called multiple times for the
same key if there are duplicates to resolve in each pass, but this may
change in the future.
Parameters:
-----------
key: The metadata key with duplicate entries.
num_tags: How many tags there are.
tags: An array of num_tags strings containing the tags to merge.
( R t$ Compactor_resolve_duplicate_metadata( R R9 ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt resolve_duplicate_metadata s c C s$ | j j t j | t | S( N( R R R t disown_CompactorR ( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s
( R R- RI R= R R/ R+ R t Compactor_STANDARDt STANDARDt Compactor_FULLt FULLt Compactor_FULLERt FULLERR; t delete_CompactorR? Ra Rc Re Rg Ri Rk Rm Ro Rq R ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR] s$
s restructuredtext ent MSetItemc B s8 e Z d Z d Z d
Z d Z e e d d
Z RS( sR An item returned from iteration of the MSet.
The item supports access to the following attributes and properties:
- `docid`: The Xapian document ID corresponding to this MSet item.
- `weight`: The weight corresponding to this MSet item.
- `rank`: The rank of this MSet item. The rank is the position in the
total set of matching documents of this item. The highest document is
given a rank of 0. If the MSet did not start at the highest matching
document, because a non-zero 'start' parameter was supplied to
get_mset(), the first document in the MSet will have a rank greater than
0 (in fact, it will be equal to the value of 'start' supplied to
get_mset()).
- `percent`: The percentage score assigned to this MSet item.
- `document`: The document for this MSet item. This can be used to access
the document data, or any other information stored in the document (such
as term lists). It is lazily evaluated.
- `collapse_key`: The value of the key which was used for collapsing.
- `collapse_count`: An estimate of the number of documents that have been
collapsed into this one.
The collapse count estimate will always be less than or equal to the actual
number of other documents satisfying the match criteria with the same
collapse key as this document. If may be 0 even though there are other
documents with the same collapse key which satisfying the match criteria.
However if this method returns non-zero, there definitely are other such
documents. So this method may be used to inform the user that there are
"at least N other matches in this group", or to control whether to offer a
"show other documents in this group" feature (but note that it may not
offer it in every case where it would show other documents).
t _msett
_firstitemt docidt weightt rankt percentt collapse_keyt collapse_countt _documentc C s | | _ | j j | _ | j | _ | j | _ | j | _ | j | _
| j | _ | j
| _ d | _ d S( N( R{ RG R| R R} R R~ Rn R Ru R Rq R Rs R R R ( R t itert mset( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; s c C s> | j d k r7 | j j | j | j j | _ n | j S( N( R R R{ Rc R R| Rl ( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt
_get_document s (R8 s4 The document object corresponding to this MSet item.( s _msets
_firstitems docids weights ranks percents collapse_keys collapse_counts _document( R R- RI t __slots__R; R t propertyt document( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyRz s t MSetIterc B s8 e Z d Z d Z d Z d Z d Z d Z RS( s An iterator over the items in an MSet.
The iterator will return MSetItem objects, which will be evaluated lazily
where appropriate.
t _itert _endR{ c C s+ | j | _ | j | _ | | _ d S( N( R] R R_ R R{ ( R R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; s c C s | S( N( ( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR< s c C sE | j | j k r t n& t | j | j } | j j | Sd S( N( R R t
StopIterationRz R{ R ( R t r( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s
c C sE | j | j k r t n& t | j | j } t | j | Sd S( N( R R R Rz R{ R ( R R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt __next__ s
( s _iters _ends _mset( R R- RI R R; R< R R ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR s c C s
t | S( s Return an iterator over the MSet.
The iterator will return MSetItem objects, which will be evaluated lazily
where appropriate.
( R ( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt _mset_gen_iter s c C s
t j | S( N( R< RY ( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR " s c C sb | d k r | t | 7} n | d k s= | t | k rL t d n t | j | | S( s Get an item from the MSet.
The supplied index is relative to the start of the MSet, not the absolute
rank of the item.
Returns an MSetItem.
i s Mset index out of range( t lent
IndexErrorRz Rc ( R t index( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt
_mset_getitem$ s
t ESetItemc B s e Z d Z d Z d Z RS( s An item returned from iteration of the ESet.
The item supports access to the following attributes:
- `term`: The term corresponding to this ESet item.
- `weight`: The weight corresponding to this ESet item.
t termR~ c C s" | j | _ | j | _ d S( N( t get_termR R R~ ( R R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; E s ( s terms weight( R R- RI R R; ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR : s t ESetIterc B s8 e Z d Z d Z d Z d Z d Z d Z RS( s\ An iterator over the items in an ESet.
The iterator will return ESetItem objects.
R R c C s" | j | _ | j | _ d S( N( R] R R_ R ( R t eset( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR; P s c C s | S( N( ( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR< T s c C s? | j | j k r t n t | j } | j j | Sd S( N( R R R R R ( R R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR X s
c C s? | j | j k r t n t | j } t | j | Sd S( N( R R R R R ( R R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR a s
( s _iters _end( R R- RI R R; R< R R ( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR I s c C s
t | S( s[ Return an iterator over the ESet.
The iterator will return ESetItem objects.
( R ( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt _eset_gen_iterl s c C s
t j | S( N( Rx RY ( R ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyR u s t TermListItemc B sn e Z d Z d
Z d Z d Z e e d d Z d Z e e d d
Z d Z
e e
d d Z RS( s An item returned from iteration of a term list.
The item supports access to the following attributes and properties:
- `term`: The term corresponding to this TermListItem.
- `wdf`: The within document frequency of this term.
- `termfreq`: The number of documents in the collection which are indexed
by the term
- `positer`: An iterator over the positions which the term appears at in
the document. This is only available until the iterator which returned
this item next moves.
R R t _wdft _termfreqc C s | | _ | | _ d | _ d | _ | j t j k rK | j j | _ n | j t j k rr | j j
| _ n d d d d g } | j t j k r d | d R? R@ RA RB RC RD RE RF RG RH RI RJ RK RL RM RN RO RP RR RS RT RU RV RW RX RY RZ R[ R\ R] R^ t Database_swigregisterR` Rc Rd Re Rf Rg Ri Rj Rk Rl Rm Rn Ro Rp Rq Rr Rs Rt Ru Rv Rw Rx Ry Rz R{ R| R} R~ R t WritableDatabase_swigregistert DB_CREATE_OR_OPENt DB_CREATEt DB_CREATE_OR_OVERWRITEt DB_OPENR R R R R R R R R R R R R R R R R t Query_swigregisterR R t Stopper___call__R t Stopper_swigregisterR R R t SimpleStopper_swigregisterR t ValueRangeProcessor___call__t ValueRangeProcessor_swigregisterR t& StringValueRangeProcessor_swigregisterR t$ DateValueRangeProcessor_swigregisterR t& NumberValueRangeProcessor_swigregisterR R R R R R R R R R R R R R R R R R R R R R R R R R R R R R R R R R t QueryParser_swigregisterR R R t StemImplementation___call__R t StemImplementation_swigregisterR t
Stem___call__R! t Stem_swigregisterR# R% R( R) R* R+ R, R- R. R/ R0 R1 R2 R3 R4 R5 R6 R7 R9 R: R< R= R> t TermGenerator_swigregisterRF t KeyMaker___call__t KeyMaker_swigregisterRK RN t MultiValueKeyMaker_swigregisterRP t Sorter_swigregisterRR RU t MultiValueSorter_swigregisterRW RZ R[ t! ValueSetMatchDecider_swigregisterR] R` Ra Rb Rc Rd Re Rf Rg Rh Ri Rj Rk Rl Rm Rn Ro Rp Rq t Compactor_swigregistert
__docformat__Rz R R R< t __len__R t __getitem__t get_hitR R R R R R t matching_termsR R t alltermsR t termlistR t spellingsR t synonymsR t synonym_keysR t
metadata_keysR R t stoplistR t
unstemlistR t valuest
top_valuesR; R R R R R R R R R R R R R R R R R R R R R R R R R R R R t postlistR R t positionlistR R R R R t valuestreamR R
R R R
R t MatchAllt MatchNothingt __all__t dirt itemt
startswitht endswithR t tuple( ( ( s3 /usr/lib/python2.7/dist-packages/xapian/__init__.pyt
s
8
"
'
$
N
R
l
H
%
@
w
M
A
s
X
K
J
p
i
=
5
3
$
#
%
5
7& # vg
<E
= -