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

Interface for detecting patterns (structures formed by atomic tokens) in one document. More...

#include <patternMatcherContextInterface.hpp>

Public Member Functions

virtual ~PatternMatcherContextInterface ()
 Destructor. More...
 
virtual void putInput (const analyzer::PatternLexem &token)=0
 Feed the next input token. More...
 
virtual std::vector
< analyzer::PatternMatcherResult
fetchResults ()=0
 Get the list of matches detected in the current document. More...
 
virtual
analyzer::PatternMatcherStatistics 
getStatistics () const =0
 Get the statistics for global analysis. More...
 
virtual void reset ()=0
 Reset the pattern matching context for a reuse within another document or query. More...
 

Detailed Description

Interface for detecting patterns (structures formed by atomic tokens) in one document.

Constructor & Destructor Documentation

virtual strus::PatternMatcherContextInterface::~PatternMatcherContextInterface ( )
inlinevirtual

Destructor.

Member Function Documentation

virtual std::vector<analyzer::PatternMatcherResult> strus::PatternMatcherContextInterface::fetchResults ( )
pure virtual

Get the list of matches detected in the current document.

Returns
the list of matches
virtual analyzer::PatternMatcherStatistics strus::PatternMatcherContextInterface::getStatistics ( ) const
pure virtual

Get the statistics for global analysis.

Returns
the statistics data gathered during processing
virtual void strus::PatternMatcherContextInterface::putInput ( const analyzer::PatternLexem token)
pure virtual

Feed the next input token.

Parameters
[in]tokenthe token to feed
Remarks
The input terms must be fed in ascending order of 'ordpos'
virtual void strus::PatternMatcherContextInterface::reset ( )
pure virtual

Reset the pattern matching context for a reuse within another document or query.


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