CQCountKeyExpr Class Reference

#include <QCount.h>

Inheritance diagram for CQCountKeyExpr:

Collaboration diagram for CQCountKeyExpr:

Public Member Functions
	CQCountKeyExpr (const string &label="")
virtual	~CQCountKeyExpr ()
virtual bool	CanCountByFile () const
virtual bool	Compile (CQueryCompiler *compiler)
virtual string &	Evaluate (const CHit &Hit)
virtual string	toString ()
string	jsonClass ()
string	jsonData ()
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	Negated ()
	For sanity checks. Default just returns false. More...
virtual bool	Negate ()
	Toggle negation flag, returns new value. Default throws an exception. More...
virtual BYTE	GetMatchId () const
	Get current match-id (should return a nontrivial match-id if any was used, else 0; default just returns 0) More...
virtual BYTE	SetMatchId (BYTE matchId)
	Set match-id, returns new value. Default throws an exception. More...
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

Additional Inherited Members
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

runtime count-key expression base class

Constructor & Destructor Documentation

CQCountKeyExpr()

CQCountKeyExpr::CQCountKeyExpr ( const string &  label = "" )

inline

default constructor

~CQCountKeyExpr()

virtual CQCountKeyExpr::~CQCountKeyExpr ( )

inlinevirtual

clear default destuctor

Member Function Documentation

CanCountByFile()

virtual bool CQCountKeyExpr::CanCountByFile ( ) const

inlinevirtual

returns true iff this expression can count at the file-level; default returns true

Reimplemented in CQCountKeyExprList, CQCountKeyExprToken, and CQCountKeyExprRegex.

Referenced by CQCountKeyExprRegex::CanCountByFile().

Here is the caller graph for this function:

Compile()

bool CQCountKeyExpr::Compile ( CQueryCompiler *  compiler )

virtual

compile the expression relative to a CQueryCompiler and its associated index

Reimplemented from CQuery.

Reimplemented in CQCountKeyExprList, CQCountKeyExprToken, CQCountKeyExprRegex, CQCountKeyExprBibl, CQCountKeyExprDateSlice, CQCountKeyExprDate, and CQCountKeyExprIndexed.

Referenced by CQCountKeyExprIndexed::Compile().

Here is the caller graph for this function:

Evaluate()

string & CQCountKeyExpr::Evaluate ( const CHit &  Hit )

virtual

get string key for the hit Hit ; default just throws an exception

Reimplemented in CQCountKeyExprList, CQCountKeyExprToken, CQCountKeyExprRegex, CQCountKeyExprBibl, CQCountKeyExprDateSlice, CQCountKeyExprDate, CQCountKeyExprFileName, CQCountKeyExprFileId, and CQCountKeyExprConstant.

References errRuntime, and Format().

Here is the call graph for this function:

toString()

virtual string CQCountKeyExpr::toString ( void  )

inlinevirtual

stringification (default returns m_Label)

Reimplemented from CQuery.

Reimplemented in CQCountKeyExprList, CQCountKeyExprToken, CQCountKeyExprRegex, CQCountKeyExprBibl, CQCountKeyExprDateSlice, and CQCountKeyExprConstant.

jsonClass()

string CQCountKeyExpr::jsonClass ( void  )

inlinevirtual

json stringification: class

Reimplemented from CQuery.

Reimplemented in CQCountKeyExprList, CQCountKeyExprToken, CQCountKeyExprRegex, CQCountKeyExprBibl, CQCountKeyExprDateSlice, CQCountKeyExprDate, CQCountKeyExprFileName, CQCountKeyExprIndexed, CQCountKeyExprFileId, and CQCountKeyExprConstant.

jsonData()

string CQCountKeyExpr::jsonData ( void  )

inlinevirtual

json stringification: data

Reimplemented from CQuery.

Reimplemented in CQCountKeyExprList, CQCountKeyExprToken, CQCountKeyExprRegex, and CQCountKeyExprDateSlice.

References jsonStr().

Referenced by CQCountKeyExprDateSlice::jsonData().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• QCount.h
• QCount.cpp