Query evaluation program object representing an information retrieval scheme for documents in a storage. More...

#include <bindingObjects.hpp>

Public Member Functions
	QueryEval (const QueryEval &o)
	Copy constructor. More...

	~QueryEval ()
	Destructor. More...

void	addTerm (const String &set_, const String &type_, const String &value_)
	Declare a term that is used in the query evaluation as structural element without beeing part of the query (for example punctuation used for match fields summarization) More...

void	addSelectionFeature (const String &set_)
	Declare a feature set to be used as selecting feature. More...

void	addRestrictionFeature (const String &set_)
	Declare a feature set to be used as restriction. More...

void	addExclusionFeature (const String &set_)
	Declare a feature set to be used as exclusion. More...

void	addSummarizer (const String &name, const SummarizerConfig &config)
	Declare a summarizer. More...

void	addWeightingFunction (const String &name, const WeightingConfig &config)
	Add a weighting function to use as summand of the total document weight. More...

void	addWeightingFormula (const String &source, const FunctionVariableConfig &defaultParameter)
	Add a weighting formula to use for calculating the total weight from the weighting function results. More...

Query	createQuery (const StorageClient &storage) const
	Create a query to instantiate based on this query evaluation scheme. More...

Friends
class	Context
	Constructor used by Context. More...

class	Query

Detailed Description

Query evaluation program object representing an information retrieval scheme for documents in a storage.

Constructor & Destructor Documentation

strus::QueryEval::QueryEval ( const QueryEval & o )

Copy constructor.

strus::QueryEval::~QueryEval ( )

inline

Destructor.

Member Function Documentation

void strus::QueryEval::addExclusionFeature ( const String & set_ )

Declare a feature set to be used as exclusion.

Parameters

[in] set_ identifier of the term set addressing the terms to use as exclusion

void strus::QueryEval::addRestrictionFeature ( const String & set_ )

Declare a feature set to be used as restriction.

Parameters

[in] set_ identifier of the term set addressing the terms to use as restriction

void strus::QueryEval::addSelectionFeature ( const String & set_ )

Declare a feature set to be used as selecting feature.

Parameters

[in] set_ identifier of the term set addressing the terms to use for selection

void strus::QueryEval::addSummarizer	(	const String &	name,
		const SummarizerConfig &	config
	)

Declare a summarizer.

Parameters

[in]	name	the name of the summarizer to add
[in]	config	the configuration of the summarizer to add

void strus::QueryEval::addTerm	(	const String &	set_,
		const String &	type_,
		const String &	value_
	)

Declare a term that is used in the query evaluation as structural element without beeing part of the query (for example punctuation used for match fields summarization)

Parameters

[in]	set_	identifier of the term set that is used to address the terms
[in]	type_	feature type of the of the term
[in]	value_	feature value of the of the term

void strus::QueryEval::addWeightingFormula	(	const String &	source,
		const FunctionVariableConfig &	defaultParameter
	)

Add a weighting formula to use for calculating the total weight from the weighting function results.

Parameters

[in] defaultParameter default parameter values

void strus::QueryEval::addWeightingFunction	(	const String &	name,
		const WeightingConfig &	config
	)

Add a weighting function to use as summand of the total document weight.

Parameters

[in]	name	the name of the weighting function to add
[in]	config	the configuration of the function to add

Query strus::QueryEval::createQuery ( const StorageClient & storage ) const

Create a query to instantiate based on this query evaluation scheme.

Parameters

[in] storage storage to execute the query on

Friends And Related Function Documentation

friend class Context

friend

Constructor used by Context.

friend class Query

friend

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

/home/patrick/Projects/github/strusBindings/include/strus/bindingObjects.hpp

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation