single-token query: expanded using CTermExpander.h interface More...

#include <Query.h>

Inheritance diagram for CQTokInfl:

[legend]

Collaboration diagram for CQTokInfl:

[legend]

Public Member Functions
	CQTokInfl (const string &indexName=string(""), const string &value=string(""), const vector< string > expanders=vector< string >())

	CQTokInfl (const string &indexName=string(""), const set< string > &values=set< string >(), const vector< string > expanders=vector< string >())

virtual	~CQTokInfl ()

TxChain &	GetChain (void)

virtual const char *	OperatorKey (void) const
	Compilation utility: return query-operator key for use with CConcIndexator::m_OpDefaultIndexNames. More...

virtual bool	Create (CQueryTokenNode *pNode)

virtual string	ValueString (void)
	ValueString() returns "@{" + SetValueString() + "}". More...

virtual string	ExpanderString (void)
	Stringification utility: returns string "%X1%X2%X3..." for m_Expanders. More...

virtual string	ExpanderJson (void)

virtual string	jsonClass ()

virtual string	jsonValue ()
	json stringification utility More...

virtual string	jsonData ()

Public Member Functions inherited from CQTokSet
	CQTokSet (const string &indexName=string(""), const string &rawValue=string(""), const set< string > &values=set< string >())

virtual	~CQTokSet ()

string	SetValueString (const set< string > &values)
	utility for use by subclasses: comma-separated list of strings in values More...

string	SetValueString (void)
	wrapper for SetValueString(m_Values) More...

string	jsonValues (void)
	wrapper for jsonArray(m_Values) More...

Public Member Functions inherited from CQToken
	CQToken (const string &indexName=string(""), const string &value=string(""), const BYTE matchId=0)

virtual	~CQToken ()

virtual BYTE	GetMatchId () const
	get local match-id More...

virtual BYTE	SetMatchId (BYTE matchId)
	Set match-id, returns new value. Override sets m_MatchId. More...

virtual bool	Compile (CQueryCompiler *compiler)
	Compile query. Default implementation just calls CQueryTokenNode::CreateStringPattern(m_IndexName,m_Value) More...

string	IndexName (const string &DefaultIndexName=string(""))
	Compilation utility: get long index name (requires non-NULL compiler), empty string is returned if not found. More...

string	BreakName (const string &DefaultBreakName=string(""))
	Compilation utility: get long break name (requires non-NULL compiler), empty string is returned if not found. More...

virtual string	IndexString (void)
	Stringification utility for use by subclasses; returns string "$INDEX=" or empty. More...

virtual string	MatchIdString (void)
	Stringification utility for use by subclasses; default should be sensible. More...

virtual string	toString (void)
	Default stringification: NegString(IndexString() + ValueString()) More...

Public Member Functions inherited from CQAtomic
	CQAtomic (const string &label=string(""), bool negated=false)
	Default constructor. More...

virtual	~CQAtomic ()

Public Member Functions inherited from CQNegatable
	CQNegatable (const string &label=string(""), bool negated=false)
	Default constructor. More...

	CQNegatable (bool negated)

virtual	~CQNegatable ()

virtual bool	Negate (void)
	toggle negation flag; returns new value More...

virtual bool	Negated ()
	override returns current value of m_Negated More...

virtual string	NegString (const std::string &s)
	string creation utility More...

Public Member Functions inherited from CQuery
	CQuery (const string &label=string(""))
	Default constructor. More...

virtual	~CQuery (void)

virtual bool	CheckSatisfiable (CQueryCompiler *compiler)

virtual bool	CompileOptions (CQueryCompiler *compiler=NULL)

virtual void	Evaluate ()

virtual bool	HasMatchId () const
	Returns true iff this query uses a nontrival match-id operator; default checks (this->GetMatchId() != 0) More...

virtual bool	RootOK ()
	Is this query an admissible root of a compiled parse tree (default returns !this->Negated()) More...

virtual ddcObjectList	Children () const

virtual void	DisownChildren ()

virtual string	optionsToString ()
	DEBUG: return canonical option string More...

virtual string	optionsToJson ()
	return json format option string More...

virtual string	toJson ()

void	SetCompiler (CQueryCompiler *compiler)

virtual void	ClearNode ()
	deletes m_Node if non-NULL More...

virtual void	ClearOptions ()
	deletes m_Options if non-NULL More...

virtual void	Clear (bool deep=true)
	clear query contents. if `deep` is true, propagates operation to daughters More...

virtual void	SetOptions (CQueryOptions *opts)
	set global query options ; deletes any pre-existing m_Options More...

Public Member Functions inherited from ddcObject
	ddcObject ()
	Default constructor. More...

virtual	~ddcObject ()
	virtual destructor does nothing More...

template<typename Visit >
ddcObject *	Traverse (Visit &visit)

template<typename Visit >
ddcObject *	Traverse (Visit &visit) const

template<typename Visit >
ddcObject *	TraverseR (Visit &visit)

template<typename Visit >
ddcObject *	TraverseR (Visit &visit) const

virtual ddcObjectList	Descendants () const

Public Attributes
vector< string >	m_Expanders
	expansion chain labels (empty list uses default expander for current index or identity) More...

TxChain	m_Txc
	expansion chain; see TermExpander.h More...

Public Attributes inherited from CQTokSet
set< string >	m_Values
	set of user-specified target forms More...

Public Attributes inherited from CQToken
string	m_IndexName
	name of index to be queried (default="" (->"Token")) More...

string	m_Value
	value to be searched for (default="") More...

BYTE	m_MatchId

Public Attributes inherited from CQNegatable
bool	m_Negated
	whether this query is negated More...

Public Attributes inherited from CQuery
string	m_Label
	arbitrary name for this query node (e.g. string from which it was parsed) More...

CQueryCompiler *	m_Compiler
	associated query compiler (only set on Compile()) More...

CQueryNode *	m_Node
	underlying CQueryNode (DDC-v1.x API) More...

CQueryOptions *	m_Options
	root-level options (root queries only) More...

Public Attributes inherited from ddcObject
void *	m_User
	user data associated with this object (for use e.g. by perl wrappers) More...

Detailed Description

single-token query: expanded using CTermExpander.h interface

Constructor & Destructor Documentation

◆ CQTokInfl() [1/2]

CQTokInfl::CQTokInfl	(	const string &	indexName = `string("")`,
		const string &	value = `string("")`,
		const vector< string >	expanders = `vector<string>()`
	)

inline

◆ CQTokInfl() [2/2]

CQTokInfl::CQTokInfl	(	const string &	indexName = `string("")`,
		const set< string > &	values = `set<string>()`,
		const vector< string >	expanders = `vector<string>()`
	)

inline

◆ ~CQTokInfl()

virtual CQTokInfl::~CQTokInfl ( )

inlinevirtual

Member Function Documentation

◆ GetChain()

TxChain & CQTokInfl::GetChain ( void )

utility gets expansion chain for m_Expanders in m_Txc; requires non-NULL m_Compiler

if m_Expanders is empty, uses default expansion chain for index, or identity expander if none is defined
an empty string in m_Expanders likewise corresponds to the default expansion chain
throws an exception if an otherwise unknown expander is referenced
returns m_Txc (by reference)

References errParseError, TxDispatcher::get(), CConcSession::GetTxDispatcher(), CQuery::m_Compiler, CQueryCompiler::m_pHolder, and CQuery::toString().

Here is the call graph for this function:

◆ OperatorKey()

virtual const char* CQTokInfl::OperatorKey ( void ) const

inlinevirtual

Compilation utility: return query-operator key for use with CConcIndexator::m_OpDefaultIndexNames.

Reimplemented from CQTokSet.

◆ Create()

bool CQTokInfl::Create ( CQueryTokenNode * pNode )

virtual

Compilation utility called by default Compile() method

SetCompiler() has already been called when this method runs
pNode = this->m_Node is the local CQueryTokenNode created for this query
default implementation just calls pNode->CreateStringPattern(m_IndexName,m_Value)

Reimplemented from CQTokSet.

Reimplemented in CQTokSetInfl.

References CQueryTokenNode::CreateSetPattern(), CQuery::m_Compiler, and CQueryCompiler::m_pHolder.

Here is the call graph for this function:

◆ ValueString()

string CQTokInfl::ValueString ( void )

virtual

ValueString() returns "@{" + SetValueString() + "}".

Reimplemented from CQTokSet.

Reimplemented in CQTokSetInfl.

References CQToken::ValueString().

Here is the call graph for this function:

◆ ExpanderString()

string CQTokInfl::ExpanderString ( void )

virtual

Stringification utility: returns string "%X1%X2%X3..." for m_Expanders.

References sqString().

Here is the call graph for this function:

◆ ExpanderJson()

string CQTokInfl::ExpanderJson ( void )

virtual

References jsonStr().

Here is the call graph for this function:

◆ jsonClass()

virtual string CQTokInfl::jsonClass ( void )

inlinevirtual

class-name for json strinfication

default implementation returns C++ class name

Reimplemented from CQTokSet.

Reimplemented in CQTokSetInfl.

◆ jsonValue()

virtual string CQTokInfl::jsonValue ( void )

inlinevirtual

json stringification utility

Reimplemented from CQTokSet.

Reimplemented in CQTokSetInfl.

References CQuery::jsonData(), and CQToken::jsonValue().

Here is the call graph for this function:

◆ jsonData()

string CQTokInfl::jsonData ( void )

virtual

instance data for json stringification

default implementation returns "NODATA":1, for strict syntax compliance

Reimplemented from CQToken.

References CQToken::jsonData().

Here is the call graph for this function:

Member Data Documentation

◆ m_Expanders

vector<string> CQTokInfl::m_Expanders

expansion chain labels (empty list uses default expander for current index or identity)

◆ m_Txc

TxChain CQTokInfl::m_Txc

expansion chain; see TermExpander.h

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

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CQTokInfl() [1/2]

◆ CQTokInfl() [2/2]

◆ ~CQTokInfl()

Member Function Documentation

◆ GetChain()

◆ OperatorKey()

◆ Create()

◆ ValueString()

◆ ExpanderString()

◆ ExpanderJson()

◆ jsonClass()

◆ jsonValue()

◆ jsonData()

Member Data Documentation

◆ m_Expanders

◆ m_Txc