strus::MetaDataReaderInterface Class Reference

Interface for accessing meta data from a strus storage. More...

#include <metaDataReaderInterface.hpp>

Public Member Functions
virtual	~MetaDataReaderInterface ()
	Destructor. More...
virtual Index	elementHandle (const std::string &name_) const =0
	Get the handle for a table element addressed by name. More...
virtual Index	nofElements () const =0
	Get the number of columns in the meta data table. More...
virtual void	skipDoc (const Index &docno)=0
	Skip to the document number equal to 'docno'. More...
virtual NumericVariant	getValue (const Index &elementHandle_) const =0
	Get the value a table element. More...
virtual const char *	getType (const Index &elementHandle_) const =0
	Get the type name of a table element (internal representation) More...
virtual const char *	getName (const Index &elementHandle_) const =0
	Get the name of a table element. More...
virtual std::vector< std::string >	getNames () const =0
	Get the list of names of a table elements. More...

Detailed Description

Interface for accessing meta data from a strus storage.

Constructor & Destructor Documentation

virtual strus::MetaDataReaderInterface::~MetaDataReaderInterface ( )

inlinevirtual

Destructor.

Member Function Documentation

virtual Index strus::MetaDataReaderInterface::elementHandle ( const std::string &  name_ ) const

pure virtual

Get the handle for a table element addressed by name.

Parameters

[in]

name_

name of the element

Returns

return the element handle or -1 if not defined

Remarks

Element handles are numbered from 0 to N-1, where N is what nofElements() returns

virtual const char* strus::MetaDataReaderInterface::getName ( const Index &  elementHandle_ ) const

pure virtual

Get the name of a table element.

Parameters

[in]

elementHandle_

the handle for the element

Returns

return the table element name

virtual std::vector<std::string> strus::MetaDataReaderInterface::getNames ( ) const

pure virtual

Get the list of names of a table elements.

Returns

return the list of table element names

virtual const char* strus::MetaDataReaderInterface::getType ( const Index &  elementHandle_ ) const

pure virtual

Get the type name of a table element (internal representation)

Parameters

[in]

elementHandle_

the handle for the element

Returns

return the table element type name string

virtual NumericVariant strus::MetaDataReaderInterface::getValue ( const Index &  elementHandle_ ) const

pure virtual

Get the value a table element.

Parameters

[in]

elementHandle_

the handle for the element

Returns

return the element value as atomic variant (type depending on internal representation)

virtual Index strus::MetaDataReaderInterface::nofElements ( ) const

pure virtual

Get the number of columns in the meta data table.

Returns

return number of columns

Remarks

Element handles are numbered from 0 to N-1, where N is what nofElements() returns

virtual void strus::MetaDataReaderInterface::skipDoc ( const Index &  docno )

pure virtual

Skip to the document number equal to 'docno'.

Parameters

[in]

docno

document number

Remarks

an initialized record is created for the document if the meta data block for this document does not exist yet

---

The documentation for this class was generated from the following file:

• /home/patrick/Projects/github/strus/include/strus/metaDataReaderInterface.hpp