CQFilter Class Reference

class for global query filters aka "query operators" More...

#include <QueryFilter.h>

Inheritance diagram for CQFilter:

Collaboration diagram for CQFilter:

Public Member Functions
CQFilter API
	CQFilter ()
	Default constructor. More...
virtual	~CQFilter ()
	Default destructor (empty) More...
virtual bool	CheckSatisfiable (CQueryCompiler *compiler, CQueryOptions *options)
	Run fast (un)satisfiability checks for filter before Compile() is called. Default just returns true. More...
virtual bool	Compile (CQueryCompiler *compiler, CQueryOptions *options)
	apply the filter to the given compiler More...
virtual CQFilter *	Clone ()
	clone this filter More...
virtual HitSortEnum	FilterType () const
	sort-type for this filter (if any) More...
ddcObject API
virtual string	toString (void)
	convert filter to a canonical string More...
virtual string	jsonClass (void)
Public Member Functions inherited from ddcObject
	ddcObject ()
	Default constructor. More...
virtual	~ddcObject ()
	virtual destructor does nothing More...
virtual ddcObjectList	Children () const
virtual void	DisownChildren ()
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
virtual string	toJson ()
virtual string	jsonData ()

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

Detailed Description

class for global query filters aka "query operators"

Constructor & Destructor Documentation

CQFilter()

CQFilter::CQFilter ( )

inline

Default constructor.

Referenced by Clone().

Here is the caller graph for this function:

~CQFilter()

virtual CQFilter::~CQFilter ( )

inlinevirtual

Default destructor (empty)

References CheckSatisfiable(), and Compile().

Here is the call graph for this function:

Member Function Documentation

CheckSatisfiable()

bool CQFilter::CheckSatisfiable ( CQueryCompiler *  compiler, CQueryOptions *  options  )

virtual

Run fast (un)satisfiability checks for filter before Compile() is called. Default just returns true.

Reimplemented in CQFHasFieldSet, CQFHasFieldRegex, and CQFHasFieldValue.

Referenced by CQFHasFieldValue::Clone(), CQFHasFieldRegex::Clone(), CQFHasFieldSet::Clone(), and ~CQFilter().

Here is the caller graph for this function:

Compile()

bool CQFilter::Compile ( CQueryCompiler *  compiler, CQueryOptions *  options  )

virtual

apply the filter to the given compiler

Reimplemented in CQFPrune, CQFHasFieldSet, CQFHasFieldRegex, CQFHasFieldValue, CQFHasField, CQFContextSort, CQFBiblSort, CQFRandomSort, CQFSizeSort, CQFDateSort, and CQFSort.

References errParseError.

Referenced by CQFDateSort::Clone(), CQFSizeSort::Clone(), CQFRandomSort::Clone(), CQFBiblSort::Clone(), CQFContextSort::Clone(), CQFHasField::Clone(), CQFHasFieldValue::Clone(), CQFHasFieldRegex::Clone(), CQFHasFieldSet::Clone(), CQFSort::FilterType(), and ~CQFilter().

Here is the caller graph for this function:

Clone()

virtual CQFilter* CQFilter::Clone ( )

inlinevirtual

clone this filter

Reimplemented in CQFPrune, CQFHasFieldSet, CQFHasFieldInfix, CQFHasFieldSuffix, CQFHasFieldPrefix, CQFHasFieldRegex, CQFHasFieldValue, CQFHasField, CQFContextSort, CQFBiblSort, CQFRandomSort, CQFSizeSort, CQFDateSort, CQFRankSort, and CQFSort.

References CQFilter().

Here is the call graph for this function:

FilterType()

virtual HitSortEnum CQFilter::FilterType ( ) const

inlinevirtual

sort-type for this filter (if any)

Reimplemented in CQFSort.

References NoSort, and toString().

Referenced by CQueryOptions::IsPruneFilter().

Here is the call graph for this function:

Here is the caller graph for this function:

toString()

virtual string CQFilter::toString ( void  )

inlinevirtual

convert filter to a canonical string

Reimplemented from ddcObject.

Reimplemented in CQFPrune, CQFHasField, CQFContextSort, CQFBiblSort, and CQFSort.

Referenced by CQFBiblSort::Clone(), CQFContextSort::Clone(), CQFHasField::Clone(), FilterType(), and CQFSort::FilterType().

Here is the caller graph for this function:

jsonClass()

virtual string CQFilter::jsonClass ( void  )

inlinevirtual

class-name for json strinfication

• default implementation returns C++ class name

Reimplemented from ddcObject.

Reimplemented in CQFPrune, CQFHasFieldSet, CQFHasFieldInfix, CQFHasFieldSuffix, CQFHasFieldPrefix, CQFHasFieldRegex, CQFHasFieldValue, CQFHasField, CQFContextSort, CQFBiblSort, CQFRandomSort, CQFSizeSort, CQFDateSort, CQFRankSort, and CQFSort.

---

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

• QueryFilter.h
• QueryFilter.cpp