Implements browsing the documents of a storage without weighting query, just with a restriction on metadata.
More...
#include <bindingObjects.hpp>
Implements browsing the documents of a storage without weighting query, just with a restriction on metadata.
net::strus::api::DocumentBrowser::DocumentBrowser |
( |
const DocumentBrowser & |
o | ) |
|
net::strus::api::DocumentBrowser::~DocumentBrowser |
( |
| ) |
|
|
inline |
void net::strus::api::DocumentBrowser::addMetaDataRestrictionCondition |
( |
const char * |
compareOp, |
|
|
const String & |
name, |
|
|
double |
value, |
|
|
bool |
newGroup |
|
) |
| |
Define a meta data restriction condition on the documents visited.
- Parameters
-
[in] | compareOp | compare operator, one of "=","!=",">=","<=","<",">" |
[in] | name | of the meta data field (left side of comparison operator) |
[in] | value | numeric value to compare with the meta data field (right side of comparison operator) |
[in] | newGroup | true, if the restriction is not an alternative condition to the previous one defined (alternative conditions are evaluated as logical OR) |
void net::strus::api::DocumentBrowser::addMetaDataRestrictionCondition |
( |
const char * |
compareOp, |
|
|
const String & |
name, |
|
|
unsigned int |
value, |
|
|
bool |
newGroup |
|
) |
| |
Define a meta data restriction condition on the documents visited.
- Parameters
-
[in] | compareOp | compare operator, one of "=","!=",">=","<=","<",">" |
[in] | name | of the meta data field (left side of comparison operator) |
[in] | value | numeric value to compare with the meta data field (right side of comparison operator) |
[in] | newGroup | true, if the restriction is not an alternative condition to the previous one defined (alternative conditions are evaluated as logical OR) |
void net::strus::api::DocumentBrowser::addMetaDataRestrictionCondition |
( |
const char * |
compareOp, |
|
|
const String & |
name, |
|
|
int |
value, |
|
|
bool |
newGroup |
|
) |
| |
Define a meta data restriction condition on the documents visited.
- Parameters
-
[in] | compareOp | compare operator, one of "=","!=",">=","<=","<",">" |
[in] | name | of the meta data field (left side of comparison operator) |
[in] | value | numeric value to compare with the meta data field (right side of comparison operator) |
[in] | newGroup | true, if the restriction is not an alternative condition to the previous one defined (alternative conditions are evaluated as logical OR) |
String net::strus::api::DocumentBrowser::attribute |
( |
const String & |
name | ) |
|
Get an attribute of the current document visited.
- Returns
- the internal document number or 0, if there is no one left
Index net::strus::api::DocumentBrowser::skipDoc |
( |
const Index & |
docno_ | ) |
|
Get the internal document number of the next document bigger or equal the document number passed.
- Parameters
-
[in] | docno_ | document number to get the matching least upperbound from |
- Returns
- the internal document number
The documentation for this class was generated from the following file: