File: annotated.html

package info (click to toggle)
xapian-core 1.2.12-2%2Bdeb7u1
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 19,180 kB
  • sloc: cpp: 100,708; sh: 11,201; ansic: 8,177; makefile: 813; perl: 758; python: 40
file content (152 lines) | stat: -rw-r--r-- 21,180 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Xapian: API Documentation: xapian-core: Class List</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#ffffff">
<!-- Generated by Doxygen 1.5.9 -->
<script type="text/javascript">
<!--
function changeDisplayState (e){
  var num=this.id.replace(/[^[0-9]/g,'');
  var button=this.firstChild;
  var sectionDiv=document.getElementById('dynsection'+num);
  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
    sectionDiv.style.display='block';
    button.src='open.gif';
  }else{
    sectionDiv.style.display='none';
    button.src='closed.gif';
  }
}
function initDynSections(){
  var divs=document.getElementsByTagName('div');
  var sectionCounter=1;
  for(var i=0;i<divs.length-1;i++){
    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
      var header=divs[i];
      var section=divs[i+1];
      var button=header.firstChild;
      if (button!='IMG'){
        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
        button=document.createElement('img');
        divs[i].insertBefore(button,divs[i].firstChild);
      }
      header.style.cursor='pointer';
      header.onclick=changeDisplayState;
      header.id='dynheader'+sectionCounter;
      button.src='closed.gif';
      section.id='dynsection'+sectionCounter;
      section.style.display='none';
      section.style.marginLeft='14px';
      sectionCounter++;
    }
  }
}
window.onload = initDynSections;
-->
</script>
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li class="current"><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>Class List</h1>Here are the classes, structs, unions and interfaces with brief descriptions:<table>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1AssertionError.html">Xapian::AssertionError</a></td><td class="indexvalue"><a class="el" href="classXapian_1_1AssertionError.html" title="AssertionError is thrown if a logical assertion inside Xapian fails.">AssertionError</a> is thrown if a logical assertion inside <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> fails </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1BM25Weight.html">Xapian::BM25Weight</a></td><td class="indexvalue"><a class="el" href="classXapian_1_1Weight.html" title="Abstract base class for weighting schemes.">Xapian::Weight</a> subclass implementing the BM25 probabilistic formula </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1BoolWeight.html">Xapian::BoolWeight</a></td><td class="indexvalue">Class implementing a "boolean" weighting scheme </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1Compactor.html">Xapian::Compactor</a></td><td class="indexvalue">Compact a database, or merge and compact several </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1Database.html">Xapian::Database</a></td><td class="indexvalue">This class is used to access a database, or a group of databases </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1DatabaseCorruptError.html">Xapian::DatabaseCorruptError</a></td><td class="indexvalue"><a class="el" href="classXapian_1_1DatabaseCorruptError.html" title="DatabaseCorruptError indicates database corruption was detected.">DatabaseCorruptError</a> indicates database corruption was detected </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1DatabaseCreateError.html">Xapian::DatabaseCreateError</a></td><td class="indexvalue"><a class="el" href="classXapian_1_1DatabaseCreateError.html" title="DatabaseCreateError indicates a failure to create a database.">DatabaseCreateError</a> indicates a failure to create a database </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1DatabaseError.html">Xapian::DatabaseError</a></td><td class="indexvalue"><a class="el" href="classXapian_1_1DatabaseError.html" title="DatabaseError indicates some sort of database related error.">DatabaseError</a> indicates some sort of database related error </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1DatabaseLockError.html">Xapian::DatabaseLockError</a></td><td class="indexvalue"><a class="el" href="classXapian_1_1DatabaseLockError.html" title="DatabaseLockError indicates failure to lock a database.">DatabaseLockError</a> indicates failure to lock a database </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1DatabaseModifiedError.html">Xapian::DatabaseModifiedError</a></td><td class="indexvalue"><a class="el" href="classXapian_1_1DatabaseModifiedError.html" title="DatabaseModifiedError indicates a database was modified.">DatabaseModifiedError</a> indicates a database was modified </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1DatabaseOpeningError.html">Xapian::DatabaseOpeningError</a></td><td class="indexvalue"><a class="el" href="classXapian_1_1DatabaseOpeningError.html" title="DatabaseOpeningError indicates failure to open a database.">DatabaseOpeningError</a> indicates failure to open a database </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1DatabaseVersionError.html">Xapian::DatabaseVersionError</a></td><td class="indexvalue"><a class="el" href="classXapian_1_1DatabaseVersionError.html" title="DatabaseVersionError indicates that a database is in an unsupported format.">DatabaseVersionError</a> indicates that a database is in an unsupported format </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1DateValueRangeProcessor.html">Xapian::DateValueRangeProcessor</a></td><td class="indexvalue">Handle a date range </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1DecreasingValueWeightPostingSource.html">Xapian::DecreasingValueWeightPostingSource</a></td><td class="indexvalue">Read weights from a value which is known to decrease as docid increases </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1DocNotFoundError.html">Xapian::DocNotFoundError</a></td><td class="indexvalue">Indicates an attempt to access a document not present in the database </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1Document.html">Xapian::Document</a></td><td class="indexvalue">A handle representing a document in a <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> database </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1Enquire.html">Xapian::Enquire</a></td><td class="indexvalue">This class provides an interface to the information retrieval system for the purpose of searching </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1Error.html">Xapian::Error</a></td><td class="indexvalue">All exceptions thrown by <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> are subclasses of <a class="el" href="classXapian_1_1Error.html" title="All exceptions thrown by Xapian are subclasses of Xapian::Error.">Xapian::Error</a> </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1ErrorHandler.html">Xapian::ErrorHandler</a></td><td class="indexvalue">Decide if a <a class="el" href="classXapian_1_1Error.html" title="All exceptions thrown by Xapian are subclasses of Xapian::Error.">Xapian::Error</a> exception should be ignored </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1ESet.html">Xapian::ESet</a></td><td class="indexvalue">Class representing an ordered set of expand terms (an <a class="el" href="classXapian_1_1ESet.html" title="Class representing an ordered set of expand terms (an ESet).">ESet</a>) </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1ESetIterator.html">Xapian::ESetIterator</a></td><td class="indexvalue">Iterate through terms in the <a class="el" href="classXapian_1_1ESet.html" title="Class representing an ordered set of expand terms (an ESet).">ESet</a> </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1ExpandDecider.html">Xapian::ExpandDecider</a></td><td class="indexvalue">Virtual base class for expand decider functor </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1ExpandDeciderAnd.html">Xapian::ExpandDeciderAnd</a></td><td class="indexvalue"><a class="el" href="classXapian_1_1ExpandDecider.html" title="Virtual base class for expand decider functor.">ExpandDecider</a> subclass which rejects terms using two ExpandDeciders </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1ExpandDeciderFilterTerms.html">Xapian::ExpandDeciderFilterTerms</a></td><td class="indexvalue"><a class="el" href="classXapian_1_1ExpandDecider.html" title="Virtual base class for expand decider functor.">ExpandDecider</a> subclass which rejects terms in a specified list </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1FeatureUnavailableError.html">Xapian::FeatureUnavailableError</a></td><td class="indexvalue">Indicates an attempt to use a feature which is unavailable </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1FixedWeightPostingSource.html">Xapian::FixedWeightPostingSource</a></td><td class="indexvalue">A posting source which returns a fixed weight for all documents </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1InternalError.html">Xapian::InternalError</a></td><td class="indexvalue"><a class="el" href="classXapian_1_1InternalError.html" title="InternalError indicates a runtime problem of some sort.">InternalError</a> indicates a runtime problem of some sort </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1InvalidArgumentError.html">Xapian::InvalidArgumentError</a></td><td class="indexvalue"><a class="el" href="classXapian_1_1InvalidArgumentError.html" title="InvalidArgumentError indicates an invalid parameter value was passed to the API.">InvalidArgumentError</a> indicates an invalid parameter value was passed to the API </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1InvalidOperationError.html">Xapian::InvalidOperationError</a></td><td class="indexvalue"><a class="el" href="classXapian_1_1InvalidOperationError.html" title="InvalidOperationError indicates the API was used in an invalid way.">InvalidOperationError</a> indicates the API was used in an invalid way </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1KeyMaker.html">Xapian::KeyMaker</a></td><td class="indexvalue">Virtual base class for key making functors </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1LogicError.html">Xapian::LogicError</a></td><td class="indexvalue">The base class for exceptions indicating errors in the program logic </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1MatchDecider.html">Xapian::MatchDecider</a></td><td class="indexvalue">Base class for matcher decision functor </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1MatchSpy.html">Xapian::MatchSpy</a></td><td class="indexvalue">Abstract base class for match spies </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1MSet.html">Xapian::MSet</a></td><td class="indexvalue">A match set (<a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a>) </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1MSetIterator.html">Xapian::MSetIterator</a></td><td class="indexvalue">An iterator pointing to items in an <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a> </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1MultiValueKeyMaker.html">Xapian::MultiValueKeyMaker</a></td><td class="indexvalue"><a class="el" href="classXapian_1_1KeyMaker.html" title="Virtual base class for key making functors.">KeyMaker</a> subclass which combines several values </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1MultiValueSorter.html">Xapian::MultiValueSorter</a></td><td class="indexvalue"><a class="el" href="classXapian_1_1Sorter.html" title="Virtual base class for sorter functor.">Sorter</a> subclass which sorts by a several values </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1NetworkError.html">Xapian::NetworkError</a></td><td class="indexvalue">Indicates a problem communicating with a remote database </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1NetworkTimeoutError.html">Xapian::NetworkTimeoutError</a></td><td class="indexvalue">Indicates a timeout expired while communicating with a remote database </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1NumberValueRangeProcessor.html">Xapian::NumberValueRangeProcessor</a></td><td class="indexvalue">Handle a number range </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1PositionIterator.html">Xapian::PositionIterator</a></td><td class="indexvalue">An iterator pointing to items in a list of positions </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1PostingIterator.html">Xapian::PostingIterator</a></td><td class="indexvalue">An iterator pointing to items in a list of postings </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1PostingSource.html">Xapian::PostingSource</a></td><td class="indexvalue">Base class which provides an "external" source of postings </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1Query.html">Xapian::Query</a></td><td class="indexvalue">Class representing a query </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1QueryParser.html">Xapian::QueryParser</a></td><td class="indexvalue">Build a <a class="el" href="classXapian_1_1Query.html" title="Class representing a query.">Xapian::Query</a> object from a user query string </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1QueryParserError.html">Xapian::QueryParserError</a></td><td class="indexvalue">Indicates a query string can't be parsed </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1RangeError.html">Xapian::RangeError</a></td><td class="indexvalue"><a class="el" href="classXapian_1_1RangeError.html" title="RangeError indicates an attempt to access outside the bounds of a container.">RangeError</a> indicates an attempt to access outside the bounds of a container </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1Registry.html">Xapian::Registry</a></td><td class="indexvalue"><a class="el" href="classXapian_1_1Registry.html" title="Registry for user subclasses.">Registry</a> for user subclasses </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1RSet.html">Xapian::RSet</a></td><td class="indexvalue">A relevance set (R-Set) </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1RuntimeError.html">Xapian::RuntimeError</a></td><td class="indexvalue">The base class for exceptions indicating errors only detectable at runtime </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1SerialisationError.html">Xapian::SerialisationError</a></td><td class="indexvalue">Indicates an error in the std::string serialisation of an object </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1SimpleStopper.html">Xapian::SimpleStopper</a></td><td class="indexvalue">Simple implementation of <a class="el" href="classXapian_1_1Stopper.html" title="Base class for stop-word decision functor.">Stopper</a> class - this will suit most users </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1Sorter.html">Xapian::Sorter</a></td><td class="indexvalue">Virtual base class for sorter functor </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1Stem.html">Xapian::Stem</a></td><td class="indexvalue">Class representing a stemming algorithm </td></tr>
  <tr><td class="indexkey"><a class="el" href="structXapian_1_1StemImplementation.html">Xapian::StemImplementation</a></td><td class="indexvalue">Class representing a stemming algorithm implementation </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1Stopper.html">Xapian::Stopper</a></td><td class="indexvalue">Base class for stop-word decision functor </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1StringValueRangeProcessor.html">Xapian::StringValueRangeProcessor</a></td><td class="indexvalue">Handle a string range </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1TermGenerator.html">Xapian::TermGenerator</a></td><td class="indexvalue">Parses a piece of text and generate terms </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1TermIterator.html">Xapian::TermIterator</a></td><td class="indexvalue">An iterator pointing to items in a list of terms </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1TradWeight.html">Xapian::TradWeight</a></td><td class="indexvalue"><a class="el" href="classXapian_1_1Weight.html" title="Abstract base class for weighting schemes.">Xapian::Weight</a> subclass implementing the traditional probabilistic formula </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1UnimplementedError.html">Xapian::UnimplementedError</a></td><td class="indexvalue"><a class="el" href="classXapian_1_1UnimplementedError.html" title="UnimplementedError indicates an attempt to use an unimplemented feature.">UnimplementedError</a> indicates an attempt to use an unimplemented feature </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1Utf8Iterator.html">Xapian::Utf8Iterator</a></td><td class="indexvalue">An iterator which returns <a class="el" href="namespaceXapian_1_1Unicode.html" title="Functions associated with handling Unicode characters.">Unicode</a> character values from a UTF-8 encoded string </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1ValueCountMatchSpy.html">Xapian::ValueCountMatchSpy</a></td><td class="indexvalue">Class for counting the frequencies of values in the matching documents </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1ValueIterator.html">Xapian::ValueIterator</a></td><td class="indexvalue">Class for iterating over document values </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1ValueMapPostingSource.html">Xapian::ValueMapPostingSource</a></td><td class="indexvalue">A posting source which looks up weights in a map using values as the key </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1ValuePostingSource.html">Xapian::ValuePostingSource</a></td><td class="indexvalue">A posting source which generates weights from a value slot </td></tr>
  <tr><td class="indexkey"><a class="el" href="structXapian_1_1ValueRangeProcessor.html">Xapian::ValueRangeProcessor</a></td><td class="indexvalue">Base class for value range processors </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1ValueSetMatchDecider.html">Xapian::ValueSetMatchDecider</a></td><td class="indexvalue"><a class="el" href="classXapian_1_1MatchDecider.html" title="Base class for matcher decision functor.">MatchDecider</a> filtering results based on whether document values are in a user-defined set </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1ValueWeightPostingSource.html">Xapian::ValueWeightPostingSource</a></td><td class="indexvalue">A posting source which reads weights from a value slot </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1Weight.html">Xapian::Weight</a></td><td class="indexvalue">Abstract base class for weighting schemes </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXapian_1_1WritableDatabase.html">Xapian::WritableDatabase</a></td><td class="indexvalue">This class provides read/write access to a database </td></tr>
</table>
</div>
<hr>
<address><small>
Documentation for Xapian (version 1.2.12).<br>
Generated on 27 Jun 2012 by
<a href="http://www.doxygen.org/">Doxygen 1.5.9</a>.
</small></address>
</body>
</html>