NCBI C++ ToolKit
Public Member Functions | Private Attributes | List of all members
CFeatureFilter Class Reference

Search Toolkit Book for CFeatureFilter

class CFeatureFilter More...

#include <gui/widgets/seq_graphic/feature_filter.hpp>

+ Inheritance diagram for CFeatureFilter:
+ Collaboration diagram for CFeatureFilter:

Public Member Functions

 CFeatureFilter ()
 class CFeatureFilter implementation More...
 
virtual ~CFeatureFilter ()
 
void Init (const string &filter)
 
bool Pass (const objects::CMappedFeat *feat)
 
void AddId (const string &id, CQueryParseNode::EType type)
 
const TIdentifierDictGetIdDictionary () const
 
bool NeedFiltering () const
 
virtual bool ResolveIdentifier (const std::string &identifier, bool &value)
 The following functions search in the feature asn for a value with the name 'identifier' and, if found, try to convert it to the specified type, returning true if it is found and converted successfully. More...
 
virtual bool ResolveIdentifier (const std::string &id, Int8 &value)
 Search for integer 'identifier' in feature list and return if found. More...
 
virtual bool ResolveIdentifier (const std::string &, double &)
 
virtual bool ResolveIdentifier (const std::string &id, std::string &value)
 Search for string-value 'identifier' in feature list and return if found. More...
 
virtual bool HasIdentifier (const std::string &id)
 Search for 'identifier' in nodes feature list and true if it exists. More...
 
- Public Member Functions inherited from CQueryExec
 CQueryExec ()
 
virtual ~CQueryExec ()
 
void AddFunc (CQueryParseNode::EType func_type, CQueryFunctionBase *func)
 Register function implementation. More...
 
void AddImplicitSearchFunc (CQueryFunctionBase *func)
 This is a callback for implicit search nodes Our syntax allows queries like (a=1) AND "search_term" Execution recognises "search_term" connected with logical operation represents a special case. More...
 
CQueryFunctionBaseGetImplicitSearchFunc ()
 
CQueryFunctionBaseGetFunc (CQueryParseNode::EType func_type)
 Return query function pointer (if registered). More...
 
virtual void CallFunction (const string &name, CQueryParseTree::TNode &node)
 Extend this function to look up and invoke functions that appear in the query. More...
 
virtual void Evaluate (CQueryParseTree &qtree)
 Run query tree evaluation. More...
 
virtual void Evaluate (CQueryParseTree &qtree, CQueryParseTree::TNode &node)
 
virtual bool ResolveIdentifier (const TFieldID &, bool &)
 
virtual bool ResolveIdentifier (const TFieldID &, Int8 &)
 
virtual bool ResolveIdentifier (const TFieldID &, double &)
 
virtual bool ResolveIdentifier (const TFieldID &, std::string &)
 
virtual TFieldID GetIdentifier (const std::string &)
 
virtual CQueryParseNode::EType IdentifierType (const std::string &)
 Some applications may know the type of an identifier. More...
 
virtual void EvalStart ()
 
virtual bool EvalNext (CQueryParseTree &)
 Move to (iterate) to next entry. More...
 
virtual bool EvalComplete ()
 
int GetQueriedCount () const
 
int GetExceptionCount () const
 
- Public Member Functions inherited from CObject
 CObject (void)
 Constructor. More...
 
 CObject (const CObject &src)
 Copy constructor. More...
 
virtual ~CObject (void)
 Destructor. More...
 
CObjectoperator= (const CObject &src) THROWS_NONE
 Assignment operator. More...
 
bool CanBeDeleted (void) const THROWS_NONE
 Check if object can be deleted. More...
 
bool IsAllocatedInPool (void) const THROWS_NONE
 Check if object is allocated in memory pool (not system heap) More...
 
bool Referenced (void) const THROWS_NONE
 Check if object is referenced. More...
 
bool ReferencedOnlyOnce (void) const THROWS_NONE
 Check if object is referenced only once. More...
 
void AddReference (void) const
 Add reference to object. More...
 
void RemoveReference (void) const
 Remove reference to object. More...
 
void ReleaseReference (void) const
 Remove reference without deleting object. More...
 
virtual void DoNotDeleteThisObject (void)
 Mark this object as not allocated in heap – do not delete this object. More...
 
virtual void DoDeleteThisObject (void)
 Mark this object as allocated in heap – object can be deleted. More...
 
void * operator new (size_t size)
 Define new operator for memory allocation. More...
 
void * operator new[] (size_t size)
 Define new[] operator for 'array' memory allocation. More...
 
void operator delete (void *ptr)
 Define delete operator for memory deallocation. More...
 
void operator delete[] (void *ptr)
 Define delete[] operator for memory deallocation. More...
 
void * operator new (size_t size, void *place)
 Define new operator. More...
 
void operator delete (void *ptr, void *place)
 Define delete operator. More...
 
void * operator new (size_t size, CObjectMemoryPool *place)
 Define new operator using memory pool. More...
 
void operator delete (void *ptr, CObjectMemoryPool *place)
 Define delete operator. More...
 
virtual void DebugDump (CDebugDumpContext ddc, unsigned int depth) const
 Define method for dumping debug information. More...
 
- Public Member Functions inherited from CDebugDumpable
 CDebugDumpable (void)
 
virtual ~CDebugDumpable (void)
 
void DebugDumpText (ostream &out, const string &bundle, unsigned int depth) const
 
void DebugDumpFormat (CDebugDumpFormatter &ddf, const string &bundle, unsigned int depth) const
 
void DumpToConsole (void) const
 

Private Attributes

CQueryParseTree m_Qtree
 
const objects::CMappedFeat * m_EvalFeat
 Evaluated object. More...
 
TIdentifierDict m_IdDict
 Identifier dictionary. More...
 
bool m_NeedFiltering
 

Additional Inherited Members

- Public Types inherited from CQueryExec
typedef unsigned int TFieldID
 
- Public Types inherited from CObject
enum  EAllocFillMode { eAllocFillNone = 1 , eAllocFillZero , eAllocFillPattern }
 Control filling of newly allocated memory. More...
 
typedef CObjectCounterLocker TLockerType
 Default locker type for CRef. More...
 
typedef atomic< Uint8TCounter
 Counter type is CAtomiCounter. More...
 
typedef Uint8 TCount
 Alias for value type of counter. More...
 
- Static Public Member Functions inherited from CObject
static NCBI_XNCBI_EXPORT void ThrowNullPointerException (void)
 Define method to throw null pointer exception. More...
 
static NCBI_XNCBI_EXPORT void ThrowNullPointerException (const type_info &type)
 
static EAllocFillMode GetAllocFillMode (void)
 
static void SetAllocFillMode (EAllocFillMode mode)
 
static void SetAllocFillMode (const string &value)
 Set mode from configuration parameter value. More...
 
- Static Public Member Functions inherited from CDebugDumpable
static void EnableDebugDump (bool on)
 
- Static Public Attributes inherited from CObject
static const TCount eCounterBitsCanBeDeleted = 1 << 0
 Define possible object states. More...
 
static const TCount eCounterBitsInPlainHeap = 1 << 1
 Heap signature was found. More...
 
static const TCount eCounterBitsPlaceMask
 Mask for 'in heap' state flags. More...
 
static const int eCounterStep = 1 << 2
 Skip over the "in heap" bits. More...
 
static const TCount eCounterValid = TCount(1) << (sizeof(TCount) * 8 - 2)
 Minimal value for valid objects (reference counter is zero) Must be a single bit value. More...
 
static const TCount eCounterStateMask
 Valid object, and object in heap. More...
 
- Protected Types inherited from CQueryExec
typedef vector< CQueryFunctionBase * > TFuncReg
 
- Protected Member Functions inherited from CQueryExec
CQueryParseTreeGetQTree ()
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 
- Protected Attributes inherited from CQueryExec
TFuncReg m_FuncReg
 
unique_ptr< CQueryFunctionBasem_ImplicitSearchFunc
 
CQueryParseTreem_QTree
 
int m_ExceptionCount
 
int m_QueriedCount
 

Detailed Description

class CFeatureFilter

Subclass of CQueryExec that adds functions spcific to the feature filtering that allow it to extract data from the feature lists of individual nodes so that those values can be used in queries.

Definition at line 93 of file feature_filter.hpp.

Constructor & Destructor Documentation

◆ CFeatureFilter()

CFeatureFilter::CFeatureFilter ( )

class CFeatureFilter implementation

Definition at line 60 of file feature_filter.cpp.

◆ ~CFeatureFilter()

virtual CFeatureFilter::~CFeatureFilter ( )
inlinevirtual

Definition at line 98 of file feature_filter.hpp.

Member Function Documentation

◆ AddId()

void CFeatureFilter::AddId ( const string id,
CQueryParseNode::EType  type 
)

Definition at line 177 of file feature_filter.cpp.

References m_IdDict, and type.

Referenced by Init().

◆ GetIdDictionary()

const TIdentifierDict * CFeatureFilter::GetIdDictionary ( ) const

Definition at line 183 of file feature_filter.cpp.

References m_IdDict.

◆ HasIdentifier()

bool CFeatureFilter::HasIdentifier ( const std::string id)
virtual

Search for 'identifier' in nodes feature list and true if it exists.

Reimplemented from CQueryExec.

Definition at line 345 of file feature_filter.cpp.

References m_IdDict.

◆ Init()

void CFeatureFilter::Init ( const string filter)

◆ NeedFiltering()

bool CFeatureFilter::NeedFiltering ( ) const

◆ Pass()

bool CFeatureFilter::Pass ( const objects::CMappedFeat *  feat)

◆ ResolveIdentifier() [1/4]

virtual bool CFeatureFilter::ResolveIdentifier ( const std::string ,
double &   
)
inlinevirtual

Reimplemented from CQueryExec.

Definition at line 121 of file feature_filter.hpp.

◆ ResolveIdentifier() [2/4]

bool CFeatureFilter::ResolveIdentifier ( const std::string id,
Int8 value 
)
virtual

Search for integer 'identifier' in feature list and return if found.

Reimplemented from CQueryExec.

Definition at line 227 of file feature_filter.cpp.

References kFrom, kIntronReads, kTo, m_EvalFeat, NCBI_THROW, and value.

◆ ResolveIdentifier() [3/4]

bool CFeatureFilter::ResolveIdentifier ( const std::string id,
std::string value 
)
virtual

Search for string-value 'identifier' in feature list and return if found.

Reimplemented from CQueryExec.

Definition at line 271 of file feature_filter.cpp.

References NStr::EqualNocase(), ITERATE, kClinicalAssertion, kPilot, kSamplesetType, kValidationStatus, kVariantQuality, m_EvalFeat, NCBI_THROW, and value.

◆ ResolveIdentifier() [4/4]

bool CFeatureFilter::ResolveIdentifier ( const std::string identifier,
bool value 
)
virtual

The following functions search in the feature asn for a value with the name 'identifier' and, if found, try to convert it to the specified type, returning true if it is found and converted successfully.

Reimplemented from CQueryExec.

Definition at line 195 of file feature_filter.cpp.

References kConcordant, kDiscordant, m_EvalFeat, NCBI_THROW, and value.

Member Data Documentation

◆ m_EvalFeat

const objects::CMappedFeat* CFeatureFilter::m_EvalFeat
private

Evaluated object.

A mapped feature in this case.

Definition at line 135 of file feature_filter.hpp.

Referenced by Pass(), and ResolveIdentifier().

◆ m_IdDict

TIdentifierDict CFeatureFilter::m_IdDict
private

Identifier dictionary.

Definition at line 138 of file feature_filter.hpp.

Referenced by AddId(), GetIdDictionary(), HasIdentifier(), and Init().

◆ m_NeedFiltering

bool CFeatureFilter::m_NeedFiltering
private

Definition at line 141 of file feature_filter.hpp.

Referenced by Init(), and NeedFiltering().

◆ m_Qtree

CQueryParseTree CFeatureFilter::m_Qtree
private

Definition at line 131 of file feature_filter.hpp.

Referenced by Init(), and Pass().


The documentation for this class was generated from the following files:
Modified on Sun Feb 25 03:07:22 2024 by modify_doxy.py rev. 669887