ddc: CRunQueryData Class Reference

ddc

#include <BranchServer.h>

Collaboration diagram for CRunQueryData:

Collaboration graph

[legend]

Public Member Functions
	CRunQueryData (const string &_Query="", const string &_ResultFormat="JSON", size_t _Start=0, size_t _Limit=10, int _TimeOut=10, string *_pErrorStr=NULL)

virtual	~CRunQueryData ()

void	Init (const string &_Query="", const string &_ResultFormat="JSON", size_t _Start=0, size_t _Limit=10, int _TimeOut=10, string *_pErrorStr=NULL, const string &_ReqPath="", const NavHint &_Hint=NavHint())

void	Clear ()

CQuery *	Query () const

CQueryOptions *	QueryOptions () const

bool	IsPruneQuery () const

void	toString (string &Response, size_t WorkerId=0, const DDCVersionT &vCompat=DDCVersion)

Public Attributes
string	sQuery
	query string More...

string	sResultFormat
	result format (string) More...

size_t	StartHitNo
	first hit to return More...

size_t	ResultLimit
	max number of hits to return More...

int	TimeOut
	query timeout (seconds) More...

int	iInternalError
	internal error code More...

int	iNetworkError
	network error code More...

size_t	EndHitNo
	final hit number returned More...

size_t	HitsCount
	total number of hits More...

size_t	RelevantDocsCount
	? More...

CSelectedHosts	SelectedHosts
	maps immediate subcorpora to selected sub-subcorpora More...

string	HitDistrib
	? More...

string	DocDistrib
	? More...

string	HitsKey
	key for response body data (json only) More...

string	ResponseBody
	response body data More...

string *	pErrorStr
	error string pointer (empty or NULL for success) More...

string	ReqPath
	request path (>=v2.2.8) More...

NavHintKey	navKey
	navigation hint key More...

NavHint	navHint
	user- or cache-supplied navigation hint More...

CQueryCompiler *	pQCompiler
	query compiler for parsing input queries (parsed query is pQCompiler->m_pQuery) More...

Detailed Description

DDC branch server 'run_query' paramter & intermediate result-type

Constructor & Destructor Documentation

◆ CRunQueryData()

CRunQueryData::CRunQueryData	(	const string &	_Query = `""`,
		const string &	_ResultFormat = `"JSON"`,
		size_t	_Start = `0`,
		size_t	_Limit = `10`,
		int	_TimeOut = `10`,
		string *	_pErrorStr = `NULL`
	)

constructor

References pQCompiler, sQuery, sResultFormat, and Trim().

Here is the call graph for this function:

◆ ~CRunQueryData()

CRunQueryData::~CRunQueryData ( )

virtual

destructor

References pQCompiler.

Member Function Documentation

◆ Init()

void CRunQueryData::Init	(	const string &	_Query = `""`,
		const string &	_ResultFormat = `"JSON"`,
		size_t	_Start = `0`,
		size_t	_Limit = `10`,
		int	_TimeOut = `10`,
		string *	_pErrorStr = `NULL`,
		const string &	_ReqPath = `""`,
		const NavHint &	_Hint = `NavHint()`
	)

(re-)initialize with parameters

References NavHintKey::assign(), Clear(), errParseError, iInternalError, navHint, navKey, CQueryCompiler::ParseQuery(), pErrorStr, pQCompiler, ReqPath, ResultLimit, sQuery, sResultFormat, StartHitNo, TimeOut, and Trim().

Referenced by CDDCBranchServer::handle__get_first_hits(), CDDCBranchServer::handle__run_query(), and CDDCBranchServer::RunDistributed().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Clear()

void CRunQueryData::Clear ( )

clear object

References CQueryCompiler::CleanParser(), NavHintKey::clear(), NavHint::clear(), CSelectedHosts::Clear(), ClearString(), DocDistrib, EndHitNo, errNone, HitDistrib, HitsCount, HitsKey, iInternalError, iNetworkError, navHint, navKey, neSuccess, pErrorStr, pQCompiler, RelevantDocsCount, ReqPath, ResponseBody, ResultLimit, SelectedHosts, sQuery, sResultFormat, StartHitNo, and TimeOut.

Referenced by Init().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Query()

CQuery* CRunQueryData::Query ( ) const

inline

convenience method for accessing compiled query

References CQueryCompiler::m_pQuery.

◆ QueryOptions()

CQueryOptions* CRunQueryData::QueryOptions ( ) const

inline

convenience method for accessing compiled query

Referenced by CDDCBranchServer::ReadSelectedHosts(), and CDDCBranchServer::RunGetFirstHits().

Here is the caller graph for this function:

◆ IsPruneQuery()

bool CRunQueryData::IsPruneQuery ( ) const

inline

is this a prune-query?

References DDCVersion().

Referenced by CDDCBranchServer::handle__get_hit_strings(), CDDCBranchServer::RunDistributed(), and CDDCBranchServer::RunGetFirstHits().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toString()

void CRunQueryData::toString	(	string &	Response,
		size_t	WorkerId = `0`,
		const DDCVersionT &	vCompat = `DDCVersion`
	)

populate response string Response

References DDC_ResultJson, DocDistrib, EndHitNo, Format(), CConcSession::GetResultFormatByString(), HitDistrib, HitsCount, HitsKey, iInternalError, iNetworkError, jsonStr(), navHint, pErrorStr, RelevantDocsCount, ResponseBody, sResultFormat, and NavHint::toString().

Referenced by CDDCBranchServer::handle__run_query().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ sQuery

string CRunQueryData::sQuery

query string

Referenced by Clear(), CRunQueryData(), CDDCBranchServer::handle__run_query(), Init(), and CDDCBranchServer::ReadSelectedHosts().

◆ sResultFormat

string CRunQueryData::sResultFormat

result format (string)

Referenced by Clear(), CRunQueryData(), CDDCBranchServer::handle__get_hit_strings(), Init(), CDDCBranchServer::RunDistributed(), and toString().

◆ StartHitNo

size_t CRunQueryData::StartHitNo

first hit to return

Referenced by Clear(), CDDCBranchServer::GetHitContexts(), CDDCBranchServer::GetHitCounts(), CDDCBranchServer::handle__get_first_hits(), CDDCBranchServer::handle__get_hit_strings(), Init(), CDDCBranchServer::RunDistributed(), and CDDCBranchServer::RunGetFirstHits().

◆ ResultLimit

size_t CRunQueryData::ResultLimit

max number of hits to return

Referenced by Clear(), CDDCBranchServer::GetFirstHitsFromCorpora(), CDDCBranchServer::GetHitContexts(), CDDCBranchServer::GetHitCounts(), CDDCBranchServer::handle__get_first_hits(), CDDCBranchServer::handle__get_hit_strings(), Init(), CDDCBranchServer::RunDistributed(), and CDDCBranchServer::RunGetFirstHits().

◆ TimeOut

int CRunQueryData::TimeOut

query timeout (seconds)

Referenced by Clear(), CDDCBranchServer::GetFirstHitsFromCorpora(), CDDCBranchServer::handle__get_hit_strings(), Init(), CDDCBranchServer::RunDistributed(), and CDDCBranchServer::RunGetFirstHits().

◆ iInternalError

int CRunQueryData::iInternalError

internal error code

Referenced by Clear(), CDDCBranchServer::GetFirstHitsFromCorpora(), CDDCBranchServer::GetHitStringsFromOneCorpus(), CDDCBranchServer::handle__get_hit_strings(), Init(), CDDCBranchServer::RunDistributed(), CDDCBranchServer::RunGetFirstHits(), and toString().

◆ iNetworkError

int CRunQueryData::iNetworkError

network error code

Referenced by Clear(), CDDCBranchServer::handle__get_hit_strings(), CDDCBranchServer::RunDistributed(), CDDCBranchServer::RunGetFirstHits(), and toString().

