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

Defines the context for analyzing multi part documents, iterating on the sub documents defined, splitting them into normalized terms that can be fed to the strus IR engine. More...

#include <documentAnalyzerContextInterface.hpp>

Public Member Functions

virtual ~DocumentAnalyzerContextInterface ()
 Destructor. More...
 
virtual void putInput (const char *chunk, std::size_t chunksize, bool eof)=0
 Feed the analyzer with the next chunk of input to process. More...
 
virtual bool analyzeNext (analyzer::Document &doc)=0
 Analyze the next sub document from the input feeded with putInput(const char*,std::size_t) More...
 

Detailed Description

Defines the context for analyzing multi part documents, iterating on the sub documents defined, splitting them into normalized terms that can be fed to the strus IR engine.

Constructor & Destructor Documentation

virtual strus::DocumentAnalyzerContextInterface::~DocumentAnalyzerContextInterface ( )
inlinevirtual

Destructor.

Member Function Documentation

virtual bool strus::DocumentAnalyzerContextInterface::analyzeNext ( analyzer::Document doc)
pure virtual

Analyze the next sub document from the input feeded with putInput(const char*,std::size_t)

Parameters
[out]docthe analyzed sub document structure
Returns
true, if the next document could be fetched, false if more input has to be fed or no input left (EOF)
virtual void strus::DocumentAnalyzerContextInterface::putInput ( const char *  chunk,
std::size_t  chunksize,
bool  eof 
)
pure virtual

Feed the analyzer with the next chunk of input to process.

Parameters
[in]chunkpointer to input chunk to process
[in]chunksizesize of input chunk to process in bytes
[in]eoftrue, if this chunk fed is the last one in input

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