Interface for a parameterized instance of summarization. More...

Public Member Functions
virtual	~SummarizerFunctionInstanceInterface ()
	Destructor. More...

virtual void	addStringParameter (const std::string &name, const std::string &value)=0
	Add a named string value parameter. More...

virtual void	addNumericParameter (const std::string &name, const NumericVariant &value)=0
	Add a named numeric value parameter. More...

virtual void	defineResultName (const std::string &resultname, const std::string &itemname)=0
	Rename a specific result item with a hardcoded name to another name. More...

virtual std::vector< std::string >	getVariables () const =0
	Get the list of variables used by this function defined in the query with 'QueryInterface::setWeightingVariableValue( const std::string&, double)'. More...

virtual SummarizerFunctionContextInterface *	createFunctionContext (const StorageClientInterface storage_, MetaDataReaderInterface metadata_, const GlobalStatistics &stats) const =0
	Create an execution context for this summarization function instance. More...

virtual std::string	tostring () const =0
	Get a comma ',' separated list of the function parameters as assignments (e.g. name=value) More...

Detailed Description

Interface for a parameterized instance of summarization.

Constructor & Destructor Documentation

virtual strus::SummarizerFunctionInstanceInterface::~SummarizerFunctionInstanceInterface ( )

inlinevirtual

Destructor.

virtual void strus::SummarizerFunctionInstanceInterface::addNumericParameter	(	const std::string &	name,
		const NumericVariant &	value
	)

pure virtual

Add a named numeric value parameter.

Parameters

[in]	name	parameter name
[in]	value	parameter value

virtual void strus::SummarizerFunctionInstanceInterface::addStringParameter	(	const std::string &	name,
		const std::string &	value
	)

pure virtual

Add a named string value parameter.

Parameters

[in]	name	parameter name
[in]	value	parameter value

virtual SummarizerFunctionContextInterface* strus::SummarizerFunctionInstanceInterface::createFunctionContext	(	const StorageClientInterface *	storage_,
		MetaDataReaderInterface *	metadata_,
		const GlobalStatistics &	stats
	)		const

pure virtual

Create an execution context for this summarization function instance.

Parameters

[in]	storage_	storage interface for getting information for summarization (like for example document attributes)
[in]	metadata_	metadata interface for inspecting document meta data (like for example the document insertion date)
[in]	stats	global statistics for weighting

Returns: the execution context, the summarization function instance with its execution context (ownership to caller)

virtual void strus::SummarizerFunctionInstanceInterface::defineResultName	(	const std::string &	resultname,
		const std::string &	itemname
	)

pure virtual

Rename a specific result item with a hardcoded name to another name.

Parameters

[in]	resultname	the name assigned to it in the result
[in]	itemname	the internal hardcoded name of the item

virtual std::vector<std::string> strus::SummarizerFunctionInstanceInterface::getVariables ( ) const

pure virtual

Get the list of variables used by this function defined in the query with 'QueryInterface::setWeightingVariableValue( const std::string&, double)'.

virtual std::string strus::SummarizerFunctionInstanceInterface::tostring ( ) const

pure virtual

Get a comma ',' separated list of the function parameters as assignments (e.g. name=value)

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

/home/patrick/Projects/github/strus/include/strus/summarizerFunctionInstanceInterface.hpp