◆ EndHitNo

size_t CRunQueryData::EndHitNo

final hit number returned

Referenced by Clear(), CDDCBranchServer::GetFirstHitsFromCorpora(), CDDCBranchServer::handle__get_first_hits(), CDDCBranchServer::handle__get_hit_strings(), CDDCBranchServer::RunDistributed(), CDDCBranchServer::RunGetFirstHits(), and toString().

◆ HitsCount

size_t CRunQueryData::HitsCount

total number of hits

Referenced by Clear(), CDDCBranchServer::handle__get_hit_strings(), CDDCBranchServer::RunDistributed(), CDDCBranchServer::RunGetFirstHits(), and toString().

◆ RelevantDocsCount

size_t CRunQueryData::RelevantDocsCount

?

Referenced by Clear(), CDDCBranchServer::RunDistributed(), CDDCBranchServer::RunGetFirstHits(), and toString().

◆ SelectedHosts

CSelectedHosts CRunQueryData::SelectedHosts

maps immediate subcorpora to selected sub-subcorpora

Referenced by Clear(), CDDCBranchServer::handle__get_hit_strings(), CDDCBranchServer::ReadSelectedHosts(), CDDCBranchServer::RunDistributed(), CDDCBranchServer::RunGetFirstHits(), and CDDCBranchServer::UpdateNavCache().

◆ HitDistrib

string CRunQueryData::HitDistrib

?

Referenced by Clear(), CDDCBranchServer::handle__get_hit_strings(), CDDCBranchServer::RunDistributed(), and toString().

◆ DocDistrib

string CRunQueryData::DocDistrib

?

Referenced by Clear(), CDDCBranchServer::handle__get_hit_strings(), CDDCBranchServer::RunDistributed(), and toString().

◆ HitsKey

string CRunQueryData::HitsKey

key for response body data (json only)

Referenced by Clear(), CDDCLeafServer::GetHitContexts(), CDDCLeafServer::GetHitCounts(), CDDCBranchServer::handle__get_hit_strings(), CDDCBranchServer::RunDistributed(), and toString().

◆ ResponseBody

string CRunQueryData::ResponseBody

response body data

Referenced by Clear(), CDDCLeafServer::GetHitContexts(), CDDCLeafServer::GetHitCounts(), CDDCBranchServer::handle__get_hit_strings(), CDDCBranchServer::RunDistributed(), CDDCBranchServer::RunGetFirstHits(), and toString().

◆ pErrorStr

string* CRunQueryData::pErrorStr

error string pointer (empty or NULL for success)

Referenced by Clear(), Init(), and toString().

◆ ReqPath

string CRunQueryData::ReqPath

request path (>=v2.2.8)

Referenced by CDDCBranchServer::AlignCorpusPath(), Clear(), CDDCBranchServer::GetFirstHitsFromCorpora(), and Init().

◆ navKey

NavHintKey CRunQueryData::navKey

navigation hint key

Referenced by Clear(), CDDCBranchServer::GetHitContexts(), Init(), CDDCBranchServer::RunGetFirstHits(), and CDDCBranchServer::UpdateNavCache().

◆ navHint

NavHint CRunQueryData::navHint

user- or cache-supplied navigation hint

Referenced by Clear(), CDDCBranchServer::GetFirstHitsFromCorpora(), CDDCBranchServer::GetHitContexts(), CDDCBranchServer::handle__get_hit_strings(), Init(), CDDCBranchServer::RunDistributed(), CDDCBranchServer::RunGetFirstHits(), toString(), and CDDCBranchServer::UpdateNavCache().

◆ pQCompiler

CQueryCompiler* CRunQueryData::pQCompiler

query compiler for parsing input queries (parsed query is pQCompiler->m_pQuery)

Referenced by Clear(), CRunQueryData(), Init(), CDDCBranchServer::ReadSelectedHosts(), and ~CRunQueryData().

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