Interface for accessing document attributes from a strus storage.
More...
#include <attributeReaderInterface.hpp>
Interface for accessing document attributes from a strus storage.
| virtual strus::AttributeReaderInterface::~AttributeReaderInterface |
( |
| ) |
|
|
inlinevirtual |
| virtual Index strus::AttributeReaderInterface::elementHandle |
( |
const char * |
name | ) |
const |
|
pure virtual |
Get the handle of an element addressed by its name.
- Parameters
-
| [in] | name | name of the element |
- Returns
- the element handle as number (count starting with 1) or 0 on error
| virtual std::vector<std::string> strus::AttributeReaderInterface::getNames |
( |
| ) |
const |
|
pure virtual |
Get the names of all attributes defined in the storage.
- Returns
- list of attribute names
- Note
- Returns the names of all attributes defined for any document, independent of the current document.
| virtual std::string strus::AttributeReaderInterface::getValue |
( |
const Index & |
elementHandle_ | ) |
const |
|
pure virtual |
Get the value of the attribute of the document in the current readed context – defined with skipDoc(const Index&)
- Parameters
-
| [in] | elementHandle_ | the handle of the element to retrieve |
- Returns
- the value of the element as string or an empty string if undefined
| virtual void strus::AttributeReaderInterface::skipDoc |
( |
const Index & |
docno | ) |
|
|
pure virtual |
Move the attribute reader context to a specific document.
- Parameters
-
| [in] | docno | the number of the document to move the context to |
The documentation for this class was generated from the following file:
