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

Interface for the summarization execution context. More...

#include <summarizerFunctionContextInterface.hpp>

Public Member Functions

virtual ~SummarizerFunctionContextInterface ()
 Destructor. More...
 
virtual void addSummarizationFeature (const std::string &name_, PostingIteratorInterface *postingIterator_, const std::vector< SummarizationVariable > &variables_, double weight_, const TermStatistics &stats_)=0
 Add a sumarization feature that is subject of summarization to the execution context. More...
 
virtual void setVariableValue (const std::string &name, double value)=0
 Set the value of a query variable. More...
 
virtual std::vector
< SummaryElement
getSummary (const Index &docno)=0
 Get the summarization elements for one document. More...
 
virtual std::string debugCall (const Index &docno)=0
 Get debug info dumped as string of the summarization call for one document. More...
 

Detailed Description

Interface for the summarization execution context.

Constructor & Destructor Documentation

virtual strus::SummarizerFunctionContextInterface::~SummarizerFunctionContextInterface ( )
inlinevirtual

Destructor.

Member Function Documentation

virtual void strus::SummarizerFunctionContextInterface::addSummarizationFeature ( const std::string &  name_,
PostingIteratorInterface postingIterator_,
const std::vector< SummarizationVariable > &  variables_,
double  weight_,
const TermStatistics stats_ 
)
pure virtual

Add a sumarization feature that is subject of summarization to the execution context.

Parameters
[in]name_name of the summarization feature
[in]postingIterator_iterator on the matches of the summarization feature (ownership remains at caller)
[in]variables_list of variables attached to subexpressions of the matches (passed with postingIterator_)
[in]weight_weight of this summarization feature
[in]stats_global term statistics passed down with the query. If undefined, they can be defined by or estimated from the posting iterator data.
Remarks
Do call this method before calling getSummary the first time for not having incomplete results
virtual std::string strus::SummarizerFunctionContextInterface::debugCall ( const Index docno)
pure virtual

Get debug info dumped as string of the summarization call for one document.

Parameters
[in]docnodocument to get the summary debug info from
Returns
the debug info as string
virtual std::vector<SummaryElement> strus::SummarizerFunctionContextInterface::getSummary ( const Index docno)
pure virtual

Get the summarization elements for one document.

Parameters
[in]docnodocument to get the summary element from
Returns
the summarization elements
virtual void strus::SummarizerFunctionContextInterface::setVariableValue ( const std::string &  name,
double  value 
)
pure virtual

Set the value of a query variable.

Parameters
[in]namename of the variable
[in]valuevalue of the variable

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