strus  0.17
Public Member Functions | List of all members
strus::StatisticsBuilderInterface Class Referenceabstract

Interface for a builder for a statistics message (distributed index) More...

#include <statisticsBuilderInterface.hpp>

Public Member Functions

virtual ~StatisticsBuilderInterface ()
 Destructor. More...
 
virtual void setNofDocumentsInsertedChange (int increment)=0
 Define the change of the number of document inserted. More...
 
virtual void addDfChange (const char *termtype, const char *termvalue, int increment)=0
 Add a message propagating a change in the df (document frequency) More...
 
virtual void start ()=0
 Mark the current state that can be restored with a rollback. More...
 
virtual void rollback ()=0
 Rollback to the last state marked with 'start()'. More...
 
virtual bool fetchMessage (const void *&blk, std::size_t &blksize)=0
 Get the packed statistics message. More...
 

Detailed Description

Interface for a builder for a statistics message (distributed index)

Constructor & Destructor Documentation

virtual strus::StatisticsBuilderInterface::~StatisticsBuilderInterface ( )
inlinevirtual

Destructor.

Member Function Documentation

virtual void strus::StatisticsBuilderInterface::addDfChange ( const char *  termtype,
const char *  termvalue,
int  increment 
)
pure virtual

Add a message propagating a change in the df (document frequency)

Parameters
[in]termtypetype of the term
[in]termvaluevalue of the term
[in]incrementpositive or negative (decrement) value of the local change of the document frequency
Returns
true on success, false in case of an error (memory allocation error)
virtual bool strus::StatisticsBuilderInterface::fetchMessage ( const void *&  blk,
std::size_t &  blksize 
)
pure virtual

Get the packed statistics message.

Parameters
[out]blkpointer to the message
[out]blksizesize of message blk in bytes
Returns
true, if there is a message returned to be sent, false if not or an error occurred
virtual void strus::StatisticsBuilderInterface::rollback ( )
pure virtual

Rollback to the last state marked with 'start()'.

virtual void strus::StatisticsBuilderInterface::setNofDocumentsInsertedChange ( int  increment)
pure virtual

Define the change of the number of document inserted.

Parameters
[in]incrementpositive or negative (decrement) value of the local change of the collection size
virtual void strus::StatisticsBuilderInterface::start ( )
pure virtual

Mark the current state that can be restored with a rollback.


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