ddc
Public Member Functions | List of all members
CQTokSuffix Class Reference

single-token query: suffix (left-truncated) query *SUFFIX More...

#include <Query.h>

Inheritance diagram for CQTokSuffix:
Inheritance graph
[legend]
Collaboration diagram for CQTokSuffix:
Collaboration graph
[legend]

Public Member Functions

 CQTokSuffix (const string &indexName=string(""), const string &suffix=string(""))
 
virtual ~CQTokSuffix ()
 
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 ()
 Stringification utility for use by subclasses; default returns sqString(m_Value) More...
 
virtual string jsonClass ()
 
- 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...
 
virtual string jsonValue (void)
 json stringification utility More...
 
virtual string jsonData ()
 
- 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 >
ddcObjectTraverse (Visit &visit)
 
template<typename Visit >
ddcObjectTraverse (Visit &visit) const
 
template<typename Visit >
ddcObjectTraverseR (Visit &visit)
 
template<typename Visit >
ddcObjectTraverseR (Visit &visit) const
 
virtual ddcObjectList Descendants () const
 

Additional Inherited Members

- 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...
 
CQueryCompilerm_Compiler
 associated query compiler (only set on Compile()) More...
 
CQueryNodem_Node
 underlying CQueryNode (DDC-v1.x API) More...
 
CQueryOptionsm_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: suffix (left-truncated) query *SUFFIX

Constructor & Destructor Documentation

◆ CQTokSuffix()

CQTokSuffix::CQTokSuffix ( const string &  indexName = string(""),
const string &  suffix = string("") 
)
inline

◆ ~CQTokSuffix()

virtual CQTokSuffix::~CQTokSuffix ( )
inlinevirtual

Member Function Documentation

◆ OperatorKey()

virtual const char* CQTokSuffix::OperatorKey ( void  ) const
inlinevirtual

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

Reimplemented from CQToken.

◆ Create()

bool CQTokSuffix::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 CQToken.

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

Here is the call graph for this function:

◆ ValueString()

string CQTokSuffix::ValueString ( void  )
virtual

Stringification utility for use by subclasses; default returns sqString(m_Value)

Reimplemented from CQToken.

References sqString().

Here is the call graph for this function:

◆ jsonClass()

virtual string CQTokSuffix::jsonClass ( void  )
inlinevirtual

class-name for json strinfication

  • default implementation returns C++ class name

Reimplemented from CQToken.


